Skip to content

Interface: UseExportConfig\<TRow\>

Defined in: src/export/use-export.ts:10

Configuration for the useExport hook — the rows, columns, and value accessors used by CSV/XLSX exports triggered through the returned API.

Type Parameters

TRow

TRow

Properties

columns

columns: ExportColumn[]

Defined in: src/export/use-export.ts:18

Column definitions for export.


getAllRows

getAllRows: () => TRow[] | Promise<TRow[]>

Defined in: src/export/use-export.ts:14

Get all rows (may call dataSource.exportAll).

Returns

TRow[] | Promise<TRow[]>


getRowValue

getRowValue: (row, columnId) => string

Defined in: src/export/use-export.ts:20

Read a cell value as a string.

Parameters

row

TRow

columnId

string

Returns

string


getSelectedRows

getSelectedRows: () => TRow[]

Defined in: src/export/use-export.ts:16

Get selected rows.

Returns

TRow[]


getVisibleRows

getVisibleRows: () => TRow[]

Defined in: src/export/use-export.ts:12

Get currently visible (filtered/sorted) rows.

Returns

TRow[]