Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ConfigurableInput

Edits a configurable literal, channel reference, or expression value.

Import

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

Declaration

export const ConfigurableInput: HostComponent<ConfigurableInputProps>;

ConfigurableInputProps

Props for editing a serialized configurable-input expression.

export interface ConfigurableInputProps extends HostComponentProps {
    /** Serialized configurable-input state. */
    initialData: Record<string, unknown>;
    /** Called whenever the serialized state changes. */
    onDataChange: (nextData: Record<string, unknown>) => void;
    /** Input kinds hidden from the editor. */
    excludedTypes?: string[];
    /** Uses the compact editor layout. */
    compact?: boolean;
}

Prop	Type	Requirement	Description
`initialData`	`Record<string, unknown>`	Required	Serialized configurable-input state.
`onDataChange`	`(nextData: Record<string, unknown>) => void`	Required	Called whenever the serialized state changes.
`excludedTypes`	`string[]`	Optional	Input kinds hidden from the editor.
`compact`	`boolean`	Optional	Uses the compact editor layout.
`className`	`string`	Optional	Additional Tailwind or host CSS classes.
`children`	`HostNode`	Optional	Child content rendered by the host component.
`id`	`string`	Optional	Optional DOM identifier.
`style`	`Record<string, unknown>`	Optional	Inline style values passed to the host component.