UseExcelExportReturn

Return data from useExcelExport. Exposes the export executor, progress status, loading state, and error data.

Props

The following table outlines the props for the UseExcelExportReturn:

NameTypeDefaultDescription
error
string | null
-

Last error message, or null if no error occurred.

excelExport
(settings: ExcelExportSettings<T>) => Promise<Blob>
-

Export the grid data to Excel and return a Blob.

isExporting
boolean
-

True while the export operation is active.

progress
number
-

Progress as a percentage from 0 to 100.