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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- indexrequirednumber
- Position of this group header in the rendered row list.
- itemrequiredT
- The raw group descriptor (IDataTableGroup by default).
- internalItemrequiredIDataTableItem<T>
- The resolved internal item wrapping the group for selection/expansion APIs.
- columnsrequiredIInternalDataTableHeader[]
- Flattened column definitions, used to render the correct number of cells.
- isSelectedrequired(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
- Returns true when all given items are currently selected.
- toggleGrouprequired(group: IDataTableGroup) => void
- Opens or closes the given group.
- isExpandedrequired(item: IDataTableItem) => boolean
- Returns true when the given row is currently expanded.
- toggleExpandrequired(item: IDataTableItem) => void
- Toggles the expanded state of the given row.
- toggleSelectrequired(item: IDataTableSelectableItem) => void
- Toggles the selected state of the given item.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom group header using slot props