@figspec/components
Advanced tools
Readme
-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/components
This 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.FAQs
Unofficial Figma spec viewer: Live Embed Kit - Live + Guidelines + Inspector
The npm package @figspec/components receives a total of 522,838 weekly downloads. As such, @figspec/components popularity was classified as popular.
We found that @figspec/components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.