AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

ModuleProviderProps

Since Plugin API: 1.0.0

Props passed to module components

Signature

interface ModuleProviderProps {
    pane?: PluginPaneContext;
    moduleInstance: ModuleInstance;
    updateState(state: unknown): void;
    close(): Promise<void>;
}

Members

Name	Type	Required	Description
`pane`	`PluginPaneContext`	no	The pane context (for pane-scoped modules)
`moduleInstance`	`ModuleInstance`	yes	The module instance configuration
`updateState`	`(state: unknown) => void`	yes	Replace this instance’s opaque state and schedule center-session persistence.
`close`	`() => Promise<void>`	yes	Request that the host close this module instance.