Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

useTaskConfigBridge

Synchronizes save, cancel, dirty, and validation state with the host task editor.

Import

import { useTaskConfigBridge } from "@dartwic/interface-sdk/tasks";

Declaration

export function useTaskConfigBridge(taskEditor: TaskConfigRegistration | null | undefined, config: TaskConfigBridgeState = {}) {
    const {
        isDirty = false,
        isSaving = false,
        canSave = true,
        errorMessage = "",
        saveLabel = "SAVE",
        cancelLabel = "CANCEL",
        onSave = null,
        onCancel = null,
    } = config;

    (React as any).useEffect(() => {
        taskEditor?.register?.({
            isDirty,
            isSaving,
            canSave,
            errorMessage,
            saveLabel,
            cancelLabel,
            onSave,
            onCancel,
        });
    }, [
        taskEditor,
        isDirty,
        isSaving,
        canSave,
        errorMessage,
        saveLabel,
        cancelLabel,
        onSave,
        onCancel,
    ]);
}