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
  159. 159
  160. 160
  161. 161
  162. 162
  163. 163
  164. 164
  165. 165
import { el } from "../dom.js";
import type * as figma from "../figma.js";
import { type Preferences } from "../preferences.js";
import { compute, Signal } from "../signal.js";
import {
  canvas,
  info,
  preferences,
  isIdle,
  isSetupError,
  isInfo,
  isPreferences,
  type LoadedState,
  type State,
} from "../state.js";

import { empty } from "./empty/empty.js";
import { fullscreenPanel } from "./fullscreenPanel/fullscreenPanel.js";
import { inspectorPanel } from "./inspectorPanel/inspectorPanel.js";
import { menuBar } from "./menuBar/menuBar.js";
import { preferencesPanel } from "./preferencesPanel/preferencesPanel.js";
import { snackbar, type SnackbarContent } from "./snackbar/snackbar.js";

const SNACKBAR_LIFETIME = 3000;

type ElementChild = NonNullable<Parameters<typeof el>[2]>[number];

interface UIProps<T> {
  state: Signal<State<T>>;
  preferences: Signal<Readonly<Preferences>>;

  infoContents: (data: T) => ElementChild;
  frameCanvas: (
    data: T,
    selected: Signal<figma.Node | null>,
    loadedState: Signal<LoadedState>,
  ) => ElementChild;
  menuSlot?: (data: T) => ElementChild;

  caller: "frame" | "file";
}

export function ui<T>({
  state: $state,
  preferences: $preferences,
  infoContents: createinfoContents,
  frameCanvas: createFrameCanvas,
  menuSlot: createMenuSlot,
  caller,
}: UIProps<T>): Signal<HTMLElement> {
  const $snackbar = new Signal<SnackbarContent>(null);

  return compute(() => {
    const s = $state.get();

    if (isIdle(s)) {
      if (caller === "file") {
        return empty({
          title: ["No Figma file"],
          body: [
            el(
              "p",
              [],
              [
                "Both Figma file data and rendered images are missing. ",
                "Please provide those in order to start Figspec File Viewer. ",
              ],
            ),
          ],
        });
      }

      return empty({
        title: ["No Figma frame"],
        body: [
          el(
            "p",
            [],
            [
              "Both frame data and rendered image are missing. ",
              "Please provide those in order to start Figspec Frame Viewer. ",
            ],
          ),
        ],
      });
    }

    if (isSetupError(s)) {
      return empty({
        title: ["Failed to render Figma ", caller],
        body: [
          el(
            "p",
            [],
            ["Couldn't render the Figma ", caller, " due to an error."],
          ),
          el("pre", [], [s.error.message, "\n\n", s.error.stack]),
        ],
      });
    }

    const $loadedState = new Signal<LoadedState>(canvas);
    const $selected = new Signal<figma.Node | null>(null);

    const frameCanvas = createFrameCanvas(s.data, $selected, $loadedState);

    const perState = compute(() => {
      const loadedState = $loadedState.get();

      if (isInfo(loadedState)) {
        return fullscreenPanel({
          body: [createinfoContents(s.data)],
          onClose() {
            $loadedState.set(canvas);
          },
        });
      }

      if (isPreferences(loadedState)) {
        return fullscreenPanel({
          body: [preferencesPanel({ preferences: $preferences })],
          onClose() {
            $loadedState.set(canvas);
          },
        });
      }

      return el(
        "div",
        [],
        [
          menuBar({
            slot: [createMenuSlot?.(s.data)],
            onOpenInfo() {
              $loadedState.set(info);
            },
            onOpenPreferences() {
              $loadedState.set(preferences);
            },
          }),
          inspectorPanel({
            selected: $selected,
            preferences: $preferences,
            snackbar: $snackbar,
            onOpenPreferencesPanel() {
              $loadedState.set(preferences);
            },
          }),
        ],
      );
    });

    const layer = el(
      "div",
      [],
      [
        frameCanvas,
        perState,
        snackbar({ signal: $snackbar, lifetimeMs: SNACKBAR_LIFETIME }),
      ],
    );

    return layer;
  });
}