figma.ui

These are methods and properties available on the figma.ui global object. A UI is created via figma.showUI. See the Creating a User Interface tutorial on how to use this API.

show(): void

Makes the plugin's UI visible. Use this to show the UI if it was created using figma.showUI(..., { visible: false }), or after a call to figma.ui.hide().

hide(): void

Hides the current UI. The UI will still continue to run code and be able to send and receive messages. However, it is not rendered to the user.

resize(width: number, height: number): void

Changes the size of the UI, after it has been created. Note that the size can also be set in the initial options.

close(): void

Destroys the UI and its containing <iframe>. Once this has been called, the code inside the iframe will be stopped and you can no longer send messages to and from it.

postMessage(pluginMessage: any, options?: UIPostMessageOptions): void

Sends a message to the UI's <iframe> window. [Read more]

onmessage: ((pluginMessage: any, props: OnMessageProperties) => void) | undefined

Register a handler for incoming messages from the UI's <iframe> window. [Read more]

on(type: "message", callback: (pluginMessage: any, props: OnMessageProperties) => void): void

Register a handler for incoming messages from the UI's <iframe> window. [Read more]

once(type: "message", callback: (pluginMessage: any, props: OnMessageProperties) => void): void

Register a handler for incoming messages from the UI's <iframe> window. Same as figma.ui.on("message"), but only gets called the first time.

off(type: "message", callback: (pluginMessage: any, props: OnMessageProperties) => void): void

Removes a handler added via figma.ui.on.