IDataTableProvideSelection

interface
Component Props

Internal provide/inject contract for row-selection state in <OrigamDataTable> — exposes selection helpers and computed flags consumed by checkboxes, header select-all and slot children.

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.

toggleSelect
requis
(item: IDataTableSelectableItem) => void
Toggles the selection state of a single item.
select
requis
(items: Array<IDataTableSelectableItem>, value: boolean) => void
Sets the selection state of an array of items to value.
selectAll
requis
(value: boolean) => void
Selects or deselects all selectable items on the current page (or all items, depending on selectStrategy).
isSelected
requis
(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
Returns true when every passed item is currently selected.
isSomeSelected
requis
(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
Returns true when at least one of the passed items is selected.
someSelected
requis
ComputedRef<boolean>
Reactive flag — true when at least one row is selected (drives the indeterminate state of the header checkbox).
allSelected
requis
ComputedRef<boolean>
Reactive flag — true when all selectable rows are selected.
showSelectAll
requis
ComputedRef<boolean>
Reactive flag — controls whether the select-all checkbox is rendered in the header.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Injecting selection helpers in a child component

typescript