IListItemProps

interface
Data Display

Props for <OrigamListItem> — a single item row inside a list. Covers activation state, disabled state, link navigation, density, dimension, elevation, multiline lines, and the full adjacent (prepend/append) surface.

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.

active
boolean
Forces the item into its active / selected visual state.
activeClass
string
CSS class applied when the item is in its active state.
disabled
boolean
Makes the item non-interactive and visually muted.
lines
TLines
Controls the number of title/subtitle lines before text truncation.
link
boolean
Renders the item as an anchor if true, even when no href is provided.
nav
boolean
Applies navigation-specific styling (compact density, rounded corners).
slim
boolean
Reduces the item padding for denser navigation contexts.
subtitle
string | number
Secondary text rendered below the title.
title
string | number
Primary text label rendered in the item.
value
any
Value registered with the parent ItemGroup for selection tracking.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

List item with icon prepend and subtitle

vue