Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ModuleInstanceSelect

Selects only module instances owned by the requested plugin and compatible module types.

Import

import { ModuleInstanceSelect } from "@dartwic/interface-sdk/ui";

Declaration

export const ModuleInstanceSelect: HostComponent<ModuleInstanceSelectProps>;

ModuleInstanceSelectProps

Props for selecting a live module instance compatible with a plugin task.

export interface ModuleInstanceSelectProps extends HostComponentProps {
    /** Engine plugin that must own every displayed module instance. */
    pluginId: string;
    /** Optional compatible module type IDs, in local or plugin-qualified form. */
    moduleTypeIds?: string[];
    /** Selected module-instance name. */
    value?: string;
    /** Called with the selected module-instance name. */
    onValueChange?: (value: string) => void;
    /** Empty-selection prompt. */
    placeholder?: string;
    /** Disables the selector. */
    disabled?: boolean;
    /** Shows loading, incompatibility, and empty-state diagnostics. */
    showStatus?: boolean;
}

Prop	Type	Requirement	Description
`pluginId`	`string`	Required	Engine plugin that must own every displayed module instance.
`moduleTypeIds`	`string[]`	Optional	Optional compatible module type IDs, in local or plugin-qualified form.
`value`	`string`	Optional	Selected module-instance name.
`onValueChange`	`(value: string) => void`	Optional	Called with the selected module-instance name.
`placeholder`	`string`	Optional	Empty-selection prompt.
`disabled`	`boolean`	Optional	Disables the selector.
`showStatus`	`boolean`	Optional	Shows loading, incompatibility, and empty-state diagnostics.