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

# Multi Select Field - Web

> Multi Select Field is a form element that allows users to search, filter, and select multiple values from a list of options.

> [!NOTE]
>
> For development, import `MultiSelectField` from
> `@servicetitan/anvil2`. For design, find it in the
> [Anvil2 file](https://www.figma.com/design/xaNQsvRKczoxu7pj0M6QT8/Anvil2-v3?node-id=2168-37552).

multiselectfield-playground

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-playground?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "380px" }}>
      <MultiSelectFieldSync
        label="Favorite books"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

## Anatomy

The Multi Select Field consists of eight elements that work together to allow users to search and select multiple values from a list of options.

![Multi Select Field anatomy](https://mintcdn.com/servicetitan/yMyP2mRFjq4alcb1/images/docs/web/components/select-field/multi/Anatomy.png?fit=max\&auto=format\&n=yMyP2mRFjq4alcb1\&q=85\&s=dff4c5ac55ab47bc1a8da85bc4b475f9)

1. Placeholder text
2. Popover
3. Option
4. Selected value
5. Clear button (Optional)
6. Section header
7. Selected optio
8. Rich content option

## Options

The Multi Select Field supports the following configurations to accommodate a wide range of selection scenarios.

### Selection options

#### Search

multiselectfield-search

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-search?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "380px" }}>
      <MultiSelectFieldSync
        label="Favorite books"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

By default, Multi Select Field provides a searchable text input that filters options as users type.

#### Select-only

multiselectfield-select-only

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-select-only?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector('[role="combobox"]');
      if (trigger instanceof HTMLElement) trigger.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "380px" }}>
      <MultiSelectFieldSync
        disableSearch
        label="Favorite books"
        placeholder="Select books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

When search adds no value — such as with short, well-known option lists — disable it to present a simpler select-only trigger. The select-only mode uses the listbox ARIA pattern instead of combobox.

### Menu display options

Multi Select Field displays options in a popover by default on desktop and a dialog on mobile. Override this adaptive behavior by setting the display mode explicitly to always use a popover or always use a dialog.

#### In a Popover

multiselectfield-display-popover

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-display-popover?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "380px" }}>
      <MultiSelectFieldSync
        displayMenuAs="popover"
        label="Favorite books"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

#### In a Dialog

multiselectfield-display-dialog

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-display-dialog?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "380px" }}>
      <MultiSelectFieldSync
        displayMenuAs="dialog"
        label="Favorite books"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

### Sections

multiselectfield-sections

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-sections?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Great Gatsby", group: "fiction" },
  { id: 2, label: "To Kill a Mockingbird", group: "fiction" },
  { id: 3, label: "1984", group: "fiction" },
  { id: 4, label: "Sapiens", group: "non-fiction" },
  { id: 5, label: "Thinking, Fast and Slow", group: "non-fiction" },
  { id: 6, label: "The Martian", group: "sci-fi" },
  { id: 7, label: "Dune", group: "sci-fi" },
  { id: 8, label: "Foundation", group: "sci-fi" },
];

const groupLabels: Record<string, string> = {
  fiction: "Fiction",
  "non-fiction": "Non-Fiction",
  "sci-fi": "Science Fiction",
};

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "420px" }}>
      <MultiSelectFieldSync
        label="Books by genre"
        placeholder="Search books..."
        options={options}
        groupToString={(group) => groupLabels[group as string] ?? String(group)}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

Sections divide options into labeled groups, helping users scan and identify related items. Every section requires a label.

#### Pinned sections

Sections can be pinned to the top of the list. Pinned sections are useful for surfacing frequently used options, recent selections, or AI-powered suggestions without requiring the user to search for them.

### Rich content

multiselectfield-rich-content

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-rich-content?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectField,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";
import GroupIcon from "@servicetitan/anvil2/assets/icons/material/round/groups.svg";

const options: MultiSelectFieldOption[] = [
  {
    id: 1,
    label: "Label only",
  },
  {
    id: 2,
    label: "Label + icon",
    content: {
      icon: { svg: GroupIcon },
    },
  },
  {
    id: 3,
    label: "Title + description",
    content: {
      title: "Title + description",
      description: "A short description providing extra context",
    },
  },
  {
    id: 4,
    label: "Title + description + icon",
    content: {
      title: "Title + description + icon",
      description: "A short description providing extra context",
      icon: { svg: GroupIcon },
    },
  },
  {
    id: 5,
    label: "Title + chips",
    content: {
      title: "Title + chips",
      chips: [{ label: "Tag A" }, { label: "Tag B", color: "#F97316" }],
    },
  },
  {
    id: 6,
    label: "Title + chips + icon",
    content: {
      title: "Title + chips + icon",
      chips: [{ label: "Tag A" }, { label: "Tag B", color: "#F97316" }],
      icon: { svg: GroupIcon },
    },
  },
  {
    id: 7,
    label: "Title + description + avatar",
    content: {
      title: "Title + description + avatar",
      description: "Option with an avatar",
      avatar: { name: "Jane Doe", color: "#6366F1" },
    },
  },
  {
    id: 8,
    label: "Title + description + avatar + icon",
    content: {
      title: "Title + description + avatar + icon",
      description: "Option with an avatar",
      avatar: { name: "Jane Doe", color: "#6366F1" },
      icon: { svg: GroupIcon },
    },
  },
  {
    id: 9,
    label: "Title + description + chips",
    content: {
      title: "Title + description + chips",
      description: "Option with chip tags",
      chips: [{ label: "Tag A" }, { label: "Tag B", color: "#F97316" }],
    },
  },
  {
    id: 10,
    label: "Title + description + chips + icon",
    content: {
      title: "Title + description + chips + icon",
      description: "Option with chip tags",
      chips: [{ label: "Tag A" }, { label: "Tag B", color: "#F97316" }],
      icon: { svg: GroupIcon },
    },
  },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "420px" }}>
      <MultiSelectField
        label="Rich content options"
        placeholder="Search options..."
        loadOptions={() => options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

Options support rich content including titles, descriptions, avatars, icons, and chips. Rich content helps users distinguish between similarly named items or convey additional metadata at a glance.

#### Icons

An icon appears on the right side of the option, after the title, description, and chips. Icons work alongside every other content type, so an option can show an avatar on the left and an icon on the right.

multiselectfield-rich-content-icons

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-rich-content-icons?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectField,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";
import GroupIcon from "@servicetitan/anvil2/assets/icons/material/round/groups.svg";

const options: MultiSelectFieldOption[] = [
  { id: "dispatch", label: "Dispatch", content: { icon: { svg: GroupIcon } } },
  {
    id: "install-crew",
    label: "Install crew",
    content: { icon: { svg: GroupIcon } },
  },
  {
    id: "service-team",
    label: "Service team",
    content: { icon: { svg: GroupIcon } },
  },
  {
    id: "maintenance-team",
    label: "Maintenance team",
    content: { icon: { svg: GroupIcon } },
  },
  {
    id: "sales-team",
    label: "Sales team",
    content: { icon: { svg: GroupIcon } },
  },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "340px" }}>
      <MultiSelectField
        label="Notify teams"
        placeholder="Search teams..."
        loadOptions={() => options}
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

### Lazy loading options

multiselectfield-lazy-loading

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-lazy-loading?file=src/App.tsx)

```tsx lines theme={null}
import { useState } from "react";
import {
  MultiSelectField,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const allBooks = Array.from({ length: 100 }, (_, i) => ({
  id: `book-${i + 1}`,
  label: `Book ${i + 1}`,
}));

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);

  return (
    <div style={{ width: 384 }}>
      <MultiSelectField
        lazy="page"
        lazyOptions={{ pageSize: 10 }}
        loadOptions={async (searchValue, pageNumber, pageSize) => {
          await new Promise((r) => setTimeout(r, 300));

          const filtered = allBooks.filter((b) =>
            b.label.toLowerCase().includes(searchValue.toLowerCase()),
          );
          const start = pageNumber * pageSize;
          const page = filtered.slice(start, start + pageSize);

          return {
            options: page,
            hasMore: start + page.length < filtered.length,
          };
        }}
        label="Books (lazy loading)"
        placeholder="Search books..."
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

For large datasets, options load on demand as users scroll through the list. Three pagination strategies are supported: page-based, offset-based, and group-based. Results are cached by default to avoid redundant requests.

### Select All

multiselectfield-select-all

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-select-all?file=src/App.tsx)

```tsx lines theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Mistborn: The Final Empire by Brandon Sanderson" },
  { id: 4, label: "Murder on the Orient Express by Agatha Christie" },
  { id: 5, label: "Dune by Frank Herbert" },
  { id: 6, label: "Beloved by Toni Morrison" },
  { id: 7, label: "Atomic Habits by James Clear" },
  { id: 8, label: "Sapiens by Yuval Noah Harari" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);
  const containerRef = useRef<HTMLDivElement>(null);

  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "420px" }}>
      <MultiSelectFieldSync
        label="Favorite books"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
        selectAll
        selectFiltered
      />
    </div>
  );
}

export default App;
```

Multi Select Field can include a Select All action at the top of the options list, allowing users to toggle all options at once. When combined with search filtering, the Select Filtered action selects only the currently visible results.

### Field Options

#### Sizes

multiselectfield-sizes

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-sizes?file=src/App.tsx)

```tsx lines theme={null}
import { useState } from "react";
import { Flex } from "@servicetitan/anvil2";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Dune by Frank Herbert" },
  { id: 4, label: "Beloved by Toni Morrison" },
  { id: 5, label: "Atomic Habits by James Clear" },
];

function App() {
  const [smallValue, setSmallValue] = useState<MultiSelectFieldOption[]>([
    options[0],
  ]);
  const [mediumValue, setMediumValue] = useState<MultiSelectFieldOption[]>([
    options[0],
  ]);
  const [largeValue, setLargeValue] = useState<MultiSelectFieldOption[]>([
    options[0],
  ]);

  return (
    <Flex direction="column" gap="6" style={{ maxWidth: 320 }}>
      <MultiSelectFieldSync
        size="small"
        label="Small"
        placeholder="Search books..."
        options={options}
        value={smallValue}
        onSelectedOptionsChange={setSmallValue}
      />
      <MultiSelectFieldSync
        size="medium"
        label="Medium (default)"
        placeholder="Search books..."
        options={options}
        value={mediumValue}
        onSelectedOptionsChange={setMediumValue}
      />
      <MultiSelectFieldSync
        size="large"
        label="Large"
        placeholder="Search books..."
        options={options}
        value={largeValue}
        onSelectedOptionsChange={setLargeValue}
      />
    </Flex>
  );
}

export default App;
```

Three sizes are available: small, medium, and large. Choose a size that aligns with the surrounding form layout and density.

#### Prefix and suffix

multiselectfield-prefix-suffix

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-prefix-suffix?file=src/App.tsx)

```tsx lines theme={null}
import { useState } from "react";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "bug" },
  { id: 2, label: "feature" },
  { id: 3, label: "enhancement" },
  { id: 4, label: "documentation" },
  { id: 5, label: "help wanted" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);

  return (
    <div style={{ width: 320 }}>
      <MultiSelectFieldSync
        label="Tags"
        placeholder="Select tags..."
        options={options}
        prefix="#"
        value={value}
        onSelectedOptionsChange={setValue}
      />
    </div>
  );
}

export default App;
```

Add content before or after the input to provide additional context, such as currency symbols or units.

## Behavior

The Multi Select Field responds to user interaction with search filtering and distinct visual states.

### Visual states

multiselectfield-visual-states

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-visual-states?file=src/App.tsx)

```tsx lines theme={null}
import { useState } from "react";
import { Flex } from "@servicetitan/anvil2";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian by Andy Weir" },
  { id: 2, label: "Gone Girl by Gillian Flynn" },
  { id: 3, label: "Dune by Frank Herbert" },
  { id: 4, label: "Beloved by Toni Morrison" },
  { id: 5, label: "Atomic Habits by James Clear" },
];

function App() {
  const [value, setValue] = useState<MultiSelectFieldOption[]>([]);

  return (
    <Flex direction="column" gap="6" style={{ width: 320 }}>
      <MultiSelectFieldSync
        label="Disabled"
        placeholder="Search books..."
        options={options}
        value={[options[0]]}
        onSelectedOptionsChange={setValue}
        disabled
      />
      <MultiSelectFieldSync
        label="Read-only"
        placeholder="Search books..."
        options={options}
        value={[options[0]]}
        onSelectedOptionsChange={setValue}
        readOnly
      />
      <MultiSelectFieldSync
        label="Error"
        placeholder="Search books..."
        options={options}
        value={value}
        onSelectedOptionsChange={setValue}
        error="Please select at least one book"
      />
    </Flex>
  );
}

export default App;
```

Multi Select Field supports standard form field states. Disabled prevents all interaction. Read-only allows viewing selected options without changing the selection. Error highlights validation issues with a message.

### Max rows

multiselectfield-max-rows

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-max-rows?file=src/App.tsx)

```tsx lines theme={null}
import { useState } from "react";
import { Flex } from "@servicetitan/anvil2";
import {
  MultiSelectFieldSync,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";

const options: MultiSelectFieldOption[] = [
  { id: 1, label: "The Martian" },
  { id: 2, label: "Gone Girl" },
  { id: 3, label: "Mistborn" },
  { id: 4, label: "Orient Express" },
  { id: 5, label: "Dune" },
  { id: 6, label: "Beloved" },
  { id: 7, label: "Atomic Habits" },
  { id: 8, label: "Sapiens" },
];

function App() {
  const [singleRowValue, setSingleRowValue] =
    useState<MultiSelectFieldOption[]>(options);
  const [max3Value, setMax3Value] = useState<MultiSelectFieldOption[]>(options);
  const [max5Value, setMax5Value] = useState<MultiSelectFieldOption[]>(options);

  return (
    <Flex direction="column" gap="6" style={{ maxWidth: 400 }}>
      <MultiSelectFieldSync
        label="Single row"
        placeholder="Search books..."
        options={options}
        value={singleRowValue}
        onSelectedOptionsChange={setSingleRowValue}
        singleRow
      />
      <MultiSelectFieldSync
        label="Max 3 chips"
        placeholder="Search books..."
        options={options}
        value={max3Value}
        onSelectedOptionsChange={setMax3Value}
        maxChips={3}
      />
      <MultiSelectFieldSync
        label="Max 5 chips"
        placeholder="Search books..."
        options={options}
        value={max5Value}
        onSelectedOptionsChange={setMax5Value}
        maxChips={5}
      />
    </Flex>
  );
}

export default App;
```

The Select Field can grow in size to fit many selected options. A max row configuration limits how large the field can grow. Set a low max row count when space is tight, and a larger max row when displaying all the options is prioritized.

## Usage Guidelines

| Standard | Requirement |
| - | - |
| DoSelecting from a medium-to-large set | Select multiple options from a medium-to-large set of options |
| DoProviding typeahead search | Provide typeahead search to help users narrow results |
| DoLoading options from a server | Load options from a server with pagination support |
| DoOrganizing options into groups | Organize options into groups or pinned sections |
| DoProviding a Select All action | Provide a Select All action to toggle all options at once |
| DoDisplaying selected values as chips | Display selected values as removable chips |
| Don'tA single item to be selected | There is only a single item to be selected. Use [Select Field](https://anvil.servicetitan.com/docs/components/select-field/web) instead. |

### Alternatives

When there are only a few items to choose from, a [checkbox](https://anvil.servicetitan.com/docs/components/checkbox/web.md) group may be more appropriate. When a particularly complex selection interaction is needed, a [Listbox](https://anvil.servicetitan.com/docs/components/listbox/web.md) in a special layout may be preferred.

#### Multi Select Field vs Combobox

Multi Select Field is the eventual replacement for the [Combobox](https://anvil.servicetitan.com/docs/components/combobox/web.md) component. Use Select Field when looking for features such as Dialog viewing, standardized content display, secondary actions, sectioning, or lazy loading.

Consider using the Combobox if needing a stable component in your application.

#### Multi Select Field vs Select Trigger

MultiSelect Field displays options in a built-in Popover or Dialog with integrated search and filtering. [Select Trigger](https://anvil.servicetitan.com/docs/components/select-trigger/web.md) opens a custom overlay — typically a Dialog — that the implementor fully controls.

### How to Use

#### Labels and help

For guidance on labels, placeholders, and help text, refer to the [Form pattern](https://anvil.servicetitan.com/docs/patterns/forms/web.md).

#### Sorting options

Multi Select Field does not prescribe how options are sorted. Common sorting strategies include alphabetical, time-based, and categorical. Choose a sort order that matches user expectations for the data.

## Content

Content within the Multi Select Field should clearly communicate available options and help users identify the correct selections.

* Use clear, concise option labels that users recognize immediately
* Add descriptions to rich content options when labels alone are insufficient to distinguish items
* Use pinned sections to surface frequently used or contextually relevant options

For additional content guidance, refer to the [Form pattern](https://anvil.servicetitan.com/docs/patterns/forms/web.md).

## Keyboard Interaction

Users can navigate the Multi Select Field using standard keyboard controls. Keyboard behavior differs between combobox mode (search enabled) and select mode (search disabled).

### Search enabled

#### Text field

| Key | Interaction |
| - | - |
| Down Arrow | If the listbox is displayed, moves visual focus to the first option. If the listbox is not displayed, opens it and moves visual focus to the first option. DOM focus remains on the text field. |
| Up Arrow | If the listbox is displayed, moves visual focus to the last option. If the listbox is not displayed, opens it and moves visual focus to the last option. DOM focus remains on the text field. |
| Enter | Toggles the selection state of the focused option. |
| Escape | If the listbox is displayed, closes it. If the listbox is not displayed, clears the text field. |

#### Popup

| Key | Interaction |
| - | - |
| Enter | Toggles the selection state of the focused option. |
| Escape | Closes the popup and returns visual focus to the text field. |
| Down Arrow | Moves visual focus to the next option. Wraps from last to first. |
| Up Arrow | Moves visual focus to the previous option. Wraps from first to last. |

### Search disabled

| Key | Interaction |
| - | - |
| Enter / Space | Opens the listbox. |
| Down Arrow | Opens the listbox and moves focus to the first option. |
| Up Arrow | Opens the listbox and moves focus to the last option. |
| Escape | Closes the listbox. |

### Accessibility

Anvil provides accessibility support for Multi Select Field out of the box. In combobox mode, the component follows the combobox ARIA pattern. In select mode, it follows the listbox ARIA pattern.

For more guidance on building accessible form controls, see [custom component best practices](https://anvil.servicetitan.com/docs/resources/contributing/accessible-custom-components.md).

## Code

> [!WARNING]
>
> Importing `MultiSelectField` from `@servicetitan/anvil2/beta` is
> deprecated. Import from `@servicetitan/anvil2` instead. The beta export will
> be removed in Anvil2 4.0.

**Implementation**

## Overview

The multi-select field family includes two components for different use cases:

* **`MultiSelectField`** — For async data loading with support for pagination (page-based, offset-based, or group-based lazy loading)
  * Includes automatic debouncing of the search input (configurable via the `debounceMs` prop)
  * Includes automatic caching of the search input (configurable via the `cache` prop)
* **`MultiSelectFieldSync`** — For client-side filtering of static option arrays

Both components provide a searchable dropdown interface for selecting multiple options, displaying selected values as chips with adaptive display modes (popover or dialog).

## MultiSelectFieldSync (Static Options)

Use `MultiSelectFieldSync` when you have a static list of options that can be filtered client-side.

```tsx theme={null}
import { useState } from "react";
import { MultiSelectFieldSync } from "@servicetitan/anvil2";

const options = [
  { id: 1, label: "Option One" },
  { id: 2, label: "Option Two" },
  { id: 3, label: "Option Three" },
];

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectFieldSync
      label="Select options"
      placeholder="Search options..."
      options={options}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
    />
  );
};
```

### Filtering and Sorting

By default, `MultiSelectFieldSync` uses [match-sorter](https://github.com/kentcdodds/match-sorter) to filter options by their `label` and `searchText` fields. Results are also ranked by match quality, so the best matches appear first. Before any search is performed, options appear in the order they are supplied.
You can customize this behavior in two ways:

#### Using match-sorter options

Pass a [match-sorter options object](https://github.com/kentcdodds/match-sorter#options) to customize the default filtering and sorting behavior (e.g., change which keys are matched or adjust ranking):

```tsx theme={null}
<MultiSelectFieldSync
  options={options}
  filter={{
    keys: ["label", "searchText"],
    // ...other match-sorter options
  }}
  // ...other props
/>
```

#### Using a custom filter function

Pass a function for full control over both filtering and sort order. The returned array determines the exact order options appear in the dropdown:

```tsx theme={null}
<MultiSelectFieldSync
  options={options}
  filter={(options, searchValue) => {
    return options.filter((option) =>
      option.label?.toLowerCase().includes(searchValue.toLowerCase())
    );
  }}
  // ...other props
/>
```

## MultiSelectField (Async Loading)

Use `MultiSelectField` when options need to be fetched from an API or when dealing with large datasets that require server-side filtering.

### Basic Usage

```tsx theme={null}
import { useState } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectField
      label="Select Tags"
      placeholder="Search tags..."
      loadOptions={async (searchValue) => {
        const response = await fetch(`/api/tags?q=${searchValue}`);
        const tags = await response.json();
        return tags.map((tag) => ({
          id: tag.id,
          label: tag.name,
        }));
      }}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
    />
  );
};
```

### Lazy Loading Modes

`MultiSelectField` supports three lazy loading modes for paginated data:

#### Page-based Pagination

```tsx theme={null}
<MultiSelectField
  lazy="page"
  lazyOptions={{ pageSize: 10 }}
  loadOptions={async (searchValue, pageNumber, pageSize) => {
    const response = await fetch(
      `/api/items?q=${searchValue}&page=${pageNumber}&size=${pageSize}`
    );
    const { data, totalCount } = await response.json();
    return {
      options: data.map((item) => ({ id: item.id, label: item.name })),
      hasMore: pageNumber * pageSize + data.length < totalCount,
    };
  }}
  // ...other props
/>
```

#### Offset-based Pagination

```tsx theme={null}
<MultiSelectField
  lazy="offset"
  lazyOptions={{ limit: 15 }}
  loadOptions={async (searchValue, offset, limit) => {
    const response = await fetch(
      `/api/items?q=${searchValue}&offset=${offset}&limit=${limit}`
    );
    const { data, totalCount } = await response.json();
    return {
      options: data.map((item) => ({ id: item.id, label: item.name })),
      hasMore: offset + limit < totalCount,
    };
  }}
  // ...other props
/>
```

#### Group-based Loading

For loading grouped options incrementally:

```tsx theme={null}
<MultiSelectField
  lazy="group"
  groupToString={(groupValue) => String(groupValue)}
  loadOptions={async (searchValue, previousGroupKey) => {
    const response = await fetch(
      `/api/items?q=${searchValue}&afterGroup=${previousGroupKey || ""}`
    );
    const { data, hasMore } = await response.json();
    return {
      options: data.map((item) => ({
        id: item.id,
        label: item.name,
        group: item.category, // Required for grouped options
      })),
      hasMore,
    };
  }}
  // ...other props
/>
```

## Select All

Enable bulk selection with the `selectAll` prop.

> [!NOTE]
>
> Select All is shown only when the search input is empty.

### MultiSelectField

With `MultiSelectField`, the parent component is responsible for handling the select/deselect logic via `onClick` and managing the `checkState`:

```tsx theme={null}
import { useState } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const allOptions = [
  { id: 1, label: "Option One" },
  { id: 2, label: "Option Two" },
  { id: 3, label: "Option Three" },
];

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  const handleSelectAll = () => {
    if (selectedOptions.length === allOptions.length) {
      setSelectedOptions([]);
    } else {
      setSelectedOptions(allOptions);
    }
  };

  return (
    <MultiSelectField
      label="Select Items"
      loadOptions={async () => allOptions}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
      selectAll={{
        label: "Select All Items",
        onClick: handleSelectAll,
        checkState:
          selectedOptions.length === allOptions.length
            ? "checked"
            : selectedOptions.length > 0
              ? "indeterminate"
              : "unchecked",
      }}
    />
  );
};
```

`checkState` also accepts a function of the current selection, which the field resolves for you. This keeps the checkbox in sync with the selection without recomputing it at the call site:

```tsx theme={null}
selectAll={{
  label: "Select All Items",
  onClick: handleSelectAll,
  checkState: (current) =>
    current.length === 0
      ? "unchecked"
      : current.length >= allOptions.length
        ? "checked"
        : "indeterminate",
}}
```

### MultiSelectFieldSync

`MultiSelectFieldSync` provides a simplified `selectAll` prop. Click handling and check state are managed automatically:

```tsx theme={null}
// Enable with default label
<MultiSelectFieldSync
  label="Select Tags"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectAll
/>

// Enable with custom label
<MultiSelectFieldSync
  label="Select Tags"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectAll={{ label: "Select All Tags" }}
/>

// Enable with dynamic label based on check state
<MultiSelectFieldSync
  label="Select Tags"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectAll={{ label: (checked) => checked ? "Deselect All" : "Select All" }}
/>
```

## Select Filtered

Enable selection of options matching the current search term with the `selectFiltered` prop. Select All and Select Filtered are mutually exclusive: Select All is shown when the search input is empty, and Select Filtered is shown when a search term is active. The default label dynamically includes the search term (e.g., `Select items matching "appl"`).

### MultiSelectField

With `MultiSelectField`, provide a function that receives the current `searchValue` and returns a config object with `onClick`, `checkState`, and an optional `label`. Since the function receives the search value, you can use it to filter options and compute the checked state inline:

```tsx theme={null}
import { useState } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const allOptions = [
  { id: 1, label: "Apple" },
  { id: 2, label: "Apricot" },
  { id: 3, label: "Banana" },
  { id: 4, label: "Cherry" },
];

const filterBySearch = (searchValue: string) =>
  allOptions.filter((opt) =>
    opt.label.toLowerCase().includes(searchValue.toLowerCase()),
  );

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);
  const selectedIds = new Set(selectedOptions.map((o) => o.id));

  return (
    <MultiSelectField
      label="Fruits"
      loadOptions={async (searchValue) => filterBySearch(searchValue)}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
      selectFiltered={(searchValue) => {
        const filtered = filterBySearch(searchValue);
        const allFilteredSelected =
          filtered.length > 0 &&
          filtered.every((o) => selectedIds.has(o.id));
        const someFilteredSelected = filtered.some((o) =>
          selectedIds.has(o.id),
        );
        return {
          onClick: () => {
            if (allFilteredSelected) {
              const filteredIds = new Set(filtered.map((o) => o.id));
              setSelectedOptions(
                selectedOptions.filter((o) => !filteredIds.has(o.id)),
              );
            } else {
              const merged = [...selectedOptions];
              for (const opt of filtered) {
                if (!selectedIds.has(opt.id)) merged.push(opt);
              }
              setSelectedOptions(merged);
            }
          },
          checkState: allFilteredSelected
            ? "checked"
            : someFilteredSelected
              ? "indeterminate"
              : "unchecked",
        };
      }}
    />
  );
};
```

### MultiSelectFieldSync

`MultiSelectFieldSync` provides a simplified `selectFiltered` prop. Click handling and check state are managed automatically based on the filtered options and current selection:

```tsx theme={null}
// Enable with default dynamic label
<MultiSelectFieldSync
  label="Fruits"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectFiltered
/>

// Enable with custom label based on search value
<MultiSelectFieldSync
  label="Fruits"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectFiltered={(searchValue) => ({
    label: `Select items matching "${searchValue}"`,
  })}
/>

// Combine with selectAll for full bulk selection
<MultiSelectFieldSync
  label="Fruits"
  options={options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  selectAll
  selectFiltered
/>
```

## Chip Display Options

Control how selected options are displayed as chips:

### Single Row Mode

Restrict the field to a single row height. Overflow chips are collapsed into a "+N" indicator:

```tsx theme={null}
<MultiSelectField
  label="Tags"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  singleRow
/>
```

### Max Chips

Limit the number of visible chips regardless of row height:

```tsx theme={null}
<MultiSelectField
  label="Tags"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  maxChips={5}
/>
```

### Chip Customization

Customize the appearance of individual chips using `getChipProps`. The callback receives each selected option and returns partial `ChipProps` (e.g., `color`, `icon`, `avatar`). Core chip props (`label`, `onClose`, `className`, `title`, `size`) are managed by the component and excluded from the callback's return type.

```tsx theme={null}
<MultiSelectField
  label="Users"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  getChipProps={(option) => ({
    color: option.id === "admin" ? "#e53935" : "#1e88e5",
    icon: PersonIcon,
  })}
/>
```

## Display Modes

Control how the options menu is displayed using the `displayMenuAs` prop:

```tsx theme={null}
// Automatically choose based on device (default)
<MultiSelectField displayMenuAs="auto" {...props} />

// Always show as popover (not recommended for mobile)
<MultiSelectField displayMenuAs="popover" {...props} />

// Always show as dialog
<MultiSelectField displayMenuAs="dialog" {...props} />
```

## Caching

`MultiSelectField` caches `loadOptions` results by default. Configure caching behavior:

```tsx theme={null}
// Disable caching
<MultiSelectField cache={{ enabled: false }} {...props} />

// Configure max cache size (default: 15)
<MultiSelectField cache={{ maxSize: 100 }} {...props} />
```

### Clearing the Cache

Use a ref to imperatively clear the cache:

```tsx theme={null}
import { useRef } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const ExampleComponent = () => {
  const multiSelectRef = useRef(null);

  const handleRefresh = () => {
    multiSelectRef.current?.clearCache();
  };

  return (
    <>
      <MultiSelectField ref={multiSelectRef} {...props} />
      <button onClick={handleRefresh}>Refresh Options</button>
    </>
  );
};
```

### Invalidating Options

Call `invalidate()` to clear the cache and reload options from the data source. Use this when the underlying data has changed and the component needs to reflect the update:

```tsx theme={null}
import { useRef } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const ExampleComponent = () => {
  const multiSelectRef = useRef(null);

  const handleDataSourceChange = () => {
    multiSelectRef.current?.invalidate();
  };

  return (
    <MultiSelectField ref={multiSelectRef} {...props} />
  );
};
```

> [!NOTE]
>
> `MultiSelectFieldSync` handles this automatically when its `options` prop changes.

## Initial Load Behavior

Control when options are first loaded with the `initialLoad` prop:

```tsx theme={null}
// Load immediately on mount (default)
<MultiSelectField initialLoad="immediate" {...props} />

// Load when user opens the dropdown
<MultiSelectField initialLoad="open" {...props} />

// Auto (currently equivalent to "immediate")
<MultiSelectField initialLoad="auto" {...props} />
```

## Field States

### Error State

Display validation errors using the `error` prop:

```tsx theme={null}
<MultiSelectField
  label="Categories"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  error={selectedOptions.length === 0 ? "Please select at least one category" : false}
/>
```

### Hint and Description

Provide additional context with `hint` and `description`:

```tsx theme={null}
<MultiSelectField
  label="Categories"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  hint="Select up to 5 categories"
  description="These will be used for filtering"
/>
```

### Required Field

Mark a field as required with the `required` prop:

```tsx theme={null}
<MultiSelectField
  label="Categories"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  required
/>
```

### Disabled and ReadOnly

When `disabled` is set, users cannot interact with the field:

```tsx theme={null}
<MultiSelectField
  label="Categories"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  disabled
/>
```

When `readOnly` is set, users can see the dropdown but cannot change selections:

```tsx theme={null}
<MultiSelectField
  label="Categories"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  readOnly
/>
```

### Prefix and Suffix

Add content before or after the input with `prefix` and `suffix`:

```tsx theme={null}
<MultiSelectField
  label="Tags"
  loadOptions={loadOptions}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
  prefix="#"
  suffix="tags"
/>
```

### Markdown in labels

The `label` prop supports inline markdown: bold (`**text**`), italic (`*text*`), bold and italic (`***text***`), highlight (`==text==`), and code (`` `text` ``).

multiselectfield-markdownlabel

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-markdownlabel?file=src/App.tsx)

```tsx lines expandable theme={null}
import { useState } from "react";
import { Flex } from "@servicetitan/anvil2";
import {
  MultiSelectFieldSync,
  type SelectFieldOption,
} from "@servicetitan/anvil2";

const options = [
  { id: 1, label: "Option A" },
  { id: 2, label: "Option B" },
  { id: 3, label: "Option C" },
];

function App() {
  const [values, setValues] = useState<SelectFieldOption[]>([]);

  return (
    <Flex direction="column" gap="4" style={{ maxWidth: 400 }}>
      <MultiSelectFieldSync
        label="**Bold** label"
        placeholder="Bold"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
      <MultiSelectFieldSync
        label="*Italic* label"
        placeholder="Italic"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
      <MultiSelectFieldSync
        label="***Bold and italic*** label"
        placeholder="Bold and italic"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
      <MultiSelectFieldSync
        label="==Highlight== label"
        placeholder="Highlight"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
      <MultiSelectFieldSync
        label="`Code` label"
        placeholder="Code"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
    </Flex>
  );
}

export default App;
```

### Hide the label

Use `hideLabel` to visually hide the label. The `label` string is converted to an `aria-label` on the input so it remains accessible to screen readers — any inline markdown is stripped to plain text.

multiselectfield-hidelabel

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-hidelabel?file=src/App.tsx)

```tsx lines expandable theme={null}
import { useState } from "react";
import { Flex } from "@servicetitan/anvil2";
import {
  MultiSelectFieldSync,
  type SelectFieldOption,
} from "@servicetitan/anvil2";

const options = [
  { id: 1, label: "Option A" },
  { id: 2, label: "Option B" },
  { id: 3, label: "Option C" },
];

function App() {
  const [values, setValues] = useState<SelectFieldOption[]>([]);

  return (
    <Flex direction="row" gap="2" style={{ maxWidth: 600 }}>
      <MultiSelectFieldSync
        label="First options"
        hideLabel
        placeholder="First options"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
      <MultiSelectFieldSync
        label="Second options"
        hideLabel
        placeholder="Second options"
        options={options}
        value={values}
        onSelectedOptionsChange={setValues}
      />
    </Flex>
  );
}

export default App;
```

## Sizes

Control the size of the field with the `size` prop:

```tsx theme={null}
<MultiSelectField size="small" {...props} />
<MultiSelectField size="medium" {...props} /> {/* default */}
<MultiSelectField size="large" {...props} />
```

## Disabled Options

Individual options can be disabled by setting `disabled: true` on the option:

```tsx theme={null}
const options = [
  { id: 1, label: "Available Option" },
  { id: 2, label: "Unavailable Option", disabled: true },
  { id: 3, label: "Another Available Option" },
];

<MultiSelectField
  label="Select options"
  loadOptions={async () => options}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

## Pinned Options

Pin frequently used or suggested options above the list using the `pinned` prop. Each pinned section requires a `label` and an `options` value, which can be a static array or a dynamic loader function.

### Static Pinned Options

Pass an object with `label` and a static `options` array:

```tsx theme={null}
<MultiSelectField
  label="Books"
  pinned={{
    label: "Favorites",
    options: [
      { id: "fav-1", label: "The Martian" },
      { id: "fav-2", label: "Dune" },
    ],
  }}
  loadOptions={fetchBooks}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

### Dynamic Pinned Options

Pass a function as `options` to compute pinned options based on the current search value. This is useful for AI-powered suggestions or context-aware recommendations:

```tsx theme={null}
<MultiSelectField
  label="Books"
  pinned={{
    label: "AI Suggestions",
    options: async (searchValue) => {
      const suggestions = await fetchAISuggestions(searchValue);
      return suggestions.map((s) => ({ id: s.id, label: s.title }));
    },
  }}
  loadOptions={fetchBooks}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

By default, the loader re-runs whenever the search value changes. Set `searchReactive: false` to call the loader once and reuse the result across all search values:

```tsx theme={null}
<MultiSelectField
  label="Books"
  pinned={{
    label: "Your Favorites",
    options: async () => {
      return await fetchFavorites();
    },
    searchReactive: false,
  }}
  loadOptions={fetchBooks}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

### Multiple Pinned Sections

Pass an array of pinned section objects:

```tsx theme={null}
<MultiSelectField
  label="Books"
  pinned={[
    {
      label: "AI Suggestions",
      options: async (searchValue) => {
        const suggestions = await fetchAISuggestions(searchValue);
        return suggestions.map((s) => ({ id: s.id, label: s.title }));
      },
    },
    {
      label: "Your Favorites",
      options: [
        { id: "fav-1", label: "Dune" },
        { id: "fav-2", label: "Foundation" },
      ],
    },
  ]}
  loadOptions={fetchBooks}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

## Grouping Options

Options can be organized into visual groups by adding a `group` property to each option. Groups appear as labeled sections in the dropdown.

### Basic Grouping

Add a `group` property to options and provide a `groupToString` function to display group labels:

```tsx theme={null}
const options = [
  { id: 1, label: "Apple", group: "fruits" },
  { id: 2, label: "Banana", group: "fruits" },
  { id: 3, label: "Carrot", group: "vegetables" },
  { id: 4, label: "Broccoli", group: "vegetables" },
];

<MultiSelectField
  label="Food"
  loadOptions={async () => options}
  groupToString={(group) =>
    group === "fruits" ? "Fruits" : "Vegetables"
  }
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

### Group Sorting

Use `groupSorter` to control the order of groups. By default, groups appear in the order they are first encountered in the options array. This prop is available on `MultiSelectFieldSync` and non-lazy `MultiSelectField`:

> [!WARNING]
>
> Avoid using `groupSorter` with `lazy="group"`. When groups load incrementally from the server and get re-sorted, the menu content shifts unexpectedly, creating a disorienting user experience. Instead, have your server return groups in the desired order.

```tsx theme={null}
const options = [
  { id: 1, label: "Item A", group: 3 },
  { id: 2, label: "Item B", group: 1 },
  { id: 3, label: "Item C", group: 2 },
];

<MultiSelectField
  label="Items"
  loadOptions={async () => options}
  groupToString={(group) => `Priority ${group}`}
  groupSorter={(a, b) => Number(a) - Number(b)}
  value={selectedOptions}
  onSelectedOptionsChange={setSelectedOptions}
/>
```

## Virtualization

By default, all dropdown options render to the DOM at once. This works well for typical lists but degrades performance with very large option sets as the browser must lay out and paint thousands of elements. Pass `virtualize` to enable windowed rendering, which only renders the items currently visible in the scroll viewport plus a small overscan buffer.

Consider enabling `virtualize` when the dropdown feels sluggish to open or keyboard navigation becomes laggy. These symptoms typically appear around 200–500 items depending on device performance and item complexity (e.g., items with descriptions are heavier). For smaller lists, the default rendering path is sufficient and avoids the overhead of virtual positioning.

Virtualization works with all existing features including lazy loading, pinned options, grouping, select-all/select-filtered bulk actions, and keyboard navigation.

```tsx theme={null}
import { useState } from "react";
import { MultiSelectFieldSync } from "@servicetitan/anvil2";

const options = Array.from({ length: 5000 }, (_, i) => ({
  id: i,
  label: `Option ${i + 1}`,
}));

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectFieldSync
      virtualize
      selectAll
      label="Large dataset"
      placeholder="Search options..."
      options={options}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
    />
  );
};
```

## Disabling Search

Pass `disableSearch` to replace the searchable text input with a non-editable select trigger. The field uses the listbox ARIA pattern instead of combobox, providing a simpler interaction when typing to filter adds no value.

This is useful when the option list is short and well-known or you are integrating with an API that does not support search.

```tsx theme={null}
import { useState } from "react";
import { MultiSelectFieldSync } from "@servicetitan/anvil2";

const options = [
  { id: 1, label: "Red" },
  { id: 2, label: "Green" },
  { id: 3, label: "Blue" },
  { id: 4, label: "Yellow" },
];

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectFieldSync
      disableSearch
      selectAll
      label="Colors"
      placeholder="Select colors"
      options={options}
      value={selectedOptions}
      onSelectedOptionsChange={setSelectedOptions}
    />
  );
};
```

> [!NOTE]
>
> When `disableSearch` is enabled, `selectFiltered` has no effect since there is no search input to produce filtered results.

## Adding New Items

Provide an `onAddNewItem` handler to render an "Add new item" button below the option list. This affordance lets users create a value that does not exist yet — a new tag, label, or attribute — quickly from the field.

The button sits in a footer region inside the menu. Clicking or activating it via keyboard closes the menu and invokes the `onAddNewItem` handler with the current search text.

From here, it is your responsibility to launch a `Dialog` (or `Drawer`, or any other overlay) for collecting the new item's details, append the result to the option source, invalidate the cache, and update selection state.

You may pair `onAddNewItem` with `addItemLabel` to control the button text. The label accepts a static node or a function of the current search text — for example, returning `Add "foo"` when the user has typed `foo`.

When `addItemLabel` is a function, return `null` (or `undefined`) to hide the button for the current search text. Use this when the affordance should only appear for valid input — for example, showing "Add email" only after a well-formed address is typed:

```tsx theme={null}
addItemLabel={(searchText) =>
  isValidEmail(searchText) ? `Add "${searchText}"` : null
}
onAddNewItem={openAddEmailDialog}
```

multiselectfield-add-new-item

[StackBlitz demo](https://stackblitz.com/github/servicetitan/anvil2-docs-live-code/tree/main/examples/multiselectfield-add-new-item?file=src/App.tsx)

```tsx lines expandable theme={null}
import { useEffect, useRef, useState } from "react";
import {
  MultiSelectField,
  type MultiSelectFieldHandle,
  type MultiSelectFieldOption,
} from "@servicetitan/anvil2";
import { Button, Dialog, Flex, TextField } from "@servicetitan/anvil2";

type Tag = MultiSelectFieldOption & { color: string };

function App() {
  const [tags, setTags] = useState<Tag[]>([
    { id: "bug", label: "bug", color: "#e53935" },
    { id: "feature", label: "feature", color: "#1e88e5" },
    { id: "needs-info", label: "needs info", color: "#f9a825" },
    { id: "good-first-issue", label: "good first issue", color: "#43a047" },
  ]);
  const [selectedTags, setSelectedTags] = useState<Tag[]>([]);
  const fieldRef = useRef<MultiSelectFieldHandle>(null);
  const containerRef = useRef<HTMLDivElement>(null);

  const [dialogOpen, setDialogOpen] = useState(false);
  const [draftLabel, setDraftLabel] = useState("");

  // Open the menu on mount so the Add-new button is visible in screenshots.
  useEffect(() => {
    const timer = setTimeout(() => {
      const trigger = containerRef.current?.querySelector("input");
      trigger?.focus();
      trigger?.click();
    }, 100);
    return () => clearTimeout(timer);
  }, []);

  const openTagDialog = (initialLabel: string) => {
    setDraftLabel(initialLabel.trim().toLowerCase().replace(/\s+/g, "-"));
    setDialogOpen(true);
  };

  const saveTag = () => {
    const newTag: Tag = {
      id: draftLabel,
      label: draftLabel,
      color: "#43a047",
    };
    setTags((prev) => [...prev, newTag]);
    setSelectedTags((prev) => [...prev, newTag]);
    fieldRef.current?.invalidate();
    setDialogOpen(false);
  };

  return (
    <div ref={containerRef} style={{ minWidth: "384px", minHeight: "420px" }}>
      <MultiSelectField
        ref={fieldRef}
        label="Tags"
        placeholder="Search or add a tag..."
        initialLoad="open"
        loadOptions={async (searchValue) =>
          searchValue
            ? tags.filter((t) =>
                t.label.toLowerCase().includes(searchValue.toLowerCase()),
              )
            : tags
        }
        value={selectedTags}
        onSelectedOptionsChange={(opts) => setSelectedTags(opts as Tag[])}
        getChipProps={(option) => {
          const tag = tags.find((t) => t.id === option.id);
          return { color: tag?.color };
        }}
        addItemLabel={(searchText) =>
          searchText ? `Create tag "${searchText}"` : "Create new tag"
        }
        onAddNewItem={openTagDialog}
      />

      <Dialog open={dialogOpen} onClose={() => setDialogOpen(false)}>
        <Dialog.Header>Create new tag</Dialog.Header>
        <Dialog.Content>
          <Flex direction="column" gap="3">
            <TextField
              label="Tag name"
              description="Lowercase, hyphenated."
              required
              value={draftLabel}
              onChange={(e) => setDraftLabel(e.target.value)}
            />
          </Flex>
        </Dialog.Content>
        <Dialog.Footer>
          <Dialog.CancelButton appearance="ghost">Cancel</Dialog.CancelButton>
          <Button
            appearance="primary"
            onClick={saveTag}
            disabled={!draftLabel.trim()}
          >
            Create tag
          </Button>
        </Dialog.Footer>
      </Dialog>
    </div>
  );
}

export default App;
```

> [!NOTE]
>
> Call `invalidate()` on the imperative handle after appending the new option.
> This clears the cached search results and forces a refetch the next time the
> menu opens, so the new item appears immediately. `clearCache()` alone wipes
> the cache but keeps the previously displayed options on screen until
> something else triggers a reload.

## Testing

The field's interactive sub-elements carry a stable `data-anv-part` attribute so end-to-end tests can target them directly. The library owns the part names; you supply the instance identifier.

Attach your own `data-*` attribute (such as `data-cy` or `data-testid`) to the field. It is forwarded to the field's wrapper element, letting you scope queries to a single instance:

```tsx theme={null}
<MultiSelectField data-cy="tag-picker" label="Tags" {...rest} />
```

```ts theme={null}
// Target the input within this specific field
cy.get('[data-cy="tag-picker"] [data-anv-part="input"]').type("urgent");

// Assert the number of selected-value chips
cy.get('[data-cy="tag-picker"] [data-anv-part="chip"]').should("have.length", 2);
```

| `data-anv-part` | Element |
| - | - |
| `input` | Text input (searchable mode) |
| `trigger` | Trigger element (`disableSearch` mode) |
| `chip` | A selected-value chip |
| `overflow-chip` | "+N" indicator when selected chips overflow |
| `clear-button` | Button that clears the selection |
| `toggle-button` | Button that opens and closes the menu |
| `menu` | Option list container |
| `option` | An individual option row |
| `dialog` | Menu container in dialog display mode |
| `popover` | Menu container in popover display mode |

> [!NOTE]
>
> The menu renders in the browser's top layer (`menu`, `option`, `dialog`, and `popover` parts), outside the field's wrapper. Descendant queries scoped to your wrapper attribute will not match these parts. Target them by their part attribute directly, or scope to the menu's id — `#{id}-popover` or `#{id}-dialog`, where `{id}` is the field's `id` prop. Only one menu is open at a time.

**MultiSelectField Props**

## `MultiSelectField` Props

```tsx theme={null}
import { useState } from "react";
import { MultiSelectField } from "@servicetitan/anvil2";

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectField
      label="Search users"
      loadOptions={async (searchValue) => {
        const response = await fetch(`/api/users?q=${searchValue}`);
        const users = await response.json();
        return users.map((user) => ({
          id: user.id,
          label: user.name,
        }));
      }}
      onSelectedOptionsChange={setSelectedOptions}
      value={selectedOptions}
    />
  );
};
```

**label** `string` *required*

The label of the multi-select field. Supports inline markdown formatting.

**labelAiMark** `boolean | AiMarkWithTooltipOrPopoverConfig`

Displays an AI mark next to the label. Use `true` for the icon only, or pass tooltip or popover configuration. See [AI Marks](https://anvil.servicetitan.com/docs/utilities/web/ai-marks.md).

**loadOptions** `function` *required*

Function to load options. The signature depends on the `lazy` mode:

* **Non-lazy**: `(searchValue: string) => MultiSelectFieldOption[] | Promise<MultiSelectFieldOption[]>`
* **Page-based**: `(searchValue: string, pageNumber: number, pageSize: number) => { options: MultiSelectFieldOption[], hasMore?: boolean }`
* **Offset-based**: `(searchValue: string, offset: number, limit: number) => { options: MultiSelectFieldOption[], hasMore?: boolean }`
* **Group-based**: `(searchValue: string, previousGroupKey: string | number | null) => { options: MultiSelectFieldGroupedOption[], hasMore?: boolean }`

**onSelectedOptionsChange** `(options: MultiSelectFieldOption[]) =\> void` *required*

Callback fired when the selected options change. Receives the new array of selected options.

**value** `MultiSelectFieldOption[]` *required*

The currently selected options. Must be controlled state.

**addItemLabel** `ReactNode | (searchText: string) =\> ReactNode`

Label rendered inside the "Add new item" button. May be a static node or a callback that receives the current search text and returns a dynamic label (for example, `Add "${searchText}"`). When the callback returns `null` or `undefined`, the button is not rendered — use this to hide the affordance until the search text is valid (for example, a well-formed email). Defaults to `"Add new item"` when omitted but `onAddNewItem` is provided.

**cache** `MultiSelectFieldCacheOptions`

Configuration for caching `loadOptions` results:

* `enabled` — Whether caching is enabled (default: `true`)
* `maxSize` — Maximum number of search values to cache before clearing (default: `15`)

**className** `string`

Custom CSS class name for the wrapper element.

**debounceMs** `number` (default: 200)

Milliseconds to debounce search input before calling `loadOptions`.

**description** `ReactElement | string`

Description text displayed below the input field.

**disableSearch** `boolean` (default: false)

Replaces the searchable text input with a non-editable select trigger. Uses the listbox ARIA pattern instead of combobox. When combined with `displayMenuAs="dialog"`, the search input in the dialog header is also removed. The `selectAll` bulk action remains available; `selectFiltered` has no effect.

**disabled** `boolean` (default: false)

Whether the field is disabled. When disabled, the field cannot be interacted with and the dropdown cannot open.

**displayMenuAs** `'auto' | 'popover' | 'dialog'` (default: auto)

How to display the options menu:

* `auto` — Popover on desktop, dialog on mobile
* `popover` — Always display as popover
* `dialog` — Always display as dialog

**error** `ReactElement | string | boolean`

Error state for the field. When `true`, shows error styling. When a string or ReactElement, also displays as an error message below the field.

**errorAriaLive** `'off' | 'assertive' | 'polite'` (default: assertive)

Controls the `aria-live` behavior for error messages. See [MDN docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-live).

**groupSorter** `(a: MultiSelectFieldGroupByValue, b: MultiSelectFieldGroupByValue) =\> number`

Function to compare two group values for sorting. When provided, groups are sorted using this comparator. Without this, groups appear in the order they are first encountered. Best used with `MultiSelectFieldSync` or non-lazy `MultiSelectField`. Avoid using with `lazy="group"` as it causes the menu to shift unexpectedly when new groups load.

**getChipProps** `(option: MultiSelectFieldOption) =\> MultiSelectFieldChipProps`

Callback to customize chip appearance for each selected option. Returns partial chip props such as `color`, `icon`, or `avatar`. Core props (`label`, `onClose`, `className`, `title`, `size`) are managed by the component and excluded from this type.

**groupToString** `(groupValue: MultiSelectFieldGroupByValue) =\> string`

Function to convert group values to display labels. Only used with grouped options. `MultiSelectFieldGroupByValue` is `string | number`.

**hideLabel** `boolean` (default: false)

Visually hides the label above the input while keeping it accessible to screen readers. Note: This does not affect the label displayed in the adaptive dialog view on mobile devices.

**hint** `ReactElement | string`

Hint text displayed below the input field.

**id** `string`

The id of the multi-select field.

**initialLoad** `'auto' | 'immediate' | 'open'` (default: auto)

Controls when `loadOptions` is first called:

* `auto` — Currently equivalent to `immediate`
* `immediate` — Load on component mount
* `open` — Load when dropdown is opened

**isHighlighted** `boolean` (default: false)

When `true`, applies a subdued primary background to draw attention to the field.

**lazy** `'page' | 'offset' | 'group' | false` (default: false)

Enables lazy loading with the specified pagination strategy.

**lazyOptions** `object`

Configuration for lazy loading:

* **Page mode**: `{ pageSize?: number }` (default pageSize: 20)
* **Offset mode**: `{ limit?: number }` (default limit: 20)
* **Group mode**: `{}`

**maxChips** `number` (default: 10)

Maximum number of chips to display before showing a "+N" indicator. Applies regardless of `singleRow` setting.

**moreInfo** `ReactNode`

Additional information displayed in a tooltip next to the label. Renders an info icon button that shows the content on hover or focus.

**onAddNewItem** `(searchText: string) =\> void`

Click handler for the "Add new item" button. The button is only rendered when this prop is provided. Receives the current search text. The menu closes synchronously on click and the handler runs immediately after — typically opening a Dialog or Drawer to collect the new item's details. Consumers own overlay presentation, focus return, option list updates, and selection state. See the [Adding New Items](#adding-new-items) section for a full example.

**pinned** `MultiSelectFieldPinnedOptions`

Options to pin to the top of the list. Accepts a single section object or an array of section objects. Each section requires:

* `label` — Display label for the section header
* `options` — Static array (`MultiSelectFieldOption[]`) or dynamic loader function (`(searchValue: string) => MultiSelectFieldOption[] | Promise<MultiSelectFieldOption[]>`)
* `searchReactive` — (Optional) Whether to re-call the loader when the search value changes. Defaults to `true`. Set to `false` to call the loader once and reuse the result.
* `cacheSize` — (Optional) Maximum number of search results to cache per section. Defaults to `15`. Only applies when `searchReactive` is `true`.

**placeholder** `string`

Placeholder text for the input field.

**prefix** `string | ReactElement`

Content to display before the input field.

**readOnly** `boolean` (default: false)

Whether the field is read-only. When read-only, the dropdown can open to view options but selections cannot be changed.

**required** `boolean` (default: false)

Whether the field is required. Shows a red asterisk (\*) next to the label.

**selectAll** `BulkActionConfig`

Configuration for the "Select All" option. Pass exactly one of `onClick` or `compute`:

* `label` — The label to display (default: "Select All")
* `onClick` — Callback when clicked. Parent component commits the next selection via `onSelectedOptionsChange`.
* `compute(current) => next | Promise<next>` — The field invokes `compute` with the current selection and commits the returned array. While a returned promise is pending, the row shows a loading state, option rows are disabled, and stale resolutions are discarded.
* `checkState` — State: `true`/`"checked"`, `false`/`"unchecked"`, or `"indeterminate"`. Also accepts a function `(current: SelectFieldOption[]) => boolean | CheckState` that derives the state from the current selection.

**selectFiltered** `(searchValue: string) =\> BulkActionConfig`

Function that receives the current search value and returns configuration for the "Select Filtered" option (mutually exclusive with `selectAll`, shown when a search term is active). Accepts the same `onClick` / `compute` choice as `selectAll`:

* `label` — The label to display. Default: `Select items matching "${searchValue}"`
* `onClick` or `compute` — See `selectAll` above.
* `checkState` — State: `true`/`"checked"`, `false`/`"unchecked"`, or `"indeterminate"`. Also accepts a function `(current: SelectFieldOption[]) => boolean | CheckState` that derives the state from the current selection.

**singleRow** `boolean` (default: false)

When true, restricts the field to a single row height. Overflow chips collapse into a "+N" indicator.

**size** `'small' | 'medium' | 'large'`

The size of the multi-select field.

**style** `CSSProperties`

Custom inline styles for the wrapper element.

**suffix** `string | ReactElement`

Content to display after the input field.

**virtualize** `boolean` (default: false)

Enables windowed rendering for the dropdown list. Improves performance for large option sets by only rendering visible items. Consider enabling when the dropdown feels sluggish to open or keyboard navigation becomes laggy, typically around 200–500+ items.

**MultiSelectFieldSync Props**

## `MultiSelectFieldSync` Props

`MultiSelectFieldSync` accepts all props from `MultiSelectField` except `loadOptions`, `lazy`, `debounceMs`, `cache`, and `initialLoad`, plus the following:

```tsx theme={null}
import { useState } from "react";
import { MultiSelectFieldSync } from "@servicetitan/anvil2";

const options = [
  { id: 1, label: "Option One" },
  { id: 2, label: "Option Two" },
  { id: 3, label: "Option Three" },
];

const ExampleComponent = () => {
  const [selectedOptions, setSelectedOptions] = useState([]);

  return (
    <MultiSelectFieldSync
      label="Select options"
      onSelectedOptionsChange={setSelectedOptions}
      options={options}
      value={selectedOptions}
    />
  );
};
```

**label** `string` *required*

The label of the multi-select field. Supports inline markdown formatting.

**labelAiMark** `boolean | AiMarkWithTooltipOrPopoverConfig`

Displays an AI mark next to the label. Use `true` for the icon only, or pass tooltip or popover configuration. See [AI Marks](https://anvil.servicetitan.com/docs/utilities/web/ai-marks.md).

**onSelectedOptionsChange** `(options: MultiSelectFieldOption[]) =\> void` *required*

Callback fired when the selected options change. Receives the new array of selected options.

**options** `MultiSelectFieldOption[]` *required*

The array of options to display in the multi-select field.

**value** `MultiSelectFieldOption[]` *required*

The currently selected options. Must be controlled state.

**addItemLabel** `ReactNode | (searchText: string) =\> ReactNode`

Label rendered inside the "Add new item" button. May be a static node or a callback that receives the current search text and returns a dynamic label (for example, `Add "${searchText}"`). When the callback returns `null` or `undefined`, the button is not rendered — use this to hide the affordance until the search text is valid (for example, a well-formed email). Defaults to `"Add new item"` when omitted but `onAddNewItem` is provided.

**className** `string`

Custom CSS class name for the wrapper element.

**description** `ReactElement | string`

Description text displayed below the input field.

**disableSearch** `boolean` (default: false)

Replaces the searchable text input with a non-editable select trigger. Uses the listbox ARIA pattern instead of combobox. When combined with `displayMenuAs="dialog"`, the search input in the dialog header is also removed. The `selectAll` bulk action remains available; `selectFiltered` has no effect.

**disabled** `boolean` (default: false)

Whether the field is disabled. When disabled, the field cannot be interacted with and the dropdown cannot open.

**displayMenuAs** `'auto' | 'popover' | 'dialog'` (default: auto)

How to display the options menu.

**error** `ReactElement | string | boolean`

Error state for the field. When `true`, shows error styling. When a string or ReactElement, also displays as an error message below the field.

**errorAriaLive** `'off' | 'assertive' | 'polite'` (default: assertive)

Controls the `aria-live` behavior for error messages.

**filter** `function | MatchSorterOptions`

Controls how options are filtered and sorted when the user types a search value. Can be:

* A function: `(options: MultiSelectFieldOption[], searchValue: string) => MultiSelectFieldOption[]` — receives all options and returns the filtered subset in the desired display order
* A [match-sorter options object](https://github.com/kentcdodds/match-sorter#options) to customize the default match-sorter behavior (e.g., which keys to match against, ranking strategy)

Before any search is performed, options appear in the order they are supplied. Default: Filters by `label` and `searchText` fields using match-sorter, with results ranked by match quality.

**groupSorter** `(a: MultiSelectFieldGroupByValue, b: MultiSelectFieldGroupByValue) =\> number`

Function to compare two group values for sorting. When provided, options are sorted by group using this comparator, then by match-sort order within each group. Ungrouped options appear last.

**getChipProps** `(option: MultiSelectFieldOption) =\> MultiSelectFieldChipProps`

Callback to customize chip appearance for each selected option. Returns partial chip props such as `color`, `icon`, or `avatar`. Core props (`label`, `onClose`, `className`, `title`, `size`) are managed by the component and excluded from this type.

**groupToString** `(groupValue: MultiSelectFieldGroupByValue) =\> string`

Function to convert group values to display labels. Only used with grouped options. `MultiSelectFieldGroupByValue` is `string | number`.

**hideLabel** `boolean` (default: false)

Visually hides the label above the input while keeping it accessible to screen readers. Note: This does not affect the label displayed in the adaptive dialog view on mobile devices.

**hint** `ReactElement | string`

Hint text displayed below the input field.

**id** `string`

The id of the multi-select field.

**maxChips** `number` (default: 10)

Maximum number of chips to display before showing a "+N" indicator.

**moreInfo** `ReactNode`

Additional information displayed in a tooltip next to the label. Renders an info icon button that shows the content on hover or focus.

**onAddNewItem** `(searchText: string) =\> void`

Click handler for the "Add new item" button. The button is only rendered when this prop is provided. Receives the current search text. The menu closes synchronously on click and the handler runs immediately after — typically opening a Dialog or Drawer to collect the new item's details. Consumers own overlay presentation, focus return, option list updates, and selection state. See the [Adding New Items](#adding-new-items) section for a full example.

**pinned** `MultiSelectFieldPinnedOptions`

Options to pin to the top of the list. Accepts the same section object format as `MultiSelectField`'s `pinned` prop.

**placeholder** `string`

Placeholder text for the input field.

**prefix** `string | ReactElement`

Content to display before the input field.

**readOnly** `boolean` (default: false)

Whether the field is read-only. When read-only, the dropdown can open to view options but selections cannot be changed.

**required** `boolean` (default: false)

Whether the field is required. Shows a red asterisk (\*) next to the label.

**selectAll** `boolean | \{ label?: string | ((checked: boolean) =\> string) \}`

Enables the "Select All" option at the top of the list. Can be:

* `true` — Enable with default label "Select All"
* `{ label: "Custom Label" }` — Enable with custom static label
* `{ label: (checked) => checked ? "Deselect All" : "Select All" }` — Enable with dynamic label based on check state

Click handling and check state are managed automatically based on comparing `options` with `value`.

**selectFiltered** `boolean | (searchValue: string) =\> \{ label?: string \}`

Enables the "Select Filtered" option when a search term is active (mutually exclusive with `selectAll`). Can be:

* `true` — Enable with default dynamic label
* `(searchValue) => ({ label })` — A function that receives the search value and returns a config with an optional custom label

Click handling and check state are managed automatically based on comparing filtered options with `value`.

**singleRow** `boolean` (default: false)

When true, restricts the field to a single row height. Overflow chips collapse into a "+N" indicator.

**size** `'small' | 'medium' | 'large'`

The size of the multi-select field.

**style** `CSSProperties`

Custom inline styles for the wrapper element.

**suffix** `string | ReactElement`

Content to display after the input field.

**virtualize** `boolean` (default: false)

Enables windowed rendering for the dropdown list. Improves performance for large option sets by only rendering visible items. Consider enabling when the dropdown feels sluggish to open or keyboard navigation becomes laggy, typically around 200–500+ items.

**MultiSelectFieldOption Type**

## `MultiSelectFieldOption` Type

Options passed to or returned from `MultiSelectField` must conform to this shape:

```tsx theme={null}
type MultiSelectFieldOption = {
  /** Unique identifier for the option */
  id: string | number;

  /** Display text for the option */
  label: string;

  /** Optional text used for search matching (in addition to label) */
  searchText?: string;

  /** Group key for grouped options (required when using lazy="group") */
  group?: string | number;

  /** Whether the option is disabled and cannot be selected */
  disabled?: boolean;

  /** Optional rich content configuration */
  content?: {
    title?: string;
    description?: string;
    chips?: Pick<ChipProps, "label" | "color" | "textWrap">[];
    avatar?: Pick<AvatarProps, "name" | "status" | "color" | "image">;
    icon?: Pick<IconProps, "svg" | "color">;
  };
};
```

### Content Properties

The `content` object supports the following optional properties:

* `title` — Replaces the `label` as the primary display text in the dropdown.
* `description` — Secondary text displayed below the title.
* `chips` — Array of chip configurations rendered below the title and description. Each chip accepts `label`, `color`, and `textWrap`.
* `avatar` — Renders an avatar to the left of the option text. Accepts `name`, `status`, `color`, and `image`.
* `icon` — Renders an icon to the right of the option text. Accepts `svg` and `color`.

### Example with Rich Content

```tsx theme={null}
const options: MultiSelectFieldOption[] = [
  {
    id: 1,
    label: "John Doe",
    searchText: "john.doe@example.com",
    content: {
      title: "John Doe",
      description: "Engineering",
    },
  },
  {
    id: 2,
    label: "Jane Smith",
    searchText: "jane.smith@example.com",
    content: {
      title: "Jane Smith",
      description: "Design",
    },
  },
];
```

### Example with Avatar, Icon, and Chips

```tsx theme={null}
import GroupIcon from "@servicetitan/anvil2/assets/icons/material/round/groups.svg";

const options: MultiSelectFieldOption[] = [
  {
    id: 1,
    label: "Anvil Team",
    content: {
      title: "Anvil Team (4)",
      description: "Design system maintainer",
      icon: { svg: GroupIcon },
    },
  },
  {
    id: 2,
    label: "Ergonomic Chair",
    content: {
      title: "Ergonomic Chair",
      description: "Offers support and breathability",
      avatar: { name: "Ergonomic Chair", image: "/images/chair.png" },
      chips: [
        { label: "In Stock" },
        { label: "Popular", color: "#F97316" },
      ],
    },
  },
];
```

### Example with Grouped Options

When using `lazy="group"`, options must include the `group` property:

```tsx theme={null}
const groupedOptions: MultiSelectFieldOption[] = [
  {
    id: 1,
    label: "John Doe",
    group: "Engineering",
  },
  {
    id: 2,
    label: "Jane Smith",
    group: "Design",
  },
  {
    id: 3,
    label: "Bob Johnson",
    group: "Engineering",
  },
];
```

### Example with Disabled Options

```tsx theme={null}
const options: MultiSelectFieldOption[] = [
  {
    id: 1,
    label: "Available Option",
  },
  {
    id: 2,
    label: "Unavailable Option",
    disabled: true,
  },
  {
    id: 3,
    label: "Another Available Option",
  },
];
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.