IDataTableItemsProps

interface
Component Props

Configures the items data source of <OrigamDataTable> — the items array, the key extractor, the selectability resolver and per-row/cell prop factories.

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.

items
Array<any>
Array of data objects to display, one per row.
itemValue
TSelectItemKey
Property path (or function) used to derive the unique key for each item — required for selection and expansion tracking.
itemSelectable
TSelectItemKey
Property path (or function) that returns a boolean indicating whether a row can be selected.
rowProps
TDataTableRow<any>
Object or function returning extra props (class, style, data-*…) merged onto each <tr> root element.
cellProps
TDataTableCell<any>
Object or function returning extra props merged onto each <td> cell element.
returnObject
boolean
When true, v-model:modelValue and select events return the full raw object instead of the extracted itemValue.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

DataTable with custom itemValue and rowProps

vue