React Data GridOverlay Component
React Data GridOverlay Component
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
.
Overlay Component Interface
Any valid React component can be an Overlay. When a custom Overlay Component is instantiated within both a template and the Grid API will be made available on props
:
ILoadingOverlayParams
Properties available on the ILoadingOverlayParams<TData = any, TContext = any>
interface.
apiTypeGridApi | The grid api. |
contextTypeTContext | Application context as set on gridOptions.context . |
INoRowsOverlayParams
Properties available on the INoRowsOverlayParams<TData = any, TContext = any>
interface.
apiTypeGridApi | The grid api. |
contextTypeTContext | Application context as set on gridOptions.context . |
Registering Overlay Components
See the section registering custom components for details on registering and using custom overlays.