Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

SettingsPanelDefinition

Registers a plugin settings panel.

Import

import type { SettingsPanelDefinition } from "@dartwic/interface-sdk";

Declaration

export interface SettingsPanelDefinition extends NamedContribution {
    /** Optional shared document declaration. An explicit component can interleave custom UI and ConfigMap group views. */
    configMap?: ConfigMapDefinition;
    component?: PluginSettingsDefinition["component"];
    /** Host normalization metadata; set by the registrar for an explicit component with configMap. */
    customConfigMapLayout?: boolean;
}

Members

NameTypeRequirementDescription
configMapConfigMapDefinitionOptionalOptional shared document declaration. An explicit component can interleave custom UI and ConfigMap group views.
componentPluginSettingsDefinition["component"]Optional
customConfigMapLayoutbooleanOptionalHost normalization metadata; set by the registrar for an explicit component with configMap.