0
Fork 0
mirror of https://github.com/TanStack/table.git synced 2026-11-18 18:55:54 +00:00
table/docs/reference/static-functions/functions/column_toggleSorting.md
Kevin Van Cott 87c6bcc52a
feat(table-core): Further improve tree-shaking across features (#6626)
* feat(table-core): Further improve tree-shaking across features

Keep column ordering, column pinning, and row expanding code out of the
core bundle, route more cross-feature reads through feature stubs, and
stop allocating unused onAfterUpdate wrappers in production memos.

* refactor(table-core): register internal cross-feature fns as table APIs

Replace init*InstanceData function storage with @internal table APIs
registered via assignTableAPIs, route faceting through the
getCanGlobalFilter stub, and enforce feature boundaries with
import/no-restricted-paths. Regenerate reference docs and fix stale
docs config links.

---------
2026-10-12 09:51:47 -05:00

1.1 KiB

id title
column_toggleSorting column_toggleSorting
function column_toggleSorting<TFeatures, TData, TValue>(
   column,
   desc?,
   multi?): void;

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

Applies the next sorting state for this column.

The toggle can add, replace, flip, or remove this column's sort entry. Multi sorting respects enableMultiSort, enableMultiRemove, maxMultiSortColCount, and the multi argument.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

column

Column_Internal<TFeatures, TData, TValue>

desc?

boolean

multi?

boolean

Returns

void

Example

column_toggleSorting(column, undefined, true)