IDataTableGroupHeaderSlot
interface
Component Slots
Slot props injected into the #group-header slot of <OrigamDataTable> — extends IDataTableItemBase with the group item, column list, and group-open/select/expand handlers.
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 list.
- itemrequiredT
- The group descriptor (IDataTableGroup by default).
- columnsrequiredIInternalDataTableHeader[]
- Flattened column definitions.
- isExpandedrequired(item: IDataTableItem) => boolean
- Returns true when the given row is expanded.
- toggleExpandrequired(item: IDataTableItem) => void
- Toggles row expansion.
- isSelectedrequired(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
- Returns true when all given items are selected.
- toggleSelectrequired(item: IDataTableSelectableItem) => void
- Toggles row selection.
- toggleGrouprequired(group: IDataTableGroup) => void
- Opens or closes the group.
- isGroupOpenrequired(group: IDataTableGroup) => boolean
- Returns true when the group is currently open (expanded).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Rendering a custom group header row