Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SchematicNodeDefinition

Complete renderer, editor, palette, sizing, and command contract for a node type.

Import

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

Declaration

export interface SchematicNodeDefinition {
    type: string;
    component: (props: SchematicNodeProps) => any;
    configComponent?: (props: SchematicNodeConfigProps) => any;
    getCommandActions?: (context: SchematicCommandContext) => SchematicCommandAction[];
    selectionIcon?: any;
    propDefaults?: Record<string, unknown>;
    dataDefaults?: Record<string, unknown>;
    resizable?: boolean;
    connectable?: boolean;
    useMeasuredSize?: boolean;
    palette?: SchematicNodePaletteDefinition;
}

Members

NameTypeRequirementDescription
typestringRequired
component(props: SchematicNodeProps) => anyRequired
configComponent(props: SchematicNodeConfigProps) => anyOptional
getCommandActions(context: SchematicCommandContext) => SchematicCommandAction[]Optional
selectionIconanyOptional
propDefaultsRecord<string, unknown>Optional
dataDefaultsRecord<string, unknown>Optional
resizablebooleanOptional
connectablebooleanOptional
useMeasuredSizebooleanOptional
paletteSchematicNodePaletteDefinitionOptional