setBackgroundMessage

setBackgroundMessage

Update the background status text shown while the plugin UI is hidden.

await framer.hideUI()
await framer.setBackgroundMessage("Syncing data...")

// Clear the status message
await framer.setBackgroundMessage(null)

This allows plugins running in the background to communicate their current status to users. Set to null to clear the message.

Parameters

  • status: string | null – The message to display, or null to clear.

Returns

  • Promise<void>