IDataTableGroupHeaderRowProps

interface
Component Props

Props for the group header row component in <OrigamDataTable> — carries the group item, its resolved internal item, column definitions, and handlers for expand/select/group-toggle interactions.

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

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

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.

index
requis
number
Position of this group header in the rendered row list.
item
requis
T
The raw group descriptor (IDataTableGroup by default).
internalItem
requis
IDataTableItem<T>
The resolved internal item wrapping the group for selection/expansion APIs.
columns
requis
IInternalDataTableHeader[]
Flattened column definitions, used to render the correct number of cells.
isSelected
requis
(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
Returns true when all given items are currently selected.
toggleGroup
requis
(group: IDataTableGroup) => void
Opens or closes the given group.
isExpanded
requis
(item: IDataTableItem) => boolean
Returns true when the given row is currently expanded.
toggleExpand
requis
(item: IDataTableItem) => void
Toggles the expanded state of the given row.
toggleSelect
requis
(item: IDataTableSelectableItem) => void
Toggles the selected state of the given item.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

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

Custom group header using slot props

vue