> ## Documentation Index
> Fetch the complete documentation index at: https://anvil.servicetitan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List – Design

> Lists display ordered or unordered content with consistent typography and spacing.

export const LiveCode = ({children, customHeight, clickToLoad, example, fullWidth, fullHeight, hideCodeInLiveCode, screenshot, screenshotOnly, showCode: showCodeProp}) => {
  const SCREENSHOTS_BASE = "https://servicetitan.github.io/anvil2-docs-live-code/screenshots";
  const STACKBLITZ_BASE = "https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples";
  const [showCodeBlock, setShowCodeBlock] = useState(showCodeProp ?? false);
  const [isLocalOverride, setIsLocalOverride] = useState(false);
  useEffect(() => {
    const examplePath = `/images/live-code-screenshots-tmp/${example}.png`;
    fetch(examplePath, {
      method: "HEAD"
    }).then(r => {
      if (r.ok) setIsLocalOverride(true);
    }).catch(() => {});
  }, [example]);
  const screenshotBase = isLocalOverride ? "/images/live-code-screenshots-tmp" : SCREENSHOTS_BASE;
  if (screenshotOnly) {
    return <Frame className="flex flex-col">
        <div className="flex dark:hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#FFFFFF"
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>
        <div className="hidden dark:flex" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined,
      background: "#141414"
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>
      </Frame>;
  }
  if (screenshot) {
    return <Frame className="flex flex-col -mb-2">
        <div className="flex dark:hidden bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}.png, ${screenshotBase}/${example}-2x.png 2x`} src={`${screenshotBase}/${example}.png`} alt={example} noZoom />
        </div>

        <div className="hidden dark:flex bg-white dark:bg-codeblock border border-gray-950/10 dark:border-white/10 dark:twoslash-dark rounded-2xl overflow-hidden" style={{
      background: "#141414",
      justifyContent: "center",
      alignItems: "center",
      width: fullWidth ? "100%" : "50%",
      minHeight: fullHeight ? "284px" : undefined
    }}>
          <img srcset={`${screenshotBase}/${example}-dark.png, ${screenshotBase}/${example}-dark-2x.png 2x`} src={`${screenshotBase}/${example}-dark.png`} alt={example} noZoom />
        </div>

        <div className="flex justify-end items-center text-xs py-2 px-1 gap-4">
          {!showCodeProp ? <button className="inline-flex justify-end items-center text-gray-700 dark:text-gray-50 hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1 cursor-pointer" onClick={() => setShowCodeBlock(!showCodeBlock)} style={{
      appearance: "none"
    }}>
              <Icon icon="code" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
              <span>{showCodeBlock ? "Hide code" : "Show code"}</span>
            </button> : null}

          <a className="inline-flex justify-end items-center hover:text-blue-500 dark:hover:text-blue-300 transition-colors group self-end gap-1" href={`${STACKBLITZ_BASE}/${example}?file=src/App.tsx`} target="_blank" rel="noreferrer">
            <Icon icon="bolt" size="12px" className="group-hover:bg-blue-500 dark:group-hover:bg-blue-300" />
            <span>StackBlitz demo</span>
          </a>
        </div>

        <div className="grid transition-[grid-template-rows] duration-300 ease-in-out overflow-auto overflow-y-hidden overflow-x-auto" style={showCodeBlock ? {
      gridTemplateRows: "1fr"
    } : {
      gridTemplateRows: "0fr"
    }}>
          <div style={{
      minHeight: 0,
      overflowX: "auto",
      overflowY: "hidden",
      marginBlockStart: "-1.25rem",
      marginBlockEnd: "-1.5rem"
    }}>
            {children}
          </div>
        </div>
      </Frame>;
  } else {
    return <div style={{
      display: "flex",
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px",
      resize: "vertical",
      overflow: "auto"
    }}>
        <iframe title={example} style={{
      flex: 1,
      width: fullWidth ? "100%" : "50%",
      minHeight: customHeight ? customHeight : "316px"
    }} src={`${STACKBLITZ_BASE}/${example}?embed=1&hideNavigation=1&hideExplorer=1&terminalHeight=0&file=src/App.tsx${clickToLoad ? "&ctl=1" : ""}${hideCodeInLiveCode ? "&view=preview" : ""}`} allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking" sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts" />
      </div>;
  }
};

## Anatomy

The List consists of two primary elements that work together to present content in a structured format.

1. **List container** – The wrapper that renders as either an unordered list (`ul`) or ordered list (`ol`), applying typography and spacing from the design system.
2. **List item** – Individual items within the list, rendered as `li` elements.

## Options

The List supports the following configurations to accommodate various content and layout scenarios.

### Variant

Lists can be unordered (bullets) or ordered (numbers). Use unordered lists for items without sequence; use ordered lists for steps, rankings, or sequence-dependent content.

<LiveCode example="list-design-variant" screenshot fullWidth />

| Variant   | Use case                            |
| --------- | ----------------------------------- |
| Unordered | Bullet points, non-sequential items |
| Ordered   | Steps, rankings, numbered items     |

### Size

Typography size aligns with the design system paragraph scale. Size affects readability and hierarchy when lists appear alongside other content.

<LiveCode example="list-design-size" screenshot fullWidth />

| Size   | Description                    |
| ------ | ------------------------------ |
| Small  | Compact content or dense UIs   |
| Medium | Default body size              |
| Large  | Emphasis or larger text blocks |

### Nesting

Lists support nesting. Place a List inside a List item to create sub-lists (for example, an ordered sub-list inside an unordered parent).

<LiveCode example="list-nested" screenshot fullWidth />

## Behavior

The List responds to the chosen variant and size without interactive states. It renders semantic HTML so screen readers announce list structure and item count correctly.

## Usage Guidelines

Use the List when presenting content as a series of items that benefit from list semantics and design system styling.

### When to Use

* Displaying bullet points or numbered steps in body content.
* Outlining options, features, or requirements.
* Showing sequential instructions or ordered criteria.
* Grouping related items with clear visual hierarchy.

### When not to use

* **Selectable options** – Use [Listbox](/docs/web/components/listbox/design) or [Menu](/docs/web/components/menu/design) for user selection.
* **Data grids or tables** – Use [ListView](/docs/web/components/list-view/design) or [Data Table](/docs/web/components/data-table/design) for tabular or multi-column data.

### How to Use

Use `List` with `List.Item` for each entry. Set `variant="ordered"` for numbered lists; omit it or set `variant="unordered"` for bullet lists.

<LiveCode example="list-design-do" screenshot fullWidth />

<Check>**Do**</Check>

Use List for presentational lists with correct semantic markup.

<Danger>**Don't**</Danger>

Don't use List for interactive selection; use [Listbox](/docs/web/components/listbox/design) or [Menu](/docs/web/components/menu/design) instead.

## Content

Content within each List item should be concise and scannable. Keep items parallel in structure where possible. For ordered lists, use clear step or sequence language.

## Keyboard Interaction

Users can navigate the List using standard keyboard controls. Lists are not focusable as a single widget; focus moves through interactive elements inside items if present. Semantic list markup supports screen reader navigation (e.g., list length and position announcements).
