Interface: GridLoadingOverlayProps<TRow>

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:19

Type Parameters

TRow

TRow

Properties

cancellable?

optional cancellable?: boolean

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:30

Offer a Cancel button for phases that can actually stop. Default true.

Only shown for the off-thread phases — the ones that check between chunks. A button that does nothing is worse than no button.

controller

controller: DataGridController<TRow>

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:20

delay?

optional delay?: number

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:22

Milliseconds of continuous work before the overlay appears. Default 300.

forced?

optional forced?: boolean

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:39

Show it regardless of what the grid is doing, and without the delay (gap analysis P2.11) — controller.showLoadingOverlay() sets this.

The delay exists to stop the overlay strobing over work that finishes in a few milliseconds. An explicit call is a decision, not a flicker to absorb, and the application making it usually has nothing else to show yet.

labels?

optional labels?: Partial<Record<BusyPhase | "busy" | "cancel", string>>

Defined in: datagrid-react/src/components/GridLoadingOverlay.tsx:23