Search
React Data Grid

Overlays

react logo

Overlays are for displaying messages over the grid.

When using the Client-side Data the grid uses two overlays:

  1. Loading Overlay: Displayed if rowData or columnDefs are set to null or undefined.
  2. No Rows Overlay: Displayed if rowData is an empty list.

You can manually show the overlays using the grid API's showLoadingOverlay(), showNoRowsOverlay() and hideOverlay().

HTML templates can be provided to the overlays using grid properties overlayLoadingTemplate and overlayNoRowsTemplate.

Custom Overlays

This example demonstrates Custom Overlay Components.

Loading Overlay Component is configured via the grid properties loadingOverlayComponent and loadingOverlayComponentParams.

When a loading overlay component is instantiated within the grid, the following will be made available on props:

Properties available on the CustomLoadingOverlayProps<TData = any, TContext = any> interface.

No Rows Overlay Component is configured via the grid properties noRowsOverlayComponent and noRowsOverlayComponentParams.

When a no rows overlay component is instantiated within the grid, the following will be made available on props:

Properties available on the CustomNoRowsOverlayProps<TData = any, TContext = any> interface.