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

    Interface AnimatedLoadingPanelProps

    interface AnimatedLoadingPanelProps {
        autoStart?: boolean;
        icon?: ReactNode;
        label?: ReactNode;
        onMount?: () => void;
        onUnmount?: () => void;
        panel?: boolean;
        progress?: number | null;
        ref?: Ref<HTMLDivElement>;
        transitionDelay?: string;
        transparentBackground?: boolean;
    }

    Hierarchy

    • LoadingPanelProps
    • Omit<BoxProps, "label" | "color" | "ref" | "children">
      • AnimatedLoadingPanelProps
    Index
    autoStart? icon? label? onMount? onUnmount? panel? progress? ref? transitionDelay? transparentBackground?
    autoStart?: boolean

    Begin the fade-in as soon as the panel mounts.

    true — mount it when work starts and it shows itself; unmount it when the work ends.

    Pass false to keep the panel mounted but idle and drive it with showLoadingPanel / hideLoadingPanel. Both modes obey the same rule — the fade must be COMMITTED before the caller blocks the main thread — but a panel mounted at the moment work begins has never been painted, so committing it costs a mount, a first paint of a full-screen layer, and the wait for transitionrun below. An already-mounted panel is already painted: one frame and it is armed.

    icon?: ReactNode
    label?: ReactNode
    onMount?: () => void

    Optional callback when mounted

    onUnmount?: () => void

    Optional callback when unmounted

    panel?: boolean

    Wrap the icon and label in a paper panel.

    progress?: number | null

    Determinate progress as a fraction in [0, 1]. When a number, a determinate progress bar and percentage are shown in place of the animated icon; when null/undefined the indeterminate icon is shown.

    ref?: Ref<HTMLDivElement>

    Ref to the element.

    transitionDelay?: string

    A delay for showing the loading panel.

    This helps prevent flicker if loading is very fast.

    transparentBackground?: boolean

    Whether the background should be transparent.

    false

    Settings
    Member Visibility

    On This Page
    Properties