IDataTableSortProps
interface
Data Table
Props controlling the sort state of a data table — active sort keys, a custom comparator, multi-column sort, and the mustSort constraint.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- sortByArray<IDataTableSortItem>
- Array of sort descriptors (key + optional direction) currently active on the table.
- customKeySortTDataTableCompareFunction
- Custom comparator function called instead of the default string/number sort when sorting by a given column key.
- multiSortboolean
- Allow the user to sort by multiple columns simultaneously.
- mustSortboolean
- Prevent the sort from being cleared — once a column is sorted it cycles between asc and desc only.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Binding sort props on a data table