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
166. 166
167. 167
168. 168
169. 169
170. 170
171. 171
172. 172
173. 173
174. 174
175. 175
176. 176
177. 177
178. 178
179. 179
180. 180
181. 181
182. 182
183. 183
184. 184
185. 185
186. 186
187. 187
188. 188
189. 189
190. 190
191. 191
192. 192
193. 193
194. 194
195. 195
196. 196
197. 197
198. 198
199. 199
200. 200
201. 201
202. 202
203. 203
204. 204
205. 205
206. 206
207. 207
208. 208
209. 209
210. 210
211. 211
212. 212
213. 213
214. 214
215. 215
216. 216
217. 217
218. 218
219. 219
220. 220
221. 221
222. 222
223. 223
224. 224
225. 225
226. 226
227. 227
228. 228
229. 229
230. 230
231. 231
232. 232
233. 233
234. 234
235. 235
236. 236
237. 237
238. 238
239. 239
240. 240
241. 241
242. 242
243. 243
244. 244
245. 245
246. 246
247. 247
248. 248
249. 249
250. 250
251. 251
252. 252
253. 253
254. 254
255. 255
256. 256
257. 257
258. 258
259. 259
260. 260
261. 261
262. 262
263. 263
264. 264
265. 265
266. 266
267. 267
268. 268
269. 269
270. 270
271. 271
272. 272
273. 273
274. 274
275. 275
276. 276
277. 277
278. 278
279. 279
280. 280
281. 281
282. 282
283. 283
284. 284
285. 285
286. 286
287. 287
288. 288
289. 289
290. 290
291. 291
292. 292
293. 293
294. 294
295. 295
296. 296
297. 297
298. 298
299. 299
300. 300
301. 301
302. 302
303. 303
304. 304
305. 305
306. 306
307. 307
308. 308
309. 309
310. 310
311. 311
312. 312
313. 313
314. 314
315. 315
316. 316
317. 317
318. 318
319. 319
320. 320
321. 321
322. 322
323. 323
324. 324
325. 325
326. 326
327. 327
328. 328
329. 329
330. 330
331. 331
332. 332
333. 333
334. 334
335. 335
336. 336
337. 337
338. 338
339. 339
340. 340
341. 341
342. 342
343. 343
344. 344
345. 345
346. 346
347. 347
348. 348
349. 349
350. 350
351. 351
352. 352
353. 353
354. 354
355. 355
356. 356
357. 357
358. 358
359. 359
360. 360
361. 361
362. 362
363. 363
364. 364
365. 365
366. 366
367. 367
368. 368
369. 369
370. 370
371. 371
372. 372
373. 373
374. 374
375. 375
376. 376
377. 377
378. 378
379. 379
380. 380
381. 381
382. 382
383. 383
384. 384
385. 385
386. 386
387. 387
388. 388
389. 389
390. 390
391. 391
392. 392
393. 393
394. 394
395. 395
396. 396
397. 397
398. 398
399. 399
400. 400
401. 401
402. 402
403. 403
404. 404
405. 405
406. 406
407. 407
408. 408
409. 409
410. 410
411. 411
412. 412
413. 413
414. 414
415. 415
416. 416
417. 417
418. 418
419. 419
420. 420
421. 421
422. 422
423. 423
424. 424
425. 425
426. 426
427. 427
428. 428
429. 429
430. 430
431. 431
432. 432
433. 433
434. 434
435. 435
436. 436
437. 437
438. 438
439. 439
440. 440
441. 441
442. 442
443. 443
444. 444
445. 445
446. 446
447. 447
448. 448
449. 449
450. 450
451. 451
452. 452
453. 453
454. 454
455. 455
456. 456
457. 457
458. 458
459. 459
460. 460
461. 461
462. 462
463. 463
464. 464
465. 465
466. 466
467. 467
468. 468
469. 469
470. 470
471. 471
472. 472
473. 473
474. 474
475. 475
476. 476
477. 477
478. 478
479. 479
480. 480
481. 481
482. 482
483. 483
484. 484
485. 485
486. 486
487. 487
488. 488
489. 489
490. 490
491. 491
492. 492
493. 493
494. 494
495. 495
496. 496
497. 497
498. 498
499. 499
500. 500
501. 501
502. 502
503. 503
504. 504
505. 505
506. 506

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Figspec</title>
    <link rel="stylesheet" href="./style.css" />
    <script type="module" src="./index.ts"></script>
  </head>
  <body>
    <main>
      <hgroup>
        <h1>Figspec</h1>
        <h2>Unofficial Figma design viewer</h2>
      </hgroup>
      <p>
        Figspec is an unofficial Figma design viewer primarily developed for
        embedding usage.
      </p>
      <ul>
        <li>
          <a href="#demo">Live demo</a>
        </li>
        <li>
          <a href="#install">Install</a>
        </li>
        <li>
          <a href="#usage">Usage</a>
        </li>
        <li>
          <a href="#api">API</a>
        </li>
        <li>
          <a href="#examples">Examples</a>
        </li>
        <li>
          <a href="https://github.com/pocka/figspec">Source code (GitHub)</a>
        </li>
      </ul>
      <section id="demo">
        <h2>Live demo</h2>
        <p>
          This is a working demo of
          <code>&lt;figspec-frame-viewer/&gt;</code> displaying a frame of
          sample Figma design.
        </p>
        <figspec-frame-viewer
          id="frame_demo"
          link="https://www.figma.com/file/Klm6pxIZSaJFiOMX5FpTul9F/storybook-addon-designs-sample?type=design&node-id=64%3A1&mode=design&t=qv0I0EDmOnHF0knC-1"
        ></figspec-frame-viewer>
      </section>
      <section id="install">
        <h2>Install</h2>
        <p>Install <code>@figspec/components</code> package from NPM.</p>
        <pre><code>npm i @figspec/components</code></pre>
      </section>
      <section id="usage">
        <h2>Usage</h2>
        <p>
          This package registers two custom elements:
          <code>&lt;figspec-frame-viewer/&gt;</code> and
          <code>&lt;figspec-file-viewer/&gt;</code>. As the names describe, the
          frame viewer displays a specific Figma Frame and the file viewer
          displays an entire Figma file.
        </p>
        <p>
          Once you installed the package, import the package entrypoint from
          your JavaScript file, which registers the two custom elements.
        </p>
        <pre><code><b>import</b> <u>"@figspec/components"</u>;</code></pre>
        <p>Now, you can use the custom elements in your HTML/DOM.</p>
        <pre><code>&lt;<b>body</b>&gt;
  &lt;<b>figspec-frame-viewer</b> nodes=<u>"..."</u> rendered-image=<u>"..."</u>&gt;&lt;/<b>figspec-frame-viewer</b>&gt;
&lt;/<b>body</b>&gt;</code></pre>
      </section>
      <section id="api">
        <h2>API</h2>
        <h3 id="api_common">Common</h3>
        <p>
          These APIs are available both in
          <code>&lt;figspec-frame-viewer /&gt;</code> and in
          <code>&lt;figspec-file-viewer /&gt;</code>.
        </p>
        <h4>Properties</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Data type</th>
              <th>Default</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>link</code>
              </td>
              <td><code>string</code></td>
              <td></td>
              <td>
                An URL for the Figma frame or containing file. A footer will
                appear if this property is not empty.
              </td>
            </tr>
            <tr>
              <td>
                <code>panX</code>
              </td>
              <td><code>number</code></td>
              <td><code>0</code></td>
              <td>
                Current value of viewport translate for X axis, in pixel.
                Scaling applies after the translate.
              </td>
            </tr>
            <tr>
              <td>
                <code>panY</code>
              </td>
              <td><code>number</code></td>
              <td><code>0</code></td>
              <td>
                Current value of viewport translate for Y axis, in pixel.
                Scaling applies after the translate.
              </td>
            </tr>
            <tr>
              <td>
                <code>scale</code>
              </td>
              <td><code>number</code></td>
              <td><code>1.0</code></td>
              <td>
                Current value of viewport scaling (zoom), where 1.0 = 100%;
              </td>
            </tr>
            <tr>
              <td>
                <code>zoomSpeed</code>
              </td>
              <td><code>number</code></td>
              <td><code>500</code></td>
              <td>
                How fast viewport zooms when user performs <kbd>Ctrl</kbd> +
                wheel scroll or pinch in-out gesture. You can specify between 1
                to 1,000.
              </td>
            </tr>
            <tr>
              <td>
                <code>panSpeed</code>
              </td>
              <td><code>number</code></td>
              <td><code>500</code></td>
              <td>
                How fast viewport translates when user performs wheel scroll.
                This does not affect to the speed of drag with middle button
                (wheel button) pressed. You can specify between 1 to 1,000.
              </td>
            </tr>
            <tr>
              <td>
                <code>selectedNode</code>
              </td>
              <td>
                <code
                  ><a
                    href="https://github.com/pocka/figspec/blob/master/src/FigspecViewer/utils.ts#L4"
                    >SizedNode</a
                  >
                  | null</code
                >
              </td>
              <td><code>null</code></td>
              <td>Selected node object.</td>
            </tr>
            <tr>
              <td>
                <code>zoomMargin</code>
              </td>
              <td><code>number</code></td>
              <td><code>50</code></td>
              <td>
                The minimum margin for the preview canvas in px. Preview element
                uses this value for default zoom value (scale).
              </td>
            </tr>
          </tbody>
        </table>
        <h4>Attributes</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>link</code>
              </td>
              <td>
                A corresponding attribute for the <code>link</code> property.
              </td>
            </tr>
            <tr>
              <td>
                <code>zoom-speed</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>zoomSpeed</code> property.
              </td>
            </tr>
            <tr>
              <td>
                <code>pan-speed</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>panSpeed</code> property.
              </td>
            </tr>
            <tr>
              <td>
                <code>zoom-margin</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>zoomMargin</code> property.
              </td>
            </tr>
          </tbody>
        </table>
        <h4>Events</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>scalechange</code>
              </td>
              <td>
                Fired when a user performs zoom-in or zoom-out on the preview.
              </td>
            </tr>
            <tr>
              <td>
                <code>positionchange</code>
              </td>
              <td>Fired when a user performs pan on the preview.</td>
            </tr>
            <tr>
              <td>
                <code>nodeselect</code>
              </td>
              <td>Fired when a user selects or unselects a node.</td>
            </tr>
          </tbody>
        </table>
        <h3 id="api_figspec_frame_viewer">&lt;figspec-frame-viewer /&gt;</h3>
        <h4>Properties</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Data type</th>
              <th>Default</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>nodes</code>
              </td>
              <td>
                <code
                  ><a
                    href="https://jemgold.github.io/figma-js/interfaces/filenodesresponse.html"
                    >FileNodesResponse</a
                  >
                  | null</code
                >
              </td>
              <td><code>null</code></td>
              <td>
                Required. A response of the
                <a
                  href="https://www.figma.com/developers/api#get-file-nodes-endpoint"
                >
                  "GET file nodes"
                </a>
                API.
              </td>
            </tr>
            <tr>
              <td>
                <code>renderedImage</code>
              </td>
              <td><code>string | null</code></td>
              <td><code>null</code></td>
              <td>
                Required. An URL for the frame image rendered by
                <a
                  href="https://www.figma.com/developers/api#get-images-endpoint"
                  >"GET image"</a
                >
                API.
              </td>
            </tr>
            <tr>
              <td>
                <code>documentNode</code>
              </td>
              <td>
                <code
                  ><a
                    href="https://github.com/pocka/figspec/blob/master/src/FigspecViewer/utils.ts#L4"
                    >SizedNode</a
                  >
                  | null</code
                >
              </td>
              <td><code>null</code></td>
              <td>Readonly. A root drawable node.</td>
            </tr>
          </tbody>
        </table>
        <h4>Attributes</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>nodes</code>
              </td>
              <td>
                A corresponding attribute for the <code>nodes</code> property.
                Parsed as a JSON string.
              </td>
            </tr>
            <tr>
              <td>
                <code>rendered-image</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>renderedImage</code> property.
              </td>
            </tr>
          </tbody>
        </table>
        <h3 id="api_figspec_file_viewer">&lt;figspec-file-viewer /&gt;</h3>
        <h4>Properties</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Data type</th>
              <th>Default</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>documentNode</code>
              </td>
              <td>
                <code
                  ><a
                    href="https://jemgold.github.io/figma-js/interfaces/fileresponse.html"
                    >FileResponse</a
                  >
                  | null</code
                >
              </td>
              <td><code>null</code></td>
              <td>
                Required. A response of the
                <a
                  href="https://www.figma.com/developers/api#get-files-endpoint"
                >
                  "GET file"
                </a>
                API.
              </td>
            </tr>
            <tr>
              <td>
                <code>renderedImages</code>
              </td>
              <td>
                <code>{ [nodeId: string]: string } | null</code>
              </td>
              <td>
                <code>null</code>
              </td>
              <td>
                Required. A record of rendered images, where key is an ID of the
                node and value is an URI of the image.
                <code>images</code> property in the response of
                <a
                  href="https://www.figma.com/developers/api#get-images-endpoint"
                  >"GET image"</a
                >
                API.
              </td>
            </tr>
            <tr>
              <td>
                <code>selectedPage</code>
              </td>
              <td>
                <code
                  ><a
                    href="https://jemgold.github.io/figma-js/interfaces/canvas.html"
                    >Canvas</a
                  >
                  | null</code
                >
              </td>
              <td>
                <code>null</code>
              </td>
              <td>Currently selected page object.</td>
            </tr>
          </tbody>
        </table>
        <h4>Attributes</h4>
        <table>
          <thead>
            <tr>
              <th>Name</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
                <code>document-node</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>documentNode</code> property. Parsed as a JSON string.
              </td>
            </tr>
            <tr>
              <td>
                <code>rendered-images</code>
              </td>
              <td>
                A corresponding attribute for the
                <code>renderedImages</code> property. Parsed as a JSON string.
              </td>
            </tr>
          </tbody>
        </table>
      </section>
      <section id="examples">
        <h2>Examples</h2>
        <div>
          <ul>
            <li>
              <a href="./examples/file.html" target="example_frame">
                File viewer
              </a>
            </li>
            <li>
              <a href="./examples/custom-speed.html" target="example_frame">
                Custom pan&amp;zoom speed
              </a>
            </li>
            <li>
              <a
                href="./examples/parameter-missing-error.html"
                target="example_frame"
              >
                Parameter missing error
              </a>
            </li>
            <li>
              <a href="./examples/events.html" target="example_frame">
                Events (see browser console)
              </a>
            </li>
          </ul>
          <iframe name="example_frame" src="./examples/file.html"></iframe>
        </div>
      </section>
    </main>
  </body>
</html>