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

# Listbox – Code

> Listboxes allow a user to select one or more items from a list of options.

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="listbox-playground" fullWidth screenshot>
      ```tsx lines expandable theme={null}
      import { Listbox } from "@servicetitan/anvil2";

      function App() {
        const itemsList = [
          { id: 1, label: "First item" },
          { id: 2, label: "Second item" },
          { id: 3, label: "Third item", disabled: true },
          { id: 4, label: "Fourth item" },
          { id: 5, label: "Fifth item" },
        ];

        return (
          <Listbox items={itemsList} defaultSelected={itemsList[1]}>
            {({ items }) =>
              items.map((item) => (
                <Listbox.Option key={item.label} item={item} disabled={item.disabled}>
                  {item.label}
                </Listbox.Option>
              ))
            }
          </Listbox>
        );
      }

      export default App;
      ```
    </LiveCode>

    ## Common Examples

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

    const ExampleComponent = () => {
      const itemsArray = [
        { id: 0, label: "First item" },
        // ... more items
      ];

      return (
        <Listbox items={itemsArray}>
          {({ items }) =>
            items.map((item) => (
              <Listbox.Option key={item.label} item={item}>
                {item.label}
              </Listbox.Option>
            ))
          }
        </Listbox>
      );
    };
    ```

    ### Listbox Components

    A listbox can be created using the `Listbox` component and its two sub-components:

    * `Listbox.Option`: used to render the individual list options.
    * `Listbox.OptionGroup`: optionally used to group listbox options.
  </Tab>

  <Tab title="Single-select Listbox Props">
    ## Single-select `Listbox` using labels only

    ```tsx theme={null}
    <Listbox
      selectionMode="single"
      defaultSelected="option-1"
      selected="option-1"
      disableAutoSelectOnFocus={false}
      onSelectionChange={(selected) => console.log(selected)}
    >
      <Listbox.Option label="Option 1" value="option-1" />
      <Listbox.Option label="Option 2" value="option-2" />
    </Listbox>
    ```

    The `Listbox` component can accept any valid HTML `ul` props, with the exception that `children` could change depending on whether `items` is supplied.

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

    <ParamField path="defaultSelected" type="string" />

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

    <ParamField path="onSelectionChange" type="(selected: string | undefined) => void" />

    <ParamField path="selected" type="string" />

    <ParamField path="selectionMode" type={`"multiple" | "single"`} default="single">
      See other tables for changes in types for `"multiple"`
    </ParamField>

    ## Single-select `Listbox` using `items` array

    ```tsx theme={null}
    <Listbox
      items={itemsArray}
      selectionMode="single"
      defaultSelected={itemsArray[0]}
      selected={itemsArray[0]}
      disableAutoSelectOnFocus={false}
      onSelectionChange={(selected) => console.log(selected)}
    >
      {({ items }) =>
        items.map((item) => (
          <Listbox.Option key={item.id} item={item}>
            {item.label}
          </Listbox.Option>
        ))
      }
    </Listbox>
    ```

    <Note>
      `T` represents any arbitrary type used for the `items`, and `ListboxItemType<T>` implies that it will include a `label`: `string` property.
    </Note>

    <ParamField path="children" type="({ items }: { items: ListboxItemType<T>[] }) => ReactNode" />

    <ParamField path="defaultSelected" type="ListboxItemType<T>" />

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

    <ParamField path="items" type="ListboxItemType<T>[]" />

    <ParamField path="onSelectionChange" type="(selected: ListboxItemType<T> | undefined) => void" />

    <ParamField path="selected" type="ListboxItemType<T>" />

    <ParamField path="selectionMode" type={`"multiple" | "single"`} default="single">
      See other tables for changes in types for `"multiple"`
    </ParamField>
  </Tab>

  <Tab title="Multi-select Listbox Props">
    ## Multi-select `Listbox` using labels only

    ```tsx theme={null}
    <Listbox
      selectionMode="multiple"
      defaultSelected={["option-1", "option-2"]}
      selected={["option-1", "option-2"]}
      onSelectionChange={(selected) => console.log(selected)}
    >
      <Listbox.Option label="Option 1" value="option-1" />
      <Listbox.Option label="Option 2" value="option-2" />
    </Listbox>
    ```

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

    <ParamField path="defaultSelected" type="string[]" />

    <ParamField path="onSelectionChange" type="(selected: string[] | undefined) => void" />

    <ParamField path="selected" type="string[]" />

    <ParamField path="selectionMode" type={`"multiple" | "single"`} default="multiple">
      See other tables for changes in types for `"single"`
    </ParamField>

    ## Multi-select `Listbox` using `items` array

    ```tsx theme={null}
    <Listbox
      items={itemsArray}
      selectionMode="multiple"
      defaultSelected={[itemsArray[0], itemsArray[1]]}
      selected={[itemsArray[0], itemsArray[1]]}
      onSelectionChange={(selected) => console.log(selected)}
    >
      {({ items }) =>
        items.map((item) => (
          <Listbox.Option key={item.id} item={item}>
            {item.label}
          </Listbox.Option>
        ))
      }
    </Listbox>
    ```

    <Note>
      `T` represents any arbitrary type used for the `items`, and `ListboxItemType<T>` implies that it will include a `label`: `string` property.
    </Note>

    <ParamField path="children" type="({ items }: { items: ListboxItemType<T>[] }) => ReactNode" />

    <ParamField path="defaultSelected" type="ListboxItemType<T>[]" />

    <ParamField path="items" type="ListboxItemType<T>[]" />

    <ParamField path="onSelectionChange" type="(selected: ListboxItemType<T>[] | undefined) => void" />

    <ParamField path="selected" type="ListboxItemType<T>[]" />

    <ParamField path="selectionMode" type={`"multiple" | "single"`} default="multiple">
      See other tables for changes in types for `"single"`
    </ParamField>
  </Tab>

  <Tab title="Listbox.Option Props">
    ```tsx theme={null}
    <Listbox.Option item={item} label="Option 1" value="option-1" disabled={false}>
      Option content
    </Listbox.Option>
    ```

    ## `Listbox.Option` Props

    In addition to the props listed below, the `Listbox.Option` component can accept any valid HTML `li` props.

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

    <ParamField path="item" type="{ label: string; [key: string]: unknown; }">
      Use with `items` prop on parent `Listbox`
    </ParamField>

    <ParamField path="label" type="string">
      Required if no `item` provided
    </ParamField>

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