Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanqing/create-figma-plugin
:battery: The comprehensive toolkit for developing plugins and widgets for Figma and FigJam
https://github.com/yuanqing/create-figma-plugin
create-figma-plugin figjam figjam-plugin figjam-plugins figjam-widget figjam-widgets figma figma-plugin figma-plugins
Last synced: 4 days ago
JSON representation
:battery: The comprehensive toolkit for developing plugins and widgets for Figma and FigJam
- Host: GitHub
- URL: https://github.com/yuanqing/create-figma-plugin
- Owner: yuanqing
- License: mit
- Created: 2019-07-20T02:08:07.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T04:23:41.000Z (about 2 months ago)
- Last Synced: 2025-01-15T22:17:54.608Z (11 days ago)
- Topics: create-figma-plugin, figjam, figjam-plugin, figjam-plugins, figjam-widget, figjam-widgets, figma, figma-plugin, figma-plugins
- Language: TypeScript
- Homepage: https://yuanqing.github.io/create-figma-plugin/
- Size: 22.5 MB
- Stars: 962
- Watchers: 7
- Forks: 91
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-list - create-figma-plugin
- awesome-figma - create-figma-plugin - A comprehensive toolkit for developing Figma plugins. (Plugins development)
README
*This page is for contributors. If you’re looking to use Create Figma Plugin, [go to the documentation website](https://yuanqing.github.io/create-figma-plugin/).*
---
# [Create Figma Plugin](https://yuanqing.github.io/create-figma-plugin/) [](https://npmjs.com/package/create-figma-plugin) [](https://github.com/yuanqing/create-figma-plugin/actions?query=workflow%3Abuild)
> The comprehensive toolkit for developing plugins and widgets for Figma and FigJam
- [Introduction](https://yuanqing.github.io/create-figma-plugin/)
- [Quick start](https://yuanqing.github.io/create-figma-plugin/quick-start/)
- [Configuration](https://yuanqing.github.io/create-figma-plugin/configuration/)
- [UI](https://yuanqing.github.io/create-figma-plugin/ui/)
- [Utilities](https://yuanqing.github.io/create-figma-plugin/utilities/)
- [Recipes](https://yuanqing.github.io/create-figma-plugin/recipes/)
- [Reference plugins/widgets](https://yuanqing.github.io/create-figma-plugin/reference-plugins-and-widgets/)
- [Storybook](https://yuanqing.github.io/create-figma-plugin/storybook/)
- [Changelog](/CHANGELOG.md#readme)
## Contributing
### Pre-requisites
- [Node.js](https://nodejs.org) – v20
- [npm](https://docs.npmjs.com/cli/) – v10
### Building the project locally
```
$ git clone https://github.com/yuanqing/create-figma-plugin
$ cd create-figma-plugin
$ git checkout --track origin/next
$ npm install
```
Active development on the next release occurs on the [`next`](https://github.com/yuanqing/create-figma-plugin/tree/next) branch. Pull requests should be made into `next`.
### Testing changes on an existing plugin/widget
First, build the entire Create Figma Plugin project:
```
$ npm run build
```
Then, create symlinks to the local copy of the project in your existing plugin/widget (eg. `my-project`):
```
$ ls -a
create-figma-plugin my-project
$ sh create-figma-plugin/scripts/symlink.sh create-figma-plugin my-project
```
Finally, build your plugin/widget:
```
$ cd my-project
$ npm run build
```