IDataTableProvideSort

interface
Component Props

Internal provide/inject contract for column-sort state in <OrigamDataTable> — exposes the current sortBy array and helpers used by column headers to query and toggle sort order.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

sortBy
requis
Ref<Array<IDataTableSortItem>>
Reactive array of active sort descriptors — each entry has a key and an optional direction.
toggleSort
requis
(column: IInternalDataTableHeader) => void
Cycles through the sort states for the given column (none → asc → desc → none when mustSort is false).
isSorted
requis
(column: IInternalDataTableHeader) => boolean
Returns true when the given column has an active sort entry in sortBy.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Accessing sort state in a custom header slot

vue