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

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

<Tabs>
  <Tab title="Implementation">
    <LiveCode showCode example="buttontoggle-playground" fullWidth screenshot>
      ```tsx lines expandable 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>

    ## Common Examples

    ```tsx theme={null}
    import { ButtonToggle } from "@servicetitan/anvil2";

    function ExampleComponent() {
      return <ButtonToggle>Click to toggle</ButtonToggle>;
    }
    ```

    ### Button toggle sizes

    Use the `size` prop to adjust the text size and padding of the button.

    <LiveCode showCode example="buttontoggle-size" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { ButtonToggle, Flex } from "@servicetitan/anvil2";

      function App() {
        return (
          <Flex gap="3">
            <ButtonToggle size="large">Large</ButtonToggle>
            <ButtonToggle size="medium">Medium(Default)</ButtonToggle>
            <ButtonToggle size="small">Small</ButtonToggle>
          </Flex>
        );
      }

      export default App;
      ```
    </LiveCode>

    ### Controlling button toggles

    <LiveCode showCode example="buttontoggle-controlled" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { ButtonToggle } from "@servicetitan/anvil2";
      import { useState } from "react";

      function App() {
        const [isChecked, setIsChecked] = useState(true);

        return (
          <ButtonToggle
            checked={isChecked}
            onClick={() => setIsChecked((prev) => !prev)}
          >
            Click to Toggle
          </ButtonToggle>
        );
      }

      export default App;
      ```
    </LiveCode>

    #### Uncontrolled button toggles

    By default, button toggles are uncontrolled. The checked state changes when the button is clicked. To make the button toggle checked by default, use the `defaultChecked` prop.

    <LiveCode showCode example="buttontoggle-uncontrolled" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { ButtonToggle } from "@servicetitan/anvil2";

      function App() {
        return <ButtonToggle defaultChecked>Click to Toggle</ButtonToggle>;
      }

      export default App;
      ```
    </LiveCode>

    #### Controlled button toggles

    To programmatically set the checked state of a button toggle, use the `checked` prop.

    ### Handling state changes

    The `onChange` prop accepts a function that passes the change event and current state object. This can be used to trigger other actions depending on the changed state.

    ```tsx theme={null}
    () => {
      doSomething(state: ButtonToggleState) {
        console.log(`${state.value} is pressed: ${state.pressed}`)
      }
      return (
        <ButtonToggle onChange={(e, state) => doSomething(state)}>
          Toggle
        </ButtonToggle>
      )
    }
    ```

    ## React Accessibility

    ### Icon-only button toggles

    ```tsx theme={null}
    <ButtonToggle icon={Star} aria-label="Favorite" />
    ```

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

    Use aria-label or aria-labelledby for a button without any text.

    ```tsx theme={null}
    <ButtonToggle icon={Star} />
    ```

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

    Provide only an icon for screen readers to read.

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

  <Tab title="ButtonToggle Props">
    ```tsx theme={null}
    <ButtonToggle
      checked={true}
      defaultChecked={false}
      disabled={false}
      icon={StarIcon}
      size="medium"
      value="toggle-1"
      onChange={(e, state) => console.log(state)}
    >
      Click to toggle
    </ButtonToggle>
    ```

    ## `ButtonToggle` Props

    <ParamField path="checked" type="boolean" />

    <ParamField path="children" type="ReactNode" />

    <ParamField path="defaultChecked" type="boolean" default="false" />

    <ParamField path="disabled" type="boolean" default="false" />

    <ParamField path="icon" type="Svg { before: Svg, after: Svg }">
      The SVGR library imports `*.svg` files as React components, so `icon` can
      accept either a React component, or an object with `before` and/or `after`
      keys to specify the placement of the icon.
    </ParamField>

    <ParamField path="onChange" type="(event, { pressed, value }) => void" />

    <ParamField path="size" type={`"small" | "medium" | "large"`} default="medium" />

    <ParamField path="value" type="string" />
  </Tab>
</Tabs>
