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

# Checkbox – Design

> Checkboxes let users select one or more options from a set.

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

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

  function App() {
    return <Checkbox label="Notify customer" />;
  }

  export default App;
  ```
</LiveCode>

## Options

The Checkbox supports selection, an indeterminate mixed state, and either a visible label or an indicator-only presentation.

### Selection

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

  function App() {
    return (
      <div style={{ display: "flex", flexDirection: "column", gap: 12 }}>
        <Checkbox label="Unselected" />
        <Checkbox label="Selected" defaultSelected />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

The checkbox toggles between unselected and selected. Use `isSelected` for controlled selection or `defaultSelected` for uncontrolled.

### Indeterminate

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

  function App() {
    const [completed, setCompleted] = useState(true);
    const [cancelled, setCancelled] = useState(false);
    const allSelected = completed && cancelled;
    const someSelected = completed || cancelled;

    return (
      <div style={{ display: "flex", flexDirection: "column", gap: 8 }}>
        <Checkbox
          label="Select all"
          isSelected={allSelected}
          isIndeterminate={someSelected && !allSelected}
          onChange={(isSelected) => {
            setCompleted(isSelected);
            setCancelled(isSelected);
          }}
        />
        <div
          style={{
            display: "flex",
            flexDirection: "column",
            gap: 8,
            paddingLeft: 24,
          }}
        >
          <Checkbox
            label="Include completed jobs"
            isSelected={completed}
            onChange={setCompleted}
          />
          <Checkbox
            label="Include cancelled jobs"
            isSelected={cancelled}
            onChange={setCancelled}
          />
        </div>
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

`isIndeterminate` renders a minus indicator for a select-all row whose children are only partially selected. It's a display-only override — pair it with your own logic to derive the mixed state from the children's selection, as shown above.

### Label

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

  function App() {
    return (
      <div style={{ display: "flex", flexDirection: "column", gap: 12 }}>
        {/* With visible label */}
        <Checkbox label="Notify customer" />

        {/* Indicator only, named via aria-label */}
        <Checkbox aria-label="Notify customer" />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

A visible `label` doubles as the accessible name. Omit `label` and supply `aria-label` or `aria-labelledby` instead for an indicator-only checkbox — common in dense table rows.

## Behavior

The Checkbox responds to selection, focus, and disabled states.

### Visual States

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

  function App() {
    return (
      <div style={{ display: "flex", flexDirection: "column", gap: 12 }}>
        {/* Rest */}
        <Checkbox label="Notify customer" />

        {/* Selected */}
        <Checkbox label="Notify customer" defaultSelected />

        {/* Indeterminate */}
        <Checkbox label="Notify customer" isIndeterminate />

        {/* Focus */}
        <Checkbox label="Notify customer" />

        {/* Disabled */}
        <Checkbox label="Notify customer" isDisabled />

        {/* Disabled + selected */}
        <Checkbox label="Notify customer" isDisabled defaultSelected />
      </div>
    );
  }

  export default App;
  ```
</LiveCode>

Selecting the checkbox fills the indicator; keyboard focus draws a ring scoped to the square indicator, not the full label width. `isDisabled` dims the control and blocks interaction in either selection state.

## Keyboard Interaction

Users can navigate and toggle the Checkbox using standard keyboard controls.

| Key   | Description                      |
| ----- | -------------------------------- |
| Tab   | Moves focus to the next checkbox |
| Space | Toggles the focused checkbox     |