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

> Buttons are interactive controls that trigger an action or event.

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

<LiveCode example="carto-button" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";

  function App() {
    return <Button label="Button" />;
  }

  export default App;
  ```
</LiveCode>

## Options

The Button supports variants, sizes, and icon configurations to fit different action hierarchies.

### Variants

<LiveCode example="carto-button-variant" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";

  function App() {
    return (
      <div
        style={{
          display: "flex",
          flexWrap: "wrap",
          gap: 12,
          alignItems: "center",
        }}
      >
        <Button label="Primary" variant="primary" />
        <Button label="Secondary" variant="secondary" />
        <Button label="Ghost" variant="ghost" />
        <Button label="Danger" variant="danger" />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

| Variant   | When to use                                                              |
| --------- | ------------------------------------------------------------------------ |
| Primary   | The main action in a view. Prefer one primary action in the same context |
| Secondary | Supporting actions that sit alongside or below a primary action          |
| Ghost     | Low-emphasis actions, including many icon-only controls                  |
| Danger    | Destructive or irreversible actions that need clear caution              |

### Sizes

<LiveCode example="carto-button-size" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";

  function App() {
    return (
      <div
        style={{
          display: "flex",
          flexWrap: "wrap",
          gap: 12,
          alignItems: "center",
        }}
      >
        <Button label="Extra Small" size="xsmall" variant="secondary" />
        <Button label="Small" size="small" variant="secondary" />
        <Button label="Medium" size="medium" variant="secondary" />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

| Size   | Typical use                                                                                     |
| ------ | ----------------------------------------------------------------------------------------------- |
| Medium | Default size for most product actions                                                           |
| Small  | Dense layouts where space is limited                                                            |
| Xsmall | Compact desktop UI. On touch devices, the tap target is promoted to meet accessibility guidance |

### Icons

<LiveCode example="carto-button-icon" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";
  import {
    IconChevronRight,
    IconPencil,
    IconPlus,
  } from "@servicetitan/carto-react-kit/icons";

  function App() {
    return (
      <div
        style={{
          display: "flex",
          flexDirection: "column",
          gap: 12,
          alignItems: "center",
        }}
      >
        <Button
          label="Add item"
          variant="secondary"
          icon={{ icon: <IconPlus />, position: "left" }}
        />
        <Button
          label="Continue"
          variant="secondary"
          icon={{ icon: <IconChevronRight />, position: "right" }}
        />
        <Button label="Edit" variant="secondary" icon={<IconPencil />} />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

Icons can sit before or after the label, or replace the label entirely. Icon-only buttons keep a short label for accessibility and show that label in a tooltip on hover and focus.

## Behavior

The Button responds to pointer, touch, and keyboard interaction with clear resting, hover, pressed, focused, and disabled states.

### Visual States

<LiveCode example="carto-button-visual-states" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";

  const variants = ["primary", "secondary", "ghost", "danger"] as const;

  function App() {
    return (
      <div style={{ display: "flex", flexDirection: "column", gap: 24 }}>
        {variants.map((variant) => (
          <div
            key={variant}
            style={{
              display: "flex",
              flexWrap: "wrap",
              gap: 12,
              alignItems: "center",
            }}
          >
            <Button label="Rest" variant={variant} size="small" />
            <Button
              label="Hover"
              variant={variant}
              size="small"
              data-interactive="hover"
            />
            <Button
              label="Active"
              variant={variant}
              size="small"
              data-interactive="active"
            />
            <Button
              label="Focus Visible"
              variant={variant}
              size="small"
              data-interactive="focus-visible"
            />
            <Button label="Disabled" variant={variant} size="small" isDisabled />
          </div>
        ))}
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

Hover and press update the surface to confirm the control is interactive. Keyboard focus shows a visible focus ring. Disabled buttons remain in the tab order where appropriate but do not activate.

### Icon-only labeling

<LiveCode example="carto-button-icon-only-labeling" screenshot fullWidth>
  ```tsx lines theme={null}
  import { Button } from "@servicetitan/carto-react-kit";
  import { IconPencil } from "@servicetitan/carto-react-kit/icons";

  function App() {
    return (
      <div
        style={{
          display: "flex",
          justifyContent: "center",
          padding: "48px 24px",
        }}
      >
        <Button
          label="Edit"
          variant="secondary"
          size="small"
          icon={<IconPencil />}
        />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

Icon-only buttons always carry a required label. That label becomes the accessible name and the tooltip content so pointer and assistive-technology users share the same affordance name.

## Keyboard Interaction

Users can activate the Button using standard keyboard controls.

| Key           | Description                  |
| ------------- | ---------------------------- |
| Tab           | Moves focus to the button    |
| Enter / Space | Activates the focused button |

### Accessibility

Every Button requires a label so it always has an accessible name. Icon-only buttons expose that label through `aria-label` and a presentational tooltip so the name is not announced twice. Prefer press handlers that work for click, touch, and keyboard activation together.