-e67700){kind=icon}
@figspec/components is a set of CustomElements that renders Figma file/frame and displays Figma's editor-like inspector for a selected node.
The components are designed to work on Figma REST API result. This library does not provided a functionality to invoke Figma REST API endpoints.
$ npm i @figspec/componentsThis library does not provide bundled script. Please use CDN or bundle on your own.
Import the entry script (import '@figspec/components') and it'll register our custom elements.
Then you can now use these on your page.
<body>
<figspec-frame-viewer id="figma_frame"></figspec-frame-viewer>
</body>// your script.js
import "@figspec/components";
const figmaFrame = document.getElementById("figma_frame")
figmaFrame.apiResponse = /* ... */;
figmaFrame.renderedImage = /* ... */;To display an entire Figma File, use <figspec-file-viewer> instead.
<body>
<figspec-file-viewer id="figma_file"></figspec-file-viewer>
</body>// your script.js
import "@figspec/components";
const figmaFile = document.getElementById("figma_file")
figmaFrame.apiResponse = /* ... */;
figmaFrame.renderedImages = /* ... */;To see working examples and API docs, please check out the docs site.
This library works on browser implementing WebComponents v1 spec and ES2019.
The bundled files are at esm/es2019.
-
@figspec/react... React bindings for this package.