IDataListKVItem
interface
Data Display
Shape of a single key/value row when <OrigamDataList> runs in mode="kv". The key is the visible label in the <dt> cell; the value fills the <dd> cell as plain text, a VNode, or an IDataListKVItemValueComponent descriptor.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- keyrequiredstring
- Visible label rendered in the <dt> cell. Also kebab-cased to build the row data-cy selector.
- valuerequiredstring | number | VNode | IDataListKVItemValueComponent
- Value rendered in the <dd> cell. Plain text or number is rendered as-is; VNode is rendered directly; IDataListKVItemValueComponent is resolved via <component :is>.
- idstring | number
- Optional stable row id. Falls back to key when omitted — supply your own when keys may repeat across instances.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Key/value list with a chip as value