Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

LoadingOverlay

Block a local action while work is in progress.

Preview

Live preview

Changes apply to this preview only.

aria-busy=true · the covered button cannot be focused

Loading the dashboard

Metrics, invoices and activity arrive together.

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Blur

blur filters the covered content and blurs the backdrop behind the message.

Open preview

Saving settings

A saving settings composition using LoadingOverlay.

Open preview

Preparing an export

A preparing an export composition using LoadingOverlay.

Open preview

Usage

Use a loading overlay for an actual pending task and always provide completion/error recovery.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluLoadingOverlayProps

Type source
PimoluLoadingOverlayProps public API
NameTypeDefaultDescription
loadingboolean | undefinedtrueWhether the overlay is visible. Defaults to true.
labelstring | undefined"Loading"Visible and announced loading message.
descriptionReactNode—Optional supporting text shown under the label.
blurboolean | undefinedfalseBlurs the covered content while loading.
fullscreenboolean | undefinedfalseCovers the whole viewport with fixed positioning.
childrenReactNode—Content covered by the overlay. It is inert while loading.
onChangeChangeEventHandler<HTMLDivElement, Element> | undefined—Standard React/HTML attribute.
defaultValuestring | number | readonly string[] | undefined—Standard React/HTML attribute.
classNamestring | undefined—Standard React/HTML attribute.
styleCSSProperties | undefined—Standard React/HTML attribute.
aria-labelstring | undefined—Defines a string value that labels the current element.
onClickMouseEventHandler<HTMLDivElement> | undefined—Standard React/HTML attribute.
loading

boolean | undefined

Default: true

Whether the overlay is visible. Defaults to true.

label

string | undefined

Default: "Loading"

Visible and announced loading message.

description

ReactNode

No default extracted.

Optional supporting text shown under the label.

blur

boolean | undefined

Default: false

Blurs the covered content while loading.

fullscreen

boolean | undefined

Default: false

Covers the whole viewport with fixed positioning.

children

ReactNode

No default extracted.

Content covered by the overlay. It is inert while loading.

onChange

ChangeEventHandler<HTMLDivElement, Element> | undefined

No default extracted.

Standard React/HTML attribute.

defaultValue

string | number | readonly string[] | undefined

No default extracted.

Standard React/HTML attribute.

className

string | undefined

No default extracted.

Standard React/HTML attribute.

style

CSSProperties | undefined

No default extracted.

Standard React/HTML attribute.

aria-label

string | undefined

No default extracted.

Defines a string value that labels the current element.

onClick

MouseEventHandler<HTMLDivElement> | undefined

No default extracted.

Standard React/HTML attribute.

Accessibility

  • Announce busy state without trapping focus indefinitely or concealing critical cancellation controls.
Read the accessibility guide →