structyl

The full prop reference for the List component. A vertical list of items and actions.

Import

tsx
import { List } from '@structyl/styled';

Props

List.Root

List container.

PropTypeDefault
dense#boolean

Compact item density.

false
disablePadding#boolean

Remove root padding.

false
className#string

Additional Tailwind classes merged with the component defaults.

List.Item

List item.

PropTypeDefault
disablePadding#boolean

Remove item padding.

false
divider#boolean

Show bottom divider.

false
className#string

Additional Tailwind classes merged with the component defaults.

List.ItemButton

Clickable list row.

PropTypeDefault
selected#boolean

Selected styling.

false
dense#boolean

Compact row.

false
disabled#boolean

Disable row.

false
alignItems#'center' | 'flex-start'

Row alignment.

'center'
className#string

Additional Tailwind classes merged with the component defaults.

List.ItemText

Primary and secondary text.

PropTypeDefault
primary | secondary#React.ReactNode

Text slots.

inset#boolean

Align text with icon rows.

false
className#string

Additional Tailwind classes merged with the component defaults.

List.ItemIcon / ItemAvatar / ItemSecondaryAction / Subheader

Additional list slots.

PropTypeDefault
className#string

Additional Tailwind classes merged with the component defaults.

Source code

If you didn't find what you need here, read the component implementation .

structyl — Accessible React Component Library