setBackgroundMessage

setBackgroundMessage

setBackgroundMessage

Set a message to display while the plugin is hidden

Update the background status text shown while the plugin UI is hidden. This allows plugins running in the background to communicate their current status to users.

// Show a status message while the plugin runs in the background
await framer.hideUI()
await framer.setBackgroundMessage("Syncing data...")

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

Parameters:

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