Optional ComponentCustom component to manage all sorting buttons. It overrides all sorting indicators.
Optional ascendingIndicator when column is sorted in ascending order. Used in default sorting component.
'↓'
Optional defaultIndicator when column is not sorted. Used in default sorting component.
'⇅'
Optional descendingIndicator when column is sorted in descending order. Used in default sorting component.
'↑'
Optional autoReset sorting when data is changed.
true
Optional defaultEnable sorting for all columns, regardless if they have a valid accessor.
false
Optional disableDisables multi-sorting for the entire table.
false
Optional disableDisable sorting for table.
false
Optional disableIf true, the un-sorted state will not be available to columns once they have been sorted.
false
Optional disabledIf true, the un-sorted state will not be available to multi-sorted columns.
false
Optional initialInitial settings of sorting. List of objects containing column id and order preference.
{ sortBy: [{ id: 'columnsId', desc: false }] }
Optional isAllows to override default multi-sort detection behaviour. Receives mouse-event as param.
Optional manualManual sorting with custom logic, eg. server-side.
false
orderByFn
Optional maxLimit on max number of columns for multi-sort.
Infinite
Optional onCallback executed when columns are sorted. The function must be wrapped in useCallback hook.
Optional orderOptional sortAllows overriding or adding additional sort types for columns to use. If a column's sort type isn't found on this object, it will default to using the built-in sort types. Must be memoised.
Generated using TypeDoc
Type interface for sorting options.