IDataTableItemBase

interface
Data Display

Base shape shared by all row slot contexts in <OrigamDataTable> — provides the row index, raw item, its resolved internal item, and handlers for expand and select.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

index
required
number
Zero-based position of this row in the rendered items list.
item
required
T
The raw data object for this row.
internalItem
required
IDataTableItem<T>
The resolved internal item wrapping the raw object with computed key, columns map, and selection/expansion flags.
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.
isSelected
required
(items: IDataTableSelectableItem | Array<IDataTableSelectableItem>) => boolean
Returns true when all given items are currently selected.
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.

Row slot using IDataTableItemBase handlers

vue