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.
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.
- activeboolean
- Forces the item into its active / selected visual state.
- activeClassstring
- CSS class applied when the item is in its active state.
- disabledboolean
- Makes the item non-interactive and visually muted.
- linesTLines
- Controls the number of title/subtitle lines before text truncation.
- linkboolean
- Renders the item as an anchor if true, even when no href is provided.
- navboolean
- Applies navigation-specific styling (compact density, rounded corners).
- slimboolean
- Reduces the item padding for denser navigation contexts.
- subtitlestring | number
- Secondary text rendered below the title.
- titlestring | number
- Primary text label rendered in the item.
- valueany
- 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