OptionalcolumnAn array of numbers (column indices) indicating the order the columns should be displayed in. Defaults to the order provided by the Columns prop. This option is useful if you'd like certain columns to swap position.
For drag-and-drop column reordering, see the draggableColumns option below.
OptionalconfirmWorks in conjunction with the customFilterDialogFooter options and make is so filters have to be confirmed before being applied to the table.
When this option is true, the customFilterDialogFooter callback will receive an applyFilters function which, when called will apply the filter to the table.
OptionalcountUser provided override for the total number of row.
OptionalcustomAdd a custom footer to the filter dialog.
OptionalcustomRender a custom table footer.
OptionalcustomOverride default row rendering with custom function.
OptionalcustomOverride default search with custom function.
OptionalcustomRender a custom selected rows ToolBar.
OptionalcustomOverride default sorting with custom function.
If you just need to override the sorting for a particular column, see the sortCompare method in the Column options.
OptionalcustomRender a footer under the table body but above the table's standard footer. This is useful for creating footers for individual columns.
OptionalcustomRender a custom Toolbar.
OptionalcustomRender a custom selected row ToolBar.
OptionaldisablePossible Values:
An object of options to change the output of the csv file.
An object of options describing how dragging columns should work.
The options are:
enabled: boolean - Indicates if draggable columns are enabled. Default is false
transitionTime: number - The time in milliseconds it takes for columns to swap positions. Default is 300.
To disable the dragging of a particular column, see the "draggable" option in the columns options. Dragging a column to a new position updates the columnOrder array and triggers the onColumnOrderChange callback.
Shadow depth applied to the <Paper /> component.
If a non-empty string (ex: ".") is provided, it will use that value in the column's names to access nested data.
For example, given a value of "." for enableNestedDataAccess and a column name of "phone.cell", the column would use the value found in phone: { cell:"555-5555" }
Any amount of nesting will work.
Enable/disable expandable rows.
Show/hide the expand all/collapse all row header for expandable row.
Enable/disable expand trigger when row is clicked. When false, only expand icon will trigger this action.
Possible Values:
For array values, default checks if all the filter values are included in the array. If false, checks if at least one of the filter values is in the array.
Choice of filtering view. Takes priority over global filterType option.
Use 'custom' is you are supplying your own rendering via filterOptions.
Enable/disable a fixed header for the table
OptionalfixedEnable/disable fixed select column.
OptionalisEnable/disable expansion or collapse on certain expandable rows with custom function.
Returns true if not provided.
OptionalisEnable/disable selection on certain rows with custom function. Returns true if not provided.
When true, the option adds a dropdown to the table's footer that allows a user to navigate to a specific page.
OptionalonCallback function that triggers when a cell is clicked.
OptionalonOptionalonCallback function that triggers when a page has changed.
OptionalonCallback function that triggers when a column has been dragged to a new location.
OptionalonCallback function that triggers when a column has been sorted.
Name of the column that was sorted
New sort order direction (asc or desc)
OptionalonUse onColumnVisibilityChange instead
OptionalonCallback function that triggers when a column view has been changed.
Previously known as onColumnViewChange or onViewColumnsChange.
Name of the column that was changed
OptionalonA callback function that triggers when the user downloads the CSV file. In the callback, you can control what is written to the CSV file. Return false to cancel download of file.
OptionalonCallback function that triggers when filters have changed.
OptionalonCallback function that is triggered when a user clicks the "X" on a filter chip.
OptionalonCallback function that is triggered when a user presses the "confirm" button on the filter popover.
This occurs only if you've set confirmFilters option to true.
OptionalonCallback function that triggers when the filter dialog closes.
OptionalonCallback function that triggers when the filter dialog opens.
OptionalonCallback function that triggers when a row is clicked.
OptionalonCallback function that triggers when row(s) are expanded/collapsed.
OptionalonCallback function that triggers when row(s) are deleted. Returning false prevents row deletion.
OptionalonCallback function that triggers when row(s) are selected/deselected.
OptionalonOptionalonOptionalonCallback function that triggers when the search text value has changed.
OptionalonCallback function that triggers when the searchbox closes.
OptionalonCallback function that triggers when the searchbox opens.
OptionalonCallback function that triggers when table state has changed.
OptionalonCallback function that triggers when table state has been initialized.
OptionalonUse onColumnVisibilityChange instead
OptionalpageUser provided page for pagination
Enable/disable pagination.
Possible Values:
OptionalrenderRender Expandable rows.
Set to true to allow users to resize columns by dragging the edges.
Enable/disable responsive table view. Options:
Enable/disable hover style over row.
OptionalrowsUser provided expanded rows
Number of rows allowed per page.
Options to provide in pagination for number of rows a user can select
OptionalrowsUser provided array of number (dataIndexes) which indicated the selected row.
Possible Values:
Always displays search bar, and hides search icon in toolbar.
The delay in milliseconds to wait before triggering the search. For example, setting searchDelay: 300 means the search will only execute 300ms after the user stops typing.
Initially displays search bar.
OptionalsearchSearch text placeholder.
OptionalsearchProps applied to the search text box. You can set method callbacks like onBlur, onKeyUp, etc, this way.
OptionalsearchSearch text for the table.
Indicates if rows can be selected.
Show/hide the select all/deselect all checkbox header for selectable rows.
Hides the checkboxes that appear when selectableRows is set to "multiple" or "single". Can provide a more custom UX, especially when paired with selectableRowsOnClick.
Enable/disable select toggle when row is clicked. When False, only checkbox will trigger this action.
Controls the visibility of the Select Toolbar.
Options:
always:Enable remote data source
Optionalserverin favor of the confirmFilters option.
OptionalsetIs called for each filter chip and allows you to place custom props on a filter chip.
OptionalsetIs called for each row and allows you to return custom props for this row based on its data.
OptionalsetIs called for the table and allows you to return custom props for the table based on its data.
Enable/disable sort on all columns.
Enable/disable alphanumeric sorting of filter lists.
OptionalsortSets the column to sort by and its sort direction. To remove/reset sorting, input in an empty object. The object options are the column name and the direction.
OptionalstorageLocal storage key used to store the table state.
CSS string for the height of the table.
OptionaltableCSS string for the height of the table.
OptionaltextUser provided labels to localize text.
Possible Values:
Enable/disable case sensitivity for search