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.
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.
- toggleSelectrequis(item: IDataTableSelectableItem) => void
- Toggles the selection state of a single item.
- selectrequis(items: Array<IDataTableSelectableItem>, value: boolean) => void
- Sets the selection state of an array of items to value.
- selectAllrequis(value: boolean) => void
- Selects or deselects all selectable items on the current page (or all items, depending on selectStrategy).
- isSelectedrequis(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
- Returns true when every passed item is currently selected.
- isSomeSelectedrequis(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
- Returns true when at least one of the passed items is selected.
- someSelectedrequisComputedRef<boolean>
- Reactive flag — true when at least one row is selected (drives the indeterminate state of the header checkbox).
- allSelectedrequisComputedRef<boolean>
- Reactive flag — true when all selectable rows are selected.
- showSelectAllrequisComputedRef<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