structyl

List

stable

A vertical list of items and actions.

Basic usage

  • Inbox

Examples

Navigation list

Use ItemButton for selectable or clickable rows.

  • Workspace

Static list items

Use Item and ItemText for semantic list content that is not clickable.

  • Build completed
  • Deploy queued

Dense rows and slots

List includes item icon, avatar, text, secondary action, selected, divider and dense props.

  • Inbox

Features

  • Compound list parts.
  • Button rows.

Installation

bash
pnpm dlx structyl add list

API Reference

List.Root

List container.

PropTypeDefault
denseboolean

Compact item density.

false
disablePaddingboolean

Remove root padding.

false
classNamestring

Additional Tailwind classes merged with the component defaults.

List.Item

List item.

PropTypeDefault
disablePaddingboolean

Remove item padding.

false
dividerboolean

Show bottom divider.

false
classNamestring

Additional Tailwind classes merged with the component defaults.

List.ItemButton

Clickable list row.

PropTypeDefault
selectedboolean

Selected styling.

false
denseboolean

Compact row.

false
disabledboolean

Disable row.

false
alignItems'center' | 'flex-start'

Row alignment.

'center'
classNamestring

Additional Tailwind classes merged with the component defaults.

List.ItemText

Primary and secondary text.

PropTypeDefault
primary | secondaryReact.ReactNode

Text slots.

insetboolean

Align text with icon rows.

false
classNamestring

Additional Tailwind classes merged with the component defaults.

List.ItemIcon / ItemAvatar / ItemSecondaryAction / Subheader

Additional list slots.

PropTypeDefault
classNamestring

Additional Tailwind classes merged with the component defaults.

List | structyl