Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ConfigMap

Host configuration table with connection-scoped shared drafts and serialized application through its adapter. Standalone text commits on Enter; registered module/task sheets use Apply and plugin settings save on blur. Requires a host exposing ConfigMap.

Import

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

Declaration

export const ConfigMap: HostComponent<ConfigMapProps>;

ConfigMapProps

Props for session-shared configuration editing; resourceKey must uniquely identify one resource within a connection.

export interface ConfigMapProps extends Record<string, unknown> {
    /** Required standalone; inherited inside a registered custom module/task/settings editor. */
    definition?: ConfigMapDefinition;
    /** Required standalone; inherited inside a registered custom editor. Use the same key for every view of one document. */
    resourceKey?: string;
    context?: Record<string, any>;
    /** Render selected group IDs from the full definition. All views still share its one session, validation and adapter. */
    groupIds?: string[];
}

Prop	Type	Requirement	Description
`definition`	`ConfigMapDefinition`	Optional	Required standalone; inherited inside a registered custom module/task/settings editor.
`resourceKey`	`string`	Optional	Required standalone; inherited inside a registered custom editor. Use the same key for every view of one document.
`context`	`Record<string, any>`	Optional
`groupIds`	`string[]`	Optional	Render selected group IDs from the full definition. All views still share its one session, validation and adapter.