SheetXL - v0.3.20
    Preparing search index...

    Interface Notifier

    Interface that provides popups for the user.

    interface Notifier {
        showBusy?: (
            message: ReactNode,
            options?: BusyNotificationOptions,
        ) => Promise<() => void> | (() => void);
        showError?: (error: string | Error) => void;
        showInputOptions?: (
            options: InputOptionsNotificationOptions,
        ) => Promise<InputResults>;
        showMessage?: (message: ReactNode, options?: NotificationOptions) => void;
        showOptions?: (options: OptionsNotificationOptions) => Promise<string>;
        showWindow?: (
            type: string,
            props?: any,
            options?: { disableAutoDestroy?: boolean },
        ) => Promise<HTMLElement>;
    }
    Index

    Properties

    showBusy? showError? showInputOptions? showMessage? showOptions? showWindow?

    Properties

    showBusy?: (
        message: ReactNode,
        options?: BusyNotificationOptions,
    ) => Promise<() => void> | (() => void)

    Useful when performing a long running operation and you want to inform the user.

    A return type of a handler will be returned to allow for hideBusy. If multiple calls are made the consumer should continue to indicated blocked until all calls have been hideBusy.

    showError?: (error: string | Error) => void

    Should return error object exception.

    showInputOptions?: (
        options: InputOptionsNotificationOptions,
    ) => Promise<InputResults>

    Provider a user with a way to enter a text input.

    showMessage?: (message: ReactNode, options?: NotificationOptions) => void

    Useful when informing the user of something but are not expecting a response.

    showOptions?: (options: OptionsNotificationOptions) => Promise<string>

    Provide a user with a list of options to choose from.

    showWindow?: (
        type: string,
        props?: any,
        options?: { disableAutoDestroy?: boolean },
    ) => Promise<HTMLElement>

    Show a dialog for a given type.

    Settings

    Member Visibility

    On This Page

    Properties