> ## 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.

# Breadcrumbs – Design

> Breadcrumbs represent the hierarchy of an app that users can navigate through.

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>;
  }
};

export const CodePreviewPlaceholder = ({double, fullWidth}) => {
  const single = <div style={{
    width: fullWidth ? "100%" : "50%",
    borderRadius: "1rem",
    display: "flex",
    padding: "1rem",
    flexDirection: "column",
    gap: "0.5rem",
    height: "10rem",
    marginBlockEnd: "1rem"
  }} className="border-width-default border-color-subdued">
      <div className="bg-strong border-radius-large" style={{
    width: "100%",
    flexGrow: "1"
  }} />
      <div className="bg-strong border-radius-large" style={{
    width: "100%",
    flexGrow: "1"
  }} />
    </div>;
  return double ? <div style={{
    display: "flex",
    gap: "1rem"
  }}>
      {single}
      {single}
    </div> : single;
};

<Frame>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
    <img noZoom src="https://mintcdn.com/servicetitan/H5FwKyiqhPVZ1UJQ/images/docs/web/components/shared/overview-of-breadcrumbs.png?fit=max&auto=format&n=H5FwKyiqhPVZ1UJQ&q=85&s=5104e26909437378c7b33fbddb4032bd" width="592" height="106" data-path="images/docs/web/components/shared/overview-of-breadcrumbs.png" />
  </div>
</Frame>

## Anatomy

The Breadcrumbs consists of three primary elements that work together to represent navigation hierarchy.

<Frame>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
    <img
      src="https://mintcdn.com/servicetitan/Ni0bXIw9diilEZPZ/images/docs/web/components/breadcrumbs/design/anatomy-of-breadcrumbs.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=ee976cbf60732da05e21bc6352af0a45"
      alt="Anatomy of
Breadcrumbs"
      width="576"
      height="164"
      data-path="images/docs/web/components/breadcrumbs/design/anatomy-of-breadcrumbs.png"
    />
  </div>
</Frame>

1. Breadcrumb item link
2. Separator
3. Current page

## Options

The Breadcrumbs supports one configuration that shows each Breadcrumb Item as a link, with the last item representing the current page.

### Default

<LiveCode example="breadcrumbs-playground" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.Link>Home Page</Breadcrumbs.Link>
        <Breadcrumbs.Link>Sub Page</Breadcrumbs.Link>
        <Breadcrumbs.Link>Current Page</Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

Breadcrumbs have one configuration. Each Breadcrumb Item displays as a link, and the last Breadcrumb Item represents the current page.

## Behavior

The Breadcrumbs responds to navigation interactions and overflow scenarios while maintaining clear hierarchy representation.

### Visual States

<LiveCode example="breadcrumbs-data-interactive" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs, Flex } from "@servicetitan/anvil2";

  function App() {
    return (
      <Flex gap="6" direction="column" alignItems="baseline">
        <Breadcrumbs>
          <Breadcrumbs.Link href="#">Default Breadcrumb</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Current Page</Breadcrumbs.Link>
        </Breadcrumbs>

        <Breadcrumbs>
          <Breadcrumbs.Link href="#" data-interactive="hover">
            Hover Breadcrumb
          </Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Current Page</Breadcrumbs.Link>
        </Breadcrumbs>

        <Breadcrumbs>
          <Breadcrumbs.Link href="#" data-interactive="active">
            Active Breadcrumb
          </Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Current Page</Breadcrumbs.Link>
        </Breadcrumbs>

        <Breadcrumbs>
          <Breadcrumbs.Link href="#" data-interactive="focus-visible">
            Focus Visible Breadcrumb
          </Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Current Page</Breadcrumbs.Link>
        </Breadcrumbs>
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

Note that the last Breadcrumb item, the current page, is not interactive, and has no additional visual states.

### Interactions

All Breadcrumb items except the last item are links. Do not place items that cannot be represented as navigational elements in the Breadcrumbs.

### Breadcrumb Group Overflow

<LiveCode example="breadcrumbs-overflow" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs, Flex } from "@servicetitan/anvil2";

  function App() {
    return (
      <Flex
        gap="6"
        direction="column"
        alignItems="baseline"
        style={{ maxWidth: "30rem" }}
      >
        <Breadcrumbs>
          <Breadcrumbs.Link href="#">Item 1</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 2</Breadcrumbs.Link>
        </Breadcrumbs>

        <Breadcrumbs>
          <Breadcrumbs.Link href="#">Item 1</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 2</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 3</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 4</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 5</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 6</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 7</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 8</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 9</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 10</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 11</Breadcrumbs.Link>
          <Breadcrumbs.Link href="#">Item 12</Breadcrumbs.Link>
        </Breadcrumbs>
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

### Breadcrumb Item Overflow

<LiveCode example="breadcrumbs-link-overflow" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs style={{ maxWidth: "30rem" }}>
        <Breadcrumbs.Link href="#">Item 1</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Longer Item</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">
          This is a very long item to show what happens when one individual
          Breadcrumb item is incredibly long for some reason
        </Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Item 4</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Item 5</Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

## Usage Guidelines

### When to Use

Use Breadcrumbs when the product area has a multi-level hierarchy that allows users to understand and navigate the product hierarchy.

### When not to use

Do not use Breadcrumbs when:

* There is no hierarchical relation to display
* Users cannot navigate through the hierarchy displayed in a Breadcrumb
* A user is in a linear flow. Use a [Stepper](/docs/web/components/stepper/design) instead.

### How to Use

#### Only use Breadcrumbs to represent the site hierarchy

Use Breadcrumbs only to represent the hierarchy of the site or product area. This is sometimes known as location-based Breadcrumbs.

Do not use Breadcrumbs to denote path-based behavior, where Breadcrumb content is dynamically generated based on the path users took to get to a page.

<LiveCode example="breadcrumbs-hierarchy-do" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.Link href="/web">Web</Breadcrumbs.Link>
        <Breadcrumbs.Link href="/web/components">Components</Breadcrumbs.Link>
        <Breadcrumbs.Link href="/web/components/breadcrumbs">
          Breadcrumbs
        </Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

<Check>**Do** Example using this doc site to show the site hierarchy.</Check>

<LiveCode example="breadcrumbs-hierarchy-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.Link href="/web/components/buttons">Button</Breadcrumbs.Link>
        <Breadcrumbs.Link href="/web/patterns/forms">Forms</Breadcrumbs.Link>
        <Breadcrumbs.Link href="/web/components/breadcrumbs">
          Breadcrumbs
        </Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

<Danger>**Don't** Example of a hypothetical user session arriving to the same page. Breadcrumbs should not be used this way.</Danger>

#### Always show the current page in the Breadcrumbs

When using Breadcrumbs, always represent the current page in the Breadcrumbs, even if the page title shows the same content.

<LiveCode example="breadcrumbs-current-page-do" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.Link href="#">Item 1</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Item 2</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Current page</Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

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

<LiveCode example="breadcrumbs-current-page-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Breadcrumbs } from "@servicetitan/anvil2";

  function App() {
    return (
      <Breadcrumbs>
        <Breadcrumbs.Link href="#">Item 1</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#">Item 2</Breadcrumbs.Link>
        <Breadcrumbs.Link href="#"></Breadcrumbs.Link>
      </Breadcrumbs>
    );
  }

  export default App;
  ```
</LiveCode>

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

#### Always provide navigation within Breadcrumbs

Breadcrumb items always have a link to navigate. If part of the hierarchy lacks a link, do not include it in the Breadcrumb trail. The trailing Breadcrumb item, the current page, does not display its own link.

#### Skip the Breadcrumbs for the top-level item

The top-most part of the Breadcrumb hierarchy does not need to display the Breadcrumbs directly. For example, if the first Breadcrumb item was a "Settings" page, the actual Settings page would not show the Breadcrumb.

## Content

Content within the Breadcrumbs should clearly represent the navigation hierarchy through descriptive labels.

## Keyboard Interaction

Users can navigate the Breadcrumbs using standard keyboard controls.

| Key   | Interaction                                         |
| ----- | --------------------------------------------------- |
| Enter | Engages the link and moves focus to the link target |
| Tab   | Navigates linked Breadcrumbs in normal Tab order    |
