Function: column_getToggleSortingHandler()#

function column_getToggleSortingHandler<TFeatures, TData, TValue>(column): (e) => void;

function column_getToggleSortingHandler<TFeatures, TData, TValue>(column): (e) => void;

Defined in: features/row-sorting/rowSortingFeature.utils.ts:468

Creates a header event handler that toggles this column's sorting.

The handler ignores events when the column cannot sort, persists React-style synthetic events when present, and asks options.isMultiSortEvent whether the event should add to a multi-sort.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column_Internal<TFeatures, TData, TValue>

Returns#

(e): void;

(e): void;

Parameters#

e#

unknown

Returns#

void

Example#

const onClick = column_getToggleSortingHandler(column)

const onClick = column_getToggleSortingHandler(column)