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

> The Button provides interactive actions with variants, sizes, and icon configurations.

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="ai-kit-button-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-kit";
      import { IconPlus } from "@servicetitan/anvil2-icons";

      function App() {
        return (
          <Button
            variant="primary"
            size="medium"
            label="Add item"
            icon={{ icon: <IconPlus />, position: "left" }}
            onPress={() => console.log("pressed")}
          />
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    To use the `Button`, import it from `@servicetitan/anvil2-ai-kit` and pass a required `label`. The kit forbids `children`; all content flows through typed props.

    ```tsx theme={null}
    import { Button } from "@servicetitan/anvil2-ai-kit";

    function ExampleComponent() {
      return <Button label="Save" onPress={() => {}} />;
    }
    ```

    ### Variants

    The `variant` prop sets visual intent. Use `"primary"` for the main action, `"secondary"` for supporting actions, `"ghost"` for low-emphasis actions, and `"danger"` for destructive work.

    <LiveCode showCode example="ai-kit-button-variant" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-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>

    ### Sizes

    The `size` prop sets the target size. `"medium"` is the default. On touch devices, `"xsmall"` promotes to a 40×40 minimum so the tap target meets WCAG 2.5.5 guidance.

    <LiveCode showCode example="ai-kit-button-size" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-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>

    ### Icons

    Pass a bare icon element for an icon-only button. Pair `{ icon, position }` with the visible `label` to place an icon before or after the text. Import icons from `@servicetitan/anvil2-icons`.

    <LiveCode showCode example="ai-kit-button-icon" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-kit";
      import {
        IconChevronRight,
        IconPencil,
        IconPlus,
      } from "@servicetitan/anvil2-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>

    Icon-only buttons apply `label` as `aria-label` and show it in a presentational tooltip, so pointer and assistive-technology users share the same name.

    <LiveCode showCode example="ai-kit-button-icon-only-labeling" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-kit";
      import { IconPencil } from "@servicetitan/anvil2-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>

    ### Disabled

    Set `isDisabled` to prevent press and hover while keeping the control focusable for keyboard users.

    <LiveCode showCode example="ai-kit-button-disabled" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { Button } from "@servicetitan/anvil2-ai-kit";

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

      export default App;
      ```
    </LiveCode>

    ### Press handling

    Prefer `onPress` over `onClick`. `onPress` fires for click, touch, and Space/Enter, matching React Aria's press semantics.

    ```tsx theme={null}
    <Button label="Save" onPress={() => save()} />
    ```

    ## React Accessibility

    * Every `Button` requires a `label`, which is always the accessible name.
    * Icon-only buttons expose that name through `aria-label` and a presentational tooltip so screen readers do not announce the name twice.
    * Disabled buttons remain in the tab order. They do not activate.
    * Users activate a focused button with Enter or Space.
  </Tab>

  <Tab title="Button Props">
    ```tsx theme={null}
    <Button
      label="Save"
      variant="primary"
      size="medium"
      icon={{ icon: <IconPlus />, position: "left" }}
      isDisabled={false}
      onPress={() => {}}
    />
    ```

    ## `Button` Props

    The `Button` accepts the following props. It also forwards remaining React Aria `Button` props except `children`, `className`, `style`, and `isPending`.

    <ParamField path="label" type="string" required>
      Required accessible name. Becomes visible text when the button shows a
      label, and becomes the `aria-label` plus tooltip content for icon-only
      buttons. Pass a short imperative such as `"Save"` or `"Open settings"`.
    </ParamField>

    <ParamField path="className" type="string">
      Caller-supplied class name merged onto the button's recipe class.
    </ParamField>

    <ParamField path="icon" type={`IconElement | { icon: IconElement; position: "left" | "right" }`}>
      Optional icon. A bare `IconElement` renders an icon-only button. The
      object form pairs the icon with the visible `label`.
    </ParamField>

    <ParamField path="isDisabled" type="boolean" default="false">
      Disables press and hover. The control remains focusable for keyboard
      users.
    </ParamField>

    <ParamField path="onPress" type="(e: PressEvent) => void">
      Press handler that fires for click, touch, and Space/Enter. Prefer this
      over `onClick` for keyboard and touch parity.
    </ParamField>

    <ParamField path="size" type={`"medium" | "small" | "xsmall"`} default="medium">
      Target size. On touch devices, `"xsmall"` is promoted to a 40×40 minimum.
    </ParamField>

    <ParamField path="variant" type={`"primary" | "secondary" | "ghost" | "danger"`} default="primary">
      Visual intent. Use `"primary"` for the main action and `"danger"` for
      destructive work.
    </ParamField>
  </Tab>
</Tabs>