figma-graphql
The reimagined Figma API (super)powered by GraphQL
Quick start
-
Open figma-graphql sandbox and fork it
-
Add your Figma API Token as
FIGMA_TOKEN
in the codesandbox secret keys -
Try your first query!
{
file(id: "cLp23bR627jcuNSoBGkhL04E") {
name
}
}
Documentation
Please read the full documentation for additional examples and best practices.
Developing
- Clone this repo
- Run
yarn install
to install all dependencies - Run
FIGMA_TOKEN={YOUR_PERSONAL_FIGMA_TOKEN} yarn run dev
or add it to an.env
file - The Figma GraphQL playground should be available at
http://localhost:3001/
Figma file
This isn't really necessary but here's the base Figma file that is being used during development.
It should work with any file so can use your own Figma files and just replace file(id: "cLp23bR627jcuNSoBGkhL04E")
with the id of the file you want to query.
Contributors
Thanks goes to these wonderful people (emoji key):
Bernardo Raposo |
Sara Vieira š» |
Andrey Okonetchnikov |
Travis Arnold š |
This project follows the all-contributors specification. Contributions of any kind welcome!