ConfigMapField

Import

import type { ConfigMapField } from "@dartwic/interface-sdk/config-maps";

Declaration

export interface ConfigMapField {
    path: string;
    label: string;
    type?: 'text' | 'number' | 'select' | 'toggle' | 'module' | 'channel';
    required?: boolean;
    /** Missing-value display/default; may be a pure (document, row) function for native defaults such as derived readback names. */
    defaultValue?: any;
    min?: number;
    max?: number;
    integer?: boolean;
    placeholder?: string;
    description?: string;
    /** Hidden metadata is still validated and searchable, but is not drawn as a column. */
    hidden?: boolean;
    options?: Array<{value: string; label: string}>;
    pluginId?: string;
    moduleTypeIds?: string[];
    /** Optional selector hint matching the native configured-task limit; zero/omitted is unlimited. Engine validation remains authoritative. */
    maxTasksPerModule?: number;
    channelMode?: 'read' | 'write' | ((document: any, row?: any) => 'read' | 'write');
    parse?(raw: string): any;
    validate?(value: any, document: any, context: any): string;
    /** Custom cell must call onDraft for text changes and onCommit only for explicit acceptance. */
    render?(props: {value: any; draft: any; path: string; document: any; row?: any;
        onDraft(value: any): void; onDraftAt(path: string, value: any): void; onCommit(value: any): void; context: any; disabled: boolean}): any;
}

Members