Grid / Overlays

Overlays communicate transient states over the grid body — loading, empty results, errors, and custom content. They are shown automatically based on Data Pipeline state (loading / noRows / noMatchingRows) or triggered manually via grid.showOverlay() and dismissed with grid.hideOverlay(). Custom overlay content can be provided via the overlayComponents option.

Loading overlay

Triggered automatically via the loading prop on OmniGrid. The loading overlay takes precedence over all other automatic overlays.

Toggle loading to show / hide the loading overlay.

Loading…

No rows overlay

Shown automatically when the grid has no data at all (data is empty) and the grid is not loading.
No data to display

No matching rows overlay

Shown when the raw data is non-empty but the processed (filtered) data is empty. In this example, the grid has data but the search input produces no matches; typing a filter term triggers grid.showOverlay({ type: "noMatchingRows" }) manually.

Type a search term that matches no pilots to trigger the noMatchingRows overlay.

Loading…

Error overlay

Triggered manually via grid.showOverlay({ type: "error", payload }). Calling this disables automatic overlay evaluation until grid.hideOverlay() is called.

Click Simulate error to show the error overlay with a payload. Click Clear error to dismiss.

Loading…

Custom overlay

The custom overlay type renders arbitrary payload content via grid.showOverlay({ type: "custom", payload }). The overlayComponents prop lets you replace the default rendering for each overlay type.

The custom overlay renders arbitrary content. Below, the overlayComponents prop replaces the default rendering for all overlay types. Click Simulate error to see the custom error renderer.

Fetching from the minion database...