Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ModuleConfigRegistration

Bridge exposed by the host module editor to a plugin configuration component.

Import

import type { ModuleConfigRegistration } from "@dartwic/interface-sdk/module-configs";

Declaration

export interface ModuleConfigRegistration {
    register(nextState?: ModuleConfigBridgeState): void;
    setDirty?(isDirty: boolean): void;
    setSaving?(isSaving: boolean): void;
    setCanSave?(canSave: boolean): void;
    setErrorMessage?(errorMessage: string): void;
    reset?(): void;
}

Members

NameTypeRequirementDescription
registervoidRequired
setDirtyvoidOptional
setSavingvoidOptional
setCanSavevoidOptional
setErrorMessagevoidOptional
resetvoidOptional