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.

typescript

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.

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

vue