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

# Button Toggle – Design

> Button Toggles let users alternate between two states with a single click.

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/main-image-for-button-toggle.png?fit=max&auto=format&n=uz2PQSvO75TRhQ38&q=85&s=5f94957b6e5937f8db5402930771c05a" width="274" height="204" data-path="images/docs/web/components/shared/main-image-for-button-toggle.png" />
  </div>
</Frame>

## Anatomy

The Button Toggle consists of three primary elements that work together to let users alternate between two states with a single click.

<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/button-toggle/design/button-toggle-anatomy.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=a531a54e58e2b21f0d57e69a0a64faa9"
      alt="Button Toggle
anatomy"
      width="654"
      height="528"
      data-path="images/docs/web/components/button-toggle/design/button-toggle-anatomy.png"
    />
  </div>
</Frame>

1. Container
2. Text label
3. Icon

## Options

The Button Toggle supports multiple size configurations to accommodate various toggle scenarios.

#### Sizes

<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/button-toggle/design/button-options-sizes.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=d76b3ce68435fc230c0432a399f9424b"
      alt="Button options
sizes"
      width="608"
      height="101"
      data-path="images/docs/web/components/button-toggle/design/button-options-sizes.png"
    />
  </div>
</Frame>

| Size   | Height |
| ------ | ------ |
| Large  | 48px   |
| Medium | 40px   |
| Small  | 32px   |

## Behavior

The Button Toggle responds to user interaction with distinct visual states and flexible layout behaviors.

### Visual States

#### Default

<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/button-toggle/design/default-button-toggle.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=a44e50fd2bc1201cad8c47ec4f7a7c4c"
      alt="Default Button
Toggle"
      width="624"
      height="304"
      data-path="images/docs/web/components/button-toggle/design/default-button-toggle.png"
    />
  </div>
</Frame>

#### Checked

<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/button-toggle/design/checked-button-toggle.png?fit=max&auto=format&n=Ni0bXIw9diilEZPZ&q=85&s=dd734c85ecee4de13f8b92edfd1f12c6"
      alt="Checked Button
Toggle"
      width="624"
      height="304"
      data-path="images/docs/web/components/button-toggle/design/checked-button-toggle.png"
    />
  </div>
</Frame>

#### Text wrap

Button Toggles fill all available space, wrapping only when no space remains. Text is center-aligned when wrapping.

#### Widths

In general, Button Toggles should match the width of their text. Container width works well when aligning with specific layout elements. Button Toggle Icon width always equals its height.

## Usage Guidelines

Use the Button Toggle to control the binary state of a Button.

### When to Use

Button Toggles control the binary state of a Button. They can contain text, text with an icon, or just an icon.

### How to Use

Button Toggles work well when selecting multiple options from a set of available options.

<LiveCode example="buttontoggle-playground" fullWidth screenshot>
  ```tsx lines theme={null}
  import { ButtonToggle, Flex } from "@servicetitan/anvil2";
  import Star from "@servicetitan/anvil2/assets/icons/material/round/star.svg";
  import Favorite from "@servicetitan/anvil2/assets/icons/material/round/favorite.svg";
  import Bookmark from "@servicetitan/anvil2/assets/icons/material/round/bookmark.svg";

  function App() {
    return (
      <Flex gap="2">
        <ButtonToggle icon={{ before: Star }}>Star</ButtonToggle>
        <ButtonToggle icon={{ before: Favorite }}>Heart</ButtonToggle>
        <ButtonToggle icon={{ before: Bookmark }}>Bookmark</ButtonToggle>
      </Flex>
    );
  }

  export default App;
  ```
</LiveCode>

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

## Content

Content within the Button Toggle should clearly communicate the toggle state through labels and optional icons.

## Keyboard Interaction

Users can navigate the Button Toggle using standard keyboard controls.

| Key            | Interaction           |
| -------------- | --------------------- |
| Space or Enter | Toggles checked state |

Button Toggles using an href will also use this keyboard combination.

### Accessibility

Anvil provides most of the accessibility needs for Button Toggle out of the box, and only need some additional considerations for library users.

#### Provide labels for Icon Buttons

Regardless of whether or not a label is visible on the page, a label should be provided to describe the action for both screen readers and for users who focus on the element.

For more guidance on button labels and accessibility, see [button accessibility best practices](/docs/accessibility/labels-and-ctas#buttons-and-links).