Astryx Design System

useTableSortable@astryxdesign/core v0.0.15 · useTableSortable

Usage

Headless multi-sort plugin for Table. The consumer owns sort state and provides a callback. Shift+click enables secondary sort columns. Sort indicators render in header cells automatically.

ts
import {useTableSortable} from '@astryxdesign/core/Table'

Parameters

Param	Type	Description
sortrequired	TableSortState<TSortKey>	Current sort state. Ordered array of {sortKey, direction} entries. First entry is the primary sort.
onSortChangerequired	(sort: TableSortState<TSortKey>) => void	Called when the user clicks a header cell to change sort.
allowUnsortedState	boolean (default: false)	Allow cycling back to unsorted. When true: asc, desc, unsorted. When false: asc, desc, asc.
isMultiSortEnabled	boolean (default: false)	Enable multi-sort via Shift+click. Regular click still replaces the entire sort state.

Examples

Common configurations, variations, and states.

Table — Sortable Columns

Table with sortable columns, click headers to sort ascending or descending.