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
  109. 109
  110. 110
  111. 111
  112. 112
  113. 113
  114. 114
  115. 115
  116. 116
  117. 117
  118. 118
  119. 119
  120. 120
  121. 121
  122. 122
  123. 123
  124. 124
  125. 125
  126. 126
  127. 127
  128. 128
  129. 129
  130. 130
  131. 131
  132. 132
  133. 133
  134. 134
  135. 135
  136. 136
  137. 137
  138. 138
  139. 139
  140. 140
  141. 141
  142. 142
  143. 143
  144. 144
  145. 145
  146. 146
  147. 147
  148. 148
  149. 149
  150. 150
  151. 151
  152. 152
  153. 153
  154. 154
  155. 155
  156. 156
  157. 157
  158. 158
import * as Figma from "figma-js";
import { css, html, svg } from "lit-element";
import { styleMap, StyleInfo } from "lit-html/directives/style-map";

import { round } from "./utils";

export interface OutlineProps {
  node: Extract<Figma.Node, { absoluteBoundingBox: any }>;

  computedThickness: number;
  selected?: boolean;

  onClick?(ev: MouseEvent): void;
}

export const Outline = ({
  node,
  selected = false,
  computedThickness,
  onClick,
}: OutlineProps) => {
  const { x, y, width, height } = node.absoluteBoundingBox;

  const radius: {
    topLeft: number;
    topRight: number;
    bottomRight: number;
    bottomLeft: number;
  } =
    "cornerRadius" in node && node.cornerRadius
      ? {
          topLeft: node.cornerRadius,
          topRight: node.cornerRadius,
          bottomRight: node.cornerRadius,
          bottomLeft: node.cornerRadius,
        }
      : "rectangleCornerRadii" in node && node.rectangleCornerRadii
      ? {
          topLeft: node.rectangleCornerRadii[0],
          topRight: node.rectangleCornerRadii[1],
          bottomRight: node.rectangleCornerRadii[2],
          bottomLeft: node.rectangleCornerRadii[3],
        }
      : {
          topLeft: 0,
          topRight: 0,
          bottomRight: 0,
          bottomLeft: 0,
        };

  // Since SVG can't control where to draw borders (I mean you can't draw inset borders), we need to
  // shift each drawing points by the half of the border width.
  const shift = computedThickness / 2;

  // https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d
  // [M] ... Move to
  // [L] ... Line to
  // [A] ... Arc to
  // [Z] ... Close path
  const moveTo = (x: number, y: number) => `M${x},${y}`;
  const lineTo = (x: number, y: number) => `L${x},${y}`;
  const arcTo = (r: number, x: number, y: number) =>
    `A${r},${r} 0 0 1 ${x},${y}`;

  const boxPath = [
    moveTo(radius.topLeft + shift, shift),
    lineTo(width - radius.topRight, shift),
    arcTo(radius.topRight - shift, width - shift, radius.topRight),
    lineTo(width - shift, height - radius.bottomRight),
    arcTo(
      radius.bottomRight - shift,
      width - radius.bottomRight,
      height - shift
    ),
    lineTo(radius.bottomLeft, height - shift),
    arcTo(radius.bottomLeft - shift, shift, height - radius.bottomLeft),
    lineTo(shift, radius.topLeft),
    arcTo(radius.topLeft - shift, radius.topLeft, shift),
    "Z",
  ].join(" ");

  return svg`
    <path
      class="guide"
      d=${boxPath}
      shape-rendering="geometricPrecision"
      fill="none"
      transform="translate(${x}, ${y})"
      ?data-selected=${selected}
      @click=${onClick}
    />
  `;
};

export interface TooltipProps {
  nodeSize: Figma.Rect;

  offsetX: number;
  offsetY: number;

  reverseScale: number;
}

export const Tooltip = ({
  nodeSize: { x, y, width, height },
  offsetX,
  offsetY,
  reverseScale,
}: TooltipProps) => {
  const tooltipStyle: StyleInfo = {
    top: `${offsetY + y + height}px`,
    left: `${offsetX + x + width / 2}px`,
    transform: `translateX(-50%) scale(${reverseScale}) translateY(0.25em)`,
  };

  return html`
    <div class="tooltip" style="${styleMap(tooltipStyle)}">
      ${round(width)} x ${round(height)}
    </div>
  `;
};

export const styles = css`
  .guide {
    /*
     * SVGs cannot be pixel perfect, especially floating values.
     * Since many platform renders them visually incorrectly (probably they
     * are following the spec), it's safe to set overflow to visible.
     * Cropped borders are hard to visible and ugly.
     */
    overflow: visible;

    pointer-events: all;

    opacity: 0;
  }
  .guide:hover {
    opacity: 1;
  }
  .guide[data-selected] {
    opacity: 1;
    stroke: var(--guide-selected-color);
  }

  .tooltip {
    position: absolute;
    padding: 0.25em 0.5em;
    font-size: var(--guide-tooltip-font-size);

    color: var(--guide-selected-tooltip-fg);
    background-color: var(--guide-selected-tooltip-bg);
    border-radius: 2px;
    pointer-events: none;
    z-index: calc(var(--z-index) + 1);

    transform-origin: top center;
  }
`;