Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SchematicCommandAction

Operator command exposed by a schematic node.

Import

import type { SchematicCommandAction } from "@dartwic/interface-sdk/schematic-nodes";

Declaration

export interface SchematicCommandAction {
    id: string;
    label: string;
    disabled?: boolean;
    hidden?: boolean;
    description?: string;
    input?: {
        type?: "text" | "number";
        placeholder?: string;
        defaultValue?: unknown;
        min?: string | number;
        max?: string | number;
        step?: string | number;
    };
    choice?: {
        items: Array<{value: string; label: string; keywords?: string[]}>;
        defaultValue?: unknown;
        placeholder?: string;
        searchPlaceholder?: string;
        emptyPlaceholder?: string;
    };
    onRun?: (value?: unknown) => unknown | Promise<unknown>;
}

Members

Name	Type	Requirement
`id`	`string`	Required
`label`	`string`	Required
`disabled`	`boolean`	Optional
`hidden`	`boolean`	Optional
`description`	`string`	Optional
`input`	`{<br> type?: "text" \| "number";<br> placeholder?: string;<br> defaultValue?: unknown;<br> min?: string \| number;<br> max?: string \| number;<br> step?: string \| number;<br> }`	Optional
`choice`	`{<br> items: Array<{value: string; label: string; keywords?: string[]}>;<br> defaultValue?: unknown;<br> placeholder?: string;<br> searchPlaceholder?: string;<br> emptyPlaceholder?: string;<br> }`	Optional
`onRun`	`(value?: unknown) => unknown \| Promise<unknown>`	Optional