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

> The Checkbox provides a labelled or indicator-only selection control with selected, indeterminate, and disabled states.

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

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

      export default App;
      ```
    </LiveCode>

    ## Common Examples

    To use the `Checkbox`, import it from `@servicetitan/anvil2-ai-kit` and pass a visible `label`, or omit `label` and supply exactly one of `aria-label` or `aria-labelledby`.

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

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

    ### Selection

    Use `isSelected` with `onChange` for controlled selection, or `defaultSelected` for uncontrolled.

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

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

      export default App;
      ```
    </LiveCode>

    ### Indeterminate

    `isIndeterminate` is a display-only mixed state for select-all rows. Derive it from child selection in your own logic.

    <LiveCode showCode example="ai-kit-checkbox-indeterminate" screenshot fullWidth>
      ```tsx lines expandable theme={null}
      import { useState } from "react";
      import { Checkbox } from "@servicetitan/anvil2-ai-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>

    ### Label and indicator-only

    A visible `label` is the accessible name. For dense rows, omit `label` and name the control with `aria-label` or `aria-labelledby`. Never pass both naming attributes.

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

    ### Disabled

    `isDisabled` dims the control and blocks interaction in either selection state.

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

    ## React Accessibility

    * Supply a visible `label`, or exactly one of `aria-label` or `aria-labelledby`.
    * Keyboard focus draws a ring on the square indicator, not the full label width.
    * Users toggle a focused checkbox with Space.
  </Tab>

  <Tab title="Checkbox Props">
    ```tsx theme={null}
    <Checkbox
      label="Notify customer"
      isSelected={false}
      onChange={(isSelected) => {}}
    />
    ```

    ## `Checkbox` Props

    The `Checkbox` accepts the following props. Pass a `label`, or omit `label` and pass exactly one of `aria-label` or `aria-labelledby`.

    <ParamField path="aria-label" type="string">
      Accessible name when there is no visible `label`. Mutually exclusive with
      `aria-labelledby`.
    </ParamField>

    <ParamField path="aria-labelledby" type="string">
      id(s) of the element(s) that name an indicator-only checkbox. Mutually
      exclusive with `aria-label`.
    </ParamField>

    <ParamField path="className" type="string">
      Class merged onto the root label.
    </ParamField>

    <ParamField path="defaultSelected" type="boolean">
      Whether the checkbox starts checked when uncontrolled.
    </ParamField>

    <ParamField path="isDisabled" type="boolean">
      Whether the checkbox is disabled.
    </ParamField>

    <ParamField path="isIndeterminate" type="boolean">
      Mixed selection state for select-all controls. Display only; it does not
      replace `isSelected`.
    </ParamField>

    <ParamField path="isSelected" type="boolean">
      Whether the checkbox is checked when controlled.
    </ParamField>

    <ParamField path="label" type="string">
      Visible label and accessible name. Omit for indicator-only checkboxes.
    </ParamField>

    <ParamField path="onChange" type="(isSelected: boolean) => void">
      Called when the checked state changes.
    </ParamField>
  </Tab>
</Tabs>