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

    Interface BusyHandle

    The handle returned by IReactNotifier.showBusy.

    It is callable — calling it dismisses the busy indicator (the historical hideBusy() contract) — and also carries methods to update the indicator while it is showing. This keeps every existing const hideBusy = await showBusy(...); hideBusy(); call working unchanged.

    interface BusyHandle {
        setMessage(message: ReactNode): void;
        setProgress(completed?: number, total?: number): void;
        (): void;
    }
    • Dismiss the busy indicator.

      Returns void

    Index
    • Update the message shown beside the indicator.

      Parameters

      • message: ReactNode

      Returns void

    • Update the indicator to a determinate state. When total is known the indicator shows a percentage / progress bar; passing total as undefined (or completed as undefined) returns it to the indeterminate (spinner) state.

      Parameters

      • Optionalcompleted: number

        The cumulative work done so far.

      • Optionaltotal: number

        The total work, in the same units as completed.

      Returns void