List

List primitives for structured textual content.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { List } from "@tavojs/ui/list";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/list.

When to use

Use it when

Use `List` and `ListItem` for structured prose lists

Choose something else when

Avoid List when replacing interactive controls with content-only components.

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

List example

TSXCreate: src/components/examples/ListExample1.tsx

tsximport { List } from "@tavojs/ui/list";
import { ListItem } from "@tavojs/ui";

export function ListExample1() {
  return (
    <>
      <List marker="secondary">
        <ListItem title="Theme">Generated tokens.</ListItem>
      </List>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`ordered`	`boolean`	—	Configures ordered for this component.
`marker`	`Tone`	—	Configures marker for this component.
`spacing`	`"sm" \| "md" \| "lg"`	—	Configures spacing for this component.
`ListItem.title`	`Child`	—	Configures ListItem.title for this component.
`ListItem.meta`	`Child`	—	Configures ListItem.meta for this component.

Complete TypeScript API

Import from @tavojs/ui/list. Published exports: List, ListItem, ListItemProps, ListProps, ListRoot.

`ListProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by List.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by List.
`id`	`string`	No	Inherited id attribute accepted by List.
`role`	`string`	No	Inherited role attribute accepted by List.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by List.
`title`	`string`	No	Inherited title attribute accepted by List.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by List.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by List.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by List.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by List.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by List.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by List.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by List.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by List.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by List.
`ordered`	`boolean`	No	Configures ordered for this component.
`marker`	`Tone`	No	Configures marker for this component.
`spacing`	`"sm" \| "md" \| "lg"`	No	Configures spacing for this component.

`ListItemProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by List.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by List.
`id`	`string`	No	Inherited id attribute accepted by List.
`role`	`string`	No	Inherited role attribute accepted by List.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by List.
`title`	`string & Child`	No	Inherited title attribute accepted by List.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by List.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by List.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by List.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by List.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by List.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by List.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by List.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by List.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by List.
`meta`	`Child`	No	Inherited meta attribute accepted by List.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

Public compound members: Root, Item

Limitations

Avoid List when replacing interactive controls with content-only components.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Content components should keep meaningful text and media alternatives available to assistive technology.

Provide alt text for meaningful images.
Use semantic text variants for headings and paragraphs.
Do not hide essential content visually unless VisuallyHidden is intentional.

Component status

Contract	Current value
Maturity	stable
Category	content
Component import	`@tavojs/ui/list`
Explicit CSS import	`@tavojs/ui/css/list`
Preview	Interactive preview available on this page