SortHandler

Since v0.2.7

Custom sort handler function signature.

Caution

Prefer BaseColumnConfig.sortComparator over SortHandler. sortHandler is bypassed by MultiSortPlugin and only sees the single active sort field. For per-column custom sort logic that survives every sort code path (core, multi-sort, tree, server-side), set sortComparator on the relevant columns instead. For server-side sort, use ServerSideConfig.dataSource.

Use SortHandler only when you need to replace the grid’s sort engine wholesale.

type SortHandler = (rows: TRow[], sortState: SortState, columns: ColumnConfig<TRow>[]) => TRow[] | Promise<TRow[]>

Example

// Replace the built-in sort with a third-party stable sort library
const customSortHandler: SortHandler<Employee> = (rows, state) => {
  return thirdPartyStableSort(rows, state.field, state.direction);
};

grid.gridConfig = { sortHandler: customSortHandler };

See Also

• SortState for the sort state object
• GridConfig.sortHandler for configuring the handler (and its caveats)
• BaseColumnConfig.sortComparator — recommended per-column comparator