> ## 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 – Code

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

<Tabs>
  <Tab title="Implementation">
    <LiveCode showCode example="badge-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Badge, Flex, Button } from "@servicetitan/anvil2";
      import Warning from "@servicetitan/anvil2/assets/icons/material/round/warning.svg";

      function App() {
        return (
          <Flex gap="6">
            <div style={{ display: "inline-block", position: "relative" }}>
              <Button icon={Warning} />
              <Badge aria-label="with 4 notifications">4</Badge>
            </div>
            <Button>
              What&apos;s new?
              <Badge aria-label="with notifications" />
            </Button>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    ```tsx theme={null}
    import { Badge, Button } from "@servicetitan/anvil2";

    const ExampleComponent = () => {
      return (
        <Button style={{ position: "relative" }}>
          Alerts
          <Badge aria-label="with 12 unread">12</Badge>
        </Button>
      );
    };
    ```

    ### Use relative positioning on badge parent

    In order for a badge to properly position itself, the parent of the `Badge` component that the badge should be placed on needs to have `position: relative`.

    ```tsx theme={null}
    <div style={{ position: "relative " }}>
      Content
      <Badge aria-label="with 10 notifications">10</Badge>
    </div>
    ```

    ### Adjusting badge position

    When used with square or rectangular elements, the badge should position itself nicely on the corner of the element. Sometimes, some fine-tuning may be required if the element has a different shape, such as text. Use the `offset` prop to supply CSS sizing values to the `x` and `y` parameters.

    <LiveCode showCode example="badge-offset" screenshot fullWidth>
      ```tsx lines expandable 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>

    ### Badges without children

    If no `children` element is provided for the `Badge` component, only a red dot will appear.

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

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

      export default App;
      ```
    </LiveCode>

    ## React Accessibility

    ### Using aria-label

    ```tsx theme={null}
    <Badge aria-label="12 unread">12</Badge>
    ```

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

    Use the aria-label prop to provide better context for the number displayed within the badge.

    ```tsx theme={null}
    <Badge>12</Badge>
    ```

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

    Provide only the children for screen readers to use.

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

  <Tab title="Badge Props">
    ```tsx theme={null}
    <Badge offset={{ x: "0.5rem", y: "0.5rem" }} aria-label="12 unread">
      12
    </Badge>
    ```

    ## `Badge` Props

    In addition to the props listed below, the `Badge` component can accept any valid HTML `sup` props.

    <ParamField path="offset" type="{ x?: string; y?: string }">
      Fine-tune the badge position with CSS sizing values.
    </ParamField>
  </Tab>
</Tabs>