@figspec/components
Advanced tools
Unofficial Figma spec viewer: Live Embed Kit - Live + Guidelines + Inspector
CustomElements renders given Figma API's result into a rich preview.
$ yarn add @figspec/components
# or
$ npm i @figspec/components
Import the entry script (import '@figspec/components') and it'll register our custom elements.
Then you can now use these on your page.
// your script.js
import "@figspec/components";
// ...
<body>
<figspec-frame-viewer nodes="..." rendered-image="..."></figspec-frame-viewer>
</body>
To display an entire Figma File, use <figspec-file-viewer> instead.
<body>
<figspec-file-viewer
document-node="..."
rendered-images="..."
></figspec-file-viewer>
</body>
To see examples and API docs, please check out Storybook.
NOTE: We don't provide bundled scripts yet. If you want to put the script in head tag, please build the files at your own.
This package ships with TypeScript definition file.
One of our "typing dependencies" is missing from package.json#dependencies, because it's not our "runtime dependency".
So, you need to install that package in order to get full types (otherwise some properties turns into any).
# By installing this package, FileNode related properties will get correct types.
yarn add -D figma-js
Browsers supporting WebComponents v1 spec and ES2015 or later.
The bundled codes are emitted under esm/es2015 and cjs/es2016.
FAQs
Unofficial Figma spec viewer: Live Embed Kit - Live + Guidelines + Inspector
The npm package @figspec/components receives a total of 572,329 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
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.