IListGroupProps

interface
Data Display

Props for <OrigamListGroup> — a collapsible group inside a list. Supports expand/collapse icons, title, value binding, fluid mode, and the full color, spacing, border, rounded, adjacent and hover surfaces.

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.

collapseIcon
TIcon
Icon shown in the activator when the group is open (collapsed state arrow).
expandIcon
TIcon
Icon shown in the activator when the group is closed (expand state arrow).
fluid
boolean
Removes the indentation from nested items when true, making them flush with the group activator.
title
string
Text title rendered inside the default activator.
value
any
Value used as the group identifier for open-state tracking via v-model:opened on the parent list.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Nested list group with custom icons

vue