IDataItem

interface
Data Display

Shape of a single item when <OrigamDataList> runs in its default "avatar" mode — a title descriptor (IDataTitleProps) and an array or keyed map of text rows (IDataTextProps), both optional, plus all IAdjacentProps for prepend/append slots.

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.

title
IDataTitleProps
Title descriptor rendered as a <dt> cell above the text rows.
text
Array<IDataTextProps> | { [key: string]: IDataTextProps }
One or more text row descriptors rendered as <dd> cells below the title.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Passing items in avatar mode

vue