figspec

Unofficial static Figma frame/file viewer available as HTML CustomElement

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
  97. 97
  98. 98
  99. 99
  100. 100
  101. 101
  102. 102
  103. 103
  104. 104
  105. 105
  106. 106
  107. 107
  108. 108
import * as figma from "../figma.js";

// Intermediate value, context object.
interface MinMaxXY {
  minX: number;
  maxX: number;
  minY: number;
  maxY: number;
}

/**
 * Calculate the size and position of where to put an API rendered image.
 * Ealier API did not return `absoluteRenderBounds`, so in order to place an API rendered image
 * to correct position, client need to measure the effect radius of LAYER_BLUR and DROP_SHADOW.
 */
export function getRenderBoundingBox(
  node: figma.Node & figma.HasBoundingBox,
): figma.Rectangle {
  if (node.absoluteRenderBounds) {
    return node.absoluteRenderBounds;
  }

  let current: MinMaxXY | null = null;

  for (const target of figma.walk(node)) {
    if (target.visible === false || !figma.hasBoundingBox(target)) {
      continue;
    }

    const minmax = calculateRenderingBoundingBox(target);

    if (!current) {
      current = minmax;
      continue;
    }

    current.minX = Math.min(current.minX, minmax.minX);
    current.minY = Math.min(current.minY, minmax.minY);
    current.maxX = Math.max(current.maxX, minmax.maxX);
    current.maxY = Math.max(current.maxY, minmax.maxY);
  }

  return current
    ? {
        x: current.minX,
        y: current.minY,
        width: current.maxX - current.minX,
        height: current.maxY - current.minY,
      }
    : node.absoluteBoundingBox;
}

function calculateRenderingBoundingBox(
  node: figma.Node & figma.HasBoundingBox,
): MinMaxXY {
  if (!figma.hasEffects(node)) {
    return {
      minX: node.absoluteBoundingBox.x,
      maxX: node.absoluteBoundingBox.x + node.absoluteBoundingBox.width,
      minY: node.absoluteBoundingBox.y,
      maxY: node.absoluteBoundingBox.y + node.absoluteBoundingBox.height,
    };
  }

  // If the frame has effects, the size of rendered image is larger than frame's size
  // because of rendered effects.
  const margins = { top: 0, right: 0, bottom: 0, left: 0 };

  for (const effect of node.effects) {
    if (effect.visible === false) {
      continue;
    }

    if (figma.isShadowEffect(effect) && effect.type === "DROP_SHADOW") {
      margins.left = Math.max(margins.left, effect.radius - effect.offset.x);
      margins.top = Math.max(margins.top, effect.radius - effect.offset.y);
      margins.right = Math.max(margins.right, effect.radius + effect.offset.x);
      margins.bottom = Math.max(
        margins.bottom,
        effect.radius + effect.offset.y,
      );
      continue;
    }

    if (effect.type === "LAYER_BLUR") {
      margins.top = Math.max(margins.top, effect.radius);
      margins.right = Math.max(margins.right, effect.radius);
      margins.bottom = Math.max(margins.bottom, effect.radius);
      margins.left = Math.max(margins.left, effect.radius);
      continue;
    }

    // Other effects does not changes a size of rendered image
  }

  return {
    minX: node.absoluteBoundingBox.x - margins.left,
    maxX:
      node.absoluteBoundingBox.x +
      node.absoluteBoundingBox.width +
      margins.right,
    minY: node.absoluteBoundingBox.y - margins.top,
    maxY:
      node.absoluteBoundingBox.y +
      node.absoluteBoundingBox.height +
      margins.bottom,
  };
}