SortSettings

Configures sorting behavior in the Data Grid component. Manages settings for enabling sorting, defining sorted columns, and controlling sort persistence. Determines how to interact with column sorting via headers or programmatically.

Props

The following table outlines the props for the SortSettings:

NameTypeDefaultDescription
allowUnsort
boolean
true

Determines whether clicking a sorted column header can clear its sort state. When false, prevents the grid from remove the sorting a column, maintaining the sort order. When true, allows toggling to an unsorted state. Affects user interaction with sorted column headers.

columns
SortDescriptor[]
[ ]

Contains an array of SortDescriptor objects to define initial or active sort conditions. Specifies which columns are sorted and in what direction at grid initialization or during runtime. Enables pre-sorting data or retrieving the current sort state.

enabled
boolean
false

Enables or disables sorting functionality for grid columns. When true, allows to sort data by clicking column headers, with support for multiple columns using the Ctrl key. When false, disables all sorting interactions and programmatic sorting.

mode
string | SortMode
'Multiple'

Specifies whether sorting is restricted to a single column or allows multiple columns. Supports Single for sorting one column at a time or Multiple for sorting multiple columns simultaneously. Influences the grid’s sorting behavior and user experience.