#Short menu api configuration full

We want plugins to be as accessible and cross-platform as Figma itself. While Figma has desktop applications, not everyone accesses Figma via the desktop. The Plugins API doesn't support desktop-specific APIs. This includes making network requests, opening files, and using functionality like, WebGL, WebAssembly, and audio APIs, etc. Part of the plugin API runs in an meaning you can also access browser APIs. Like Figma, plugins are powered by web technologies.

While some node types can only be created in a specific file or editor type, you will generally be able to read and modify most nodes, regardless of the editor type.įigma is predominantly browser-based software, which means it can be run on all full desktop operating systems (MacOS, Windows, Linux, etc), as well as Chrome OS. You can create plugins for a specific editor type, both editors, or build plugins that perform different actions in each editor.

Some of these are global properties, that exist on every node, whereas other properties will be specific to the type of node. Nodes have a number of properties associated with them. There are specific nodes or classes for different types of layers in Figma - like frames, components, vectors, and rectangles. Each subtree that stems from the document node represents a layer or object on the canvas. The document node can then have any number of child nodes. Instead, the children of the document node will be the layers and objects on that board. There can only be one document node per browser tab and each of its children must be PageNodes.Īs FigJam files don't support pages, there won't be any PageNodes to explore. In a Figma design file, every DocumentNode will have PageNode that represent each page in that Figma file. The document node is how you access and explore the contents of a file. You can get read access to these aspects of a file via Figma's REST API.Įvery file in Figma consists of a tree of nodes and at the root of every Figma or FigJam file is a Document node. The includes the version history of that file. Other file metadata like the file's team or location, permissions, users, or any comments associated with that file.This doesn't apply to fonts you want to use in your plugin's UI. You'll be required to load any fonts you want to use in your plugin. This includes Figma's default fonts, shared organization fonts, or fonts stored locally on your computer. Plugins can only access fonts that are accessible in the editor. External fonts or web fonts accessed via a URL.

The Plugin API can only access styles, components, and instances that are local to that file.

Styles and components from any team or organization libraries.

The plugin API doesn't allow you to access anything in that file that's outside the canvas. Plugins can view and modify aspects of these layers or nodes, like the color, position, hierarchy, text, etc. That's anything that exists in the layers panel and any properties associated with that layer in the properties panel. Plugins expose, first and foremost, the contents of a file. In both Figma and FigJam, you can access most of the plugin API through the figma global object. The Plugin API supports both read and write functions, allowing developers to view, create, and modify the contents of Figma design and FigJam files. Get started with the plugin API → Plugin API access Our setup guide takes you through the process of setting up your environment and running a sample plugin. To ask questions, give feedback, or connect with other plugin developers: Join the Figma Plugins Slack → The API reference and this accompanying documentation has the information you need to build plugins for Figma and FigJam. You can build plugins that run immediately, or build plugins that require user’s to input information via a user interface (UI). They can also leverage external Web APIs. Plugins interact with the Figma application via a dedicated Plugin API. You’ll write plugins in JavaScript and build any UI using HTML. You’ll need an understanding of these technologies to develop plugins. Like Figma and FigJam, plugins are powered by web technologies. They allow users to customize their experience or create more efficient workflows. Plugins run in Figma or FigJam files and perform one or more user actions. Plugins are programs or applications created by the community that extend the functionality of Figma and FigJam.

#Short menu api configuration full