IListViewExportToExcelProps
@spartanfx/react v1.2.2
@spartanfx/react / spfx / IListViewExportToExcelProps
Interface: IListViewExportToExcelProps
Props for the ListViewExportToExcel component, which enables exporting SharePoint list data to Excel.
Properties
Required
| Property | Type | Description |
|---|
columns | IListviewColumn[] | An array of column definitions to include in the Excel export. |
listViewService | ListViewService | A service instance used to fetch list data, typically wrapping PnPjs logic. |
Options
| Property | Type | Description |
|---|
attributeOverride? | object | Matrix with projected field override to target different projected field value |
buttonText? | string | Optional custom text to show on the export button. Defaults to "Export To Excel". |
filters? | object | Optional filter object where keys are field names and values are arrays of selected values. |
searchText? | string | Optional search string used to filter the list. |
sortField? | object | Optional sorting configuration: field name and direction. |
sortField.SortDir? | "Asc" | "Desc" | - |
sortField.SortField? | string | - |
translatedFields? | string[] | Array of field names whose values should be passed through the translate function. |
Events & callbacks
| Property | Type | Description |
|---|
translate? | (key) => string | Optional translation function to localize labels. |
Advanced & escape hatches
| Property | Type | Description |
|---|
buttonProps? | Partial<IButtonProps> | Optional props to customize the export button. |