Skip to content

ModuleProviderProps

Since Plugin API: 1.0.0

Props passed to module components

Signature

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

Members

Name Type Required Description
presented boolean no Whether this retained surface is currently presented. Omitted by older hosts. Release presentation resources while false, retaining working state and drafts.
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.

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.