Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ModuleInstanceConnectionProps

Shared module selector, module link, and opt-in live connection status.

Import

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

Declaration

export interface ModuleInstanceConnectionProps extends ModuleInstanceSelectProps {
    /** Supporting copy shown beneath the shared control. */
    description?: string;
    /** Hides the selector and presents only the linked module. */
    showSelector?: boolean;
    /** Shows the module's plugin-declared connection state when available. */
    showConnectionStatus?: boolean;
    /** Shows connection-state text instead of a compact indicator. */
    statusText?: boolean;
    /** Uses the compact header/footer layout. */
    compact?: boolean;
}

Members

NameTypeRequirementDescription
descriptionstringOptionalSupporting copy shown beneath the shared control.
showSelectorbooleanOptionalHides the selector and presents only the linked module.
showConnectionStatusbooleanOptionalShows the module’s plugin-declared connection state when available.
statusTextbooleanOptionalShows connection-state text instead of a compact indicator.
compactbooleanOptionalUses the compact header/footer layout.