Plugin

The named exports of a plugin's entry module the client reads: its lifecycle and its settings panel.

type Plugin = { … }

Members

SettingsPanel?React.ComponentType

The plugin's settings panel, rendered as <SettingsPanel /> only while the plugin is running.

selfTest?(): PluginSelfTestResult | Promise<PluginSelfTestResult>

Checks, without side effects, that the running plugin works on this device; the device matrix calls it after a restart.

start?(context?: PluginContext): void | Promise<void>

Called when the plugin starts, inside its Addon scope, with its native bridge context; a rejected promise is recorded as a start failure.

stop?(): void | Promise<void>

Called when the plugin stops; a returned promise is awaited, and the scope is disposed even if it throws.