UseGridExcelExportOptions

Options passed to useExcelExport hook to enable grid-aware data resolution. Mirrors UseGridPdfExportOptions for consistent API parity.

Props

The following table outlines the props for the UseGridExcelExportOptions:

NameTypeDefaultDescription
getAllData
(query: unknown) => Promise<T[]>
-

Optional callback to fetch all data from remote/custom source. Invoked when range is All and data cannot be resolved locally.

getColumns
( ) => ColumnProps[]
-

Optional callback to supply custom column definitions for export. Overrides visible grid columns when provided.

gridRef
RefObject<GridRef<T>>
-

Reference to the Grid component instance. Used to resolve currentPage data and column definitions.