React Data GridOverlay Component
react logo

Overlay components allow you to add your own overlays to AG Grid. Use these when the provided overlays do not meet your requirements.

There are two types of overlay components:

  • Loading Overlay: Overlay for when the grid is loading data.
  • No Rows: Overlay for when the grid has loaded an empty array of rows.

Example: Custom Overlay Components

The example below demonstrates how to provide custom overlay components to the grid. Notice the following:

  • Custom Loading Overlay Renderer is supplied by name via gridOptions.loadingOverlayComponent.
  • Custom Loading Overlay Renderer Parameters are supplied using gridOptions loadingOverlayComponentParams.
  • Custom No Rows Overlay Renderer is supplied by name via gridOptions.noRowsOverlayComponent.
  • Custom No Rows Overlay Renderer Parameters are supplied using gridOptions.noRowsOverlayComponentParams.

Implementing a Loading Overlay Component

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.

Implementing a No Rows Overlay Component

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.

Registering Overlay Components

See Registering Custom Components for details on registering and using custom overlays.