IDataTableProvideExpanded

interface
Component Props

Internal provide/inject contract for row expansion state in <OrigamDataTable> — exposes the expanded set and helpers for child components (expand row, virtual row, footer) to query and toggle expansion.

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.

expand
required
(item: IDataTableItem, value: boolean) => void
Imperatively sets the expansion state of the given item to value.
expanded
required
TVModel<IDataTableExpandProps, 'expanded', Set<string>>
Reactive set of expanded item keys, kept in sync with the v-model:expanded prop.
expandOnClick
required
Ref<boolean | undefined>
Reactive flag mirroring the expandOnClick prop — when true, clicking a row toggles its expansion.
isExpanded
required
(item: IDataTableItem) => boolean
Returns true when the given item is currently in the expanded set.
toggleExpand
required
(item: IDataTableItem) => void
Toggles the expansion 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.

Expand row programmatically via inject

typescript