IItemProps

interface
Data Display

Data source props shared by list and select components. Defines how raw items array is normalised — which keys to use for title, value, children, and additional props.

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 raw items to display.
itemTitle
TSelectItemKey
Key or function used to extract the display title from each item.
itemValue
TSelectItemKey
Key or function used to extract the comparable value from each item.
itemChildren
TSelectItemKey
Key or function used to extract nested children items.
itemProps
TSelectItemKey
Key or function used to extract additional props forwarded to each list item component.
returnObject
boolean
When true, the model value is the full raw item object instead of the extracted itemValue.
valueComparator
typeof deepEqual
Custom equality function used for selection comparison. Defaults to deep equality.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom item key mappings

vue