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

# Badge – Design

> Badges are used to indicate that something requires a user's attention on an interactive element.

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/uz2PQSvO75TRhQ38/images/docs/web/components/shared/overview-of-a-badge.png?fit=max&auto=format&n=uz2PQSvO75TRhQ38&q=85&s=58c66b481011a0dddc99702f8437f188" width="99" height="100" data-path="images/docs/web/components/shared/overview-of-a-badge.png" />
  </div>
</Frame>

## Anatomy

The Badge consists of two primary elements that work together to indicate attention requirements on interactive elements.

<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/badge/design/anatomy-of-a-badge.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=c22d0722b93b176b9282231688714834"
      alt="Anatomy of a
Badge"
      width="488"
      height="102"
      data-path="images/docs/web/components/badge/design/anatomy-of-a-badge.png"
    />
  </div>
</Frame>

1. Parent element
2. Badge

## Options

The Badge supports default and value-less configurations to accommodate various notification scenarios.

### Default

<LiveCode example="badge-options-default" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="with 6 unread">6</Badge>
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

By default, show the number of alerts or notifications on the Badge so users see them without diving deeper.

### Without value

<LiveCode example="badge-options-without-value" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="has unread notifications" />
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

When the number of alerts or notifications is not available, use an empty Badge.

## Behavior

The Badge responds to value limits and positioning requirements while maintaining consistent visual indication.

### Max value

<LiveCode example="badge-behavior-max-value-do" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="with 99+ unread">99+</Badge>
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

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

Set a max value for Badges. Use 99 in most cases. When values of 100+ are frequent, use 999.

<LiveCode example="badge-behavior-max-value-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="with 999999999 unread">999999999</Badge>
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

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

### Offset

When using Badge with components like [Link](/docs/web/components/link/design), overlap may not be ideal. Set offset to resolve this issue.

<LiveCode example="badge-offset" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Link } from "@servicetitan/anvil2";

  function App() {
    return (
      <Link href="#" style={{ position: "relative" }}>
        What&apos;s new?
        <Badge
          aria-label="with 12 updates"
          offset={{
            x: "1rem", // 16px to the right
            y: "-0.25rem", // 4px up
          }}
        >
          12
        </Badge>
      </Link>
    );
  }

  export default App;
  ```
</LiveCode>

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

<LiveCode example="badge-behavior-offset-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Link } from "@servicetitan/anvil2";

  function App() {
    return (
      <Link href="#" style={{ position: "relative" }}>
        What&apos;s new?
        <Badge aria-label="with 12 updates">12</Badge>
      </Link>
    );
  }

  export default App;
  ```
</LiveCode>

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

## Usage Guidelines

### When to Use

Use a Badge to indicate to users that something requires attention.

### When not to use

Badges should not be used to label or organize information, instead use a [Chip](/docs/web/components/chip/design). Badges should also not be used to indicate the count of items within (e.g., the number of items inside of a Tab or folder). Use a Chip for these cases.

### Alternatives

#### Badge vs Chip

Chips are used to categorize, label, and add context to items whereas Badges are used to indicate something requires attention, such as a notification. Additionally, Chips can be interactive while Badges are not.

### How to Use

#### Add Badge to interactive elements

<LiveCode example="badge-options-default" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="with 6 unread">6</Badge>
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

Attach Badges to interactive elements, such as icon buttons, to indicate a count (e.g., the number of notifications).

#### Without a count

<LiveCode example="badge-options-without-value" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="has unread notifications" />
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

Use Badges without a value to denote an unread notification or message.

#### Do not change the color of the Badge

<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/badge/design/badge-how-color-dont.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=25475f510025950e3c3647aa5f956ce6"
      alt="Badge how color
dont"
      width="264"
      height="40"
      data-path="images/docs/web/components/badge/design/badge-how-color-dont.png"
    />
  </div>
</Frame>

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

#### Only use numbers inside of a Badge

<LiveCode example="badge-non-number-dont" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Badge, Button } from "@servicetitan/anvil2";

  function App() {
    return (
      <Button style={{ position: "relative" }}>
        Button
        <Badge aria-label="with new notification">New Item</Badge>
      </Button>
    );
  }

  export default App;
  ```
</LiveCode>

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

Badges should only contain numerical values.

## Content

Content within the Badge should clearly indicate the count or presence of items requiring attention through numerical values.

## Keyboard Interaction

Users can navigate the Badge using standard keyboard controls.

For accessibility, `aria-label` should be defined to match the context.

With the example above, there are 2 methods:

* Adding `aria-label="Cases with 6 items to review"` to the Button
  * This will read as "Cases with 6 items to review, button"
* Adding `aria-label="with 6 items to review"` to the Badge only
  * This will read as "Cases, button, with 6 items to review"

For more guidance on accessible labels and ARIA, see [labels and CTA best practices](/docs/accessibility/labels-and-ctas).
