pivotick - v3.0.0
    Preparing search index...

    Interface TopBarActionContext

    What a TopBarAction's onclick and menu are handed.

    interface TopBarActionContext {
        confirm: (options?: ConfirmOptions) => Promise<boolean>;
        graph: Pivotick;
        promptData: <T = Record<string, unknown>>(
            options: PromptDataOptions<T>,
        ) => Promise<T | null>;
        refresh: () => void;
    }
    Index

    Properties

    confirm: (options?: ConfirmOptions) => Promise<boolean>

    Ask before doing something; resolves true only on the confirm button.

    graph: Pivotick
    promptData: <T = Record<string, unknown>>(
        options: PromptDataOptions<T>,
    ) => Promise<T | null>

    Open the library's modal and resolve to the values, or null on cancel. The same declarative form the editors and a pivot's save use; titled with the action's label and submitted with OK unless the options say otherwise.

    refresh: () => void

    Re-read every action's fields, as UIManager.refreshTopBar does.