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
export interface Preferences {
  /**
   * For future changes.
   */
  version: 1;

  /**
   * How many decimal places are shown?
   * NOTE: Some properties uses fixed decimal places.
   */
  decimalPlaces: number;

  viewportZoomSpeed: number;
  viewportPanSpeed: number;

  /**
   * What unit should be used in generated CSS code?
   */
  lengthUnit: "px" | "rem";
  rootFontSizeInPx: number;

  /**
   * How to display a color in generated CSS code?
   */
  cssColorNotation: // #rrggbb / #rrggbbaa
  | "hex"
    // rgb(r g b / a)
    | "rgb"
    // hsl(h s l / a)
    | "hsl"
    // color(srgb r g b / a)
    | "color-srgb"
    // color(display-p3 r g b / a)
    // For showing colors in Display P3 color space, where the Figma file uses Display P3.
    // If a Figma file uses sRGB, colors are stretched to full Display P3 space.
    | "display-p3"
    // color(display-p3 r g b / a)
    // For showing colors in Display P3 color space, where the Figma file uses sRGB.
    // If a Figma file uses Display P3, colors are unnaturally compressed to sRGB space (same as other sRGB notations).
    | "srgb-to-display-p3";

  enableColorPreview: boolean;
}

export const defaultPreferenecs = Object.freeze<Preferences>({
  version: 1,
  decimalPlaces: 2,
  viewportPanSpeed: 500,
  viewportZoomSpeed: 500,
  cssColorNotation: "hex",
  lengthUnit: "px",
  rootFontSizeInPx: 16,
  enableColorPreview: true,
});

export function isEqual(
  a: Readonly<Preferences>,
  b: Readonly<Preferences>,
): boolean {
  if (a.version !== b.version) {
    return false;
  }

  for (const [key, value] of Object.entries(a)) {
    if (b[key as keyof typeof a] !== value) {
      return false;
    }
  }

  return true;
}