Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ModuleConnectionStatus

Renders the shared live connection indicator for an opted-in module.

Import

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

Declaration

export const ModuleConnectionStatus: HostComponent<ModuleConnectionStatusProps>;

ModuleConnectionStatusProps

Props for the shared opt-in module connection indicator.

export interface ModuleConnectionStatusProps extends HostComponentProps {
    presentation: {
        channel: string;
        label?: string;
        endpoint?: string;
        connectedValue?: string | number | boolean;
    };
    showText?: boolean;
    compact?: boolean;
}
PropTypeRequirementDescription
presentation`{

channel: string;

label?: string;

endpoint?: string;

connectedValue?: string | number | boolean;

}`		Required
showTextbooleanOptional
compactbooleanOptional