IListProps
interface
Data Display
Props for <OrigamList> — the primary list container. Accepts a data-driven items array or manual list item children. Supports expand/collapse icons, nested items via INestedProps, density, elevation, dimension, and the full color/spacing/border/rounded 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.
- activeClassstring
- CSS class applied to the active list item.
- disabledboolean
- Disables all interactions for the entire list.
- expandIconstring
- Icon shown on group activators when the group is collapsed.
- collapseIconstring
- Icon shown on group activators when the group is expanded.
- linesTLines
- Default line count for item text truncation — one, two, or three.
- slimboolean
- Reduces item padding for denser navigation contexts.
- navboolean
- Applies navigation-specific styling (compact density, rounded corners on items).
- itemTypestring
- Key used to read the item type discriminator from each raw item object.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Navigation list with nested groups