The Plugin API allows you to access the contents of both FigJam and Figma design files. In the Plugin API, Figma design files and FigJam files are treated as separate editorTypes.
While a number of functions, nodes, and properties are shared between the two editor types, the kind of actions you’d perform — and the plugins required — are quite different. Our Compare Figma and FigJam article explores the context and use cases for each file type.
Every plugin must have at least one editorType set in the manifest. You can create plugins for both editors or a specific editor type. You can even build conditional plugins that perform different actions in each editor. Setting plugin editor type →
Some functions are only supported on specific editorTypes. These nodes and functions won’t be available via the Plugin API as soon as the plugin is run in that editorType.
We recommend familiarizing yourself with these functions. Even if you intend on building a conditional plugin that supports actions in both Figma and FigJam files.
FigJam only plugins
This feature is still in beta. For more information on the beta take a look at this article.
If you set the editorType to FigJam files only, you won’t be able to access the following functions or methods:
FigJam files don’t support the ability to create multiple pages. You can still access the currentPage in a FigJam file, but you won’t be able to create additional pages. This includes the createPage() function.
FigJam files have their own purpose-built stickers, which you can access in FigJam files along with any components from your enabled libraries. You can also paste entire designs from Figma design files into FigJam files. You’ll be able to access any local styles or instances in that file.
It’s not possible to create new components in FigJam file, or combine existing components as variants. You won’t be able to use the following functions:
When accessing FigJam files via the Plugin API, you can only access styles applied to existing nodes. You won’t be able to create or manage local styles using the following functions:
Figma only plugins
FigJam specific nodes
FigJam files have three specific types of node which are unique to that file type. This is the StickyNode, ShapeWithText, and Connector node type.
It’s not possible to create these nodes in a Figma file, but you can read and modify any existing nodes of these types, even in Figma files.
If you set the editorType to Figma files only, you won’t be able to access the following functions relating to those nodes:
FigJam files support a Timer, which allows file participants to set a time limit for their activities and watch it count down. The timer is visible to everyone with at least view access to the FigJam file.
The timer is specific to FigJam files. You won’t be able to access the figma.timer function when the editorType is set to Figma only. This includes any events and properties related to that function.
Some nodes and functions are only supported in one editorType. In the table below, you can explore each node type and what actions are supported in each editorType.
- Create: You can use the Plugin API to create new nodes of this type.
- Modify: You can get information about existing nodes of this type and can modify any of the existing properties and values.
- Read only: You can get information about any existing nodes of this type, but you can’t make any changes to the node.
- Not supported: You can’t access this node via the Plugin API.
|ComponentNode||Create, Modify||Create (instances)|
|ComponentSetNode||Create, Modify||Read only|
|EllipseNode||Create, Modify||Create, Modify|
|FrameNode||Create, Modify||Create, Modify|
|GroupNode||Create, Modify||Create, Modify|
|LineNode||Create, Modify||Create, Modify|
|PageNode||Create, Modify||Read only|
|PolygonNode||Create, Modify||Create, Modify|
|RectangleNode||Create, Modify||Create, Modify|
|SliceNode||Create, Modify||Create, Modify|
|StarNode||Create, Modify||Create, Modify|
|TextNode||Create, Modify||Create, Modify|
|VectorNode||Create, Modify||Create, Modify|
|🆕 ConnectorNode||Modify||Create, Modify|
|🆕 ShapeWithTextNode||Modify||Create, Modify|
|🆕 StickyNode||Modify||Create, Modify|