SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IReactNotifier

    Interface that provides popups for the user.

    interface IReactNotifier {
        showBusy: (
            message: ReactNode,
            options?: ShowBusyOptions,
        ) => BusyHandle | Promise<BusyHandle>;
        showError: (error: string | Error) => void;
        showInput: (options: ShowInputOptions) => Promise<InputResults>;
        showMessage: (message: ReactNode, options?: EnqueueNotifierOptions) => void;
        showOptions: (options: ShowOptionsOptions) => Promise<OptionInput>;
        showWindow: (
            type: string,
            options?: ShowWindowOptions<any, any>,
        ) => Promise<HTMLElement>;
        debug(message: string, options?: NotifierOptions): void;
        error(error: string | Error, options?: NotifierOptions): void;
        log(message: string, options?: NotifierOptions): void;
        warn(message: string, options?: NotifierOptions): void;
    }

    Hierarchy

    • INotifier
      • IReactNotifier

    Implemented by

    Index
    showBusy showError showInput showMessage showOptions showWindow
    debug error log warn
    showBusy: (
        message: ReactNode,
        options?: ShowBusyOptions,
    ) => BusyHandle | Promise<BusyHandle>

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

    Returns a BusyHandle: call it to dismiss the indicator, or use its setProgress / setMessage methods to update it while it shows. If multiple calls are made the consumer should continue to indicate blocked until all handles have been dismissed.

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

    Should return error object exception.

    Type Declaration

      • (error: string | Error): void

      • Parameters

        • error: string | Error

          The error to show

        Returns void

    showInput: (options: ShowInputOptions) => Promise<InputResults>

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

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

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

    showOptions: (options: ShowOptionsOptions) => Promise<OptionInput>

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

    showWindow: (
        type: string,
        options?: ShowWindowOptions<any, any>,
    ) => Promise<HTMLElement>

    Show a dialog for a given type.

    • For debug logging.

      Parameters

      • message: string

        The debug message to display.

      • Optionaloptions: NotifierOptions

        Options for the debug notification.

      Returns void

    • Should return error object exception.

      Parameters

      • error: string | Error

        The error message or object to display.

      • Optionaloptions: NotifierOptions

        Options for the error notification.

      Returns void

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

      Parameters

      • message: string

        The log message to display.

      • Optionaloptions: NotifierOptions

        Options for the log notification.

      Returns void

    • Should return error object exception.

      Parameters

      • message: string

        The warning message to display.

      • Optionaloptions: NotifierOptions

        Options for the warning notification.

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods