IListSubheader
interface
Data Display
Props for <OrigamListSubheader> — a non-interactive section header rendered inside a list. Supports inset alignment, sticky positioning, an optional title, and the full color, spacing, border, and 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.
- insetboolean
- Indents the subheader to align with inset list items (items that have a prepend icon or avatar).
- stickyboolean
- Makes the subheader sticky so it stays visible while scrolling through its section.
- titlestring
- Text label rendered as the subheader. Overridden by the default slot.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Sticky inset subheader