# Option List

Tag-style option selector with single or multiple selection modes.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview name="option-list" src="examples/option-list-demo.tsx" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @mcpcn/option-list
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps className="mb-0 pt-2">
      <Step>
        Install the component dependencies:
      </Step>

      ```bash
      npm install lucide-react
      ```

      <Step>
        Copy and paste the component into your project.
      </Step>

      <ComponentSource name="option-list" title="components/ui/option-list.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

## Usage [#usage]

```tsx
import {
  OptionList,
  OptionListActions,
  OptionListContent,
  OptionListOptions,
} from "@/components/ui/option-list";
```

```tsx
<OptionList>
  <OptionListContent>
    <OptionListOptions />
    <OptionListActions />
  </OptionListContent>
</OptionList>
```

## Composition [#composition]

Use the following composition to build an `OptionList`:

```text
OptionList
├── OptionListActions
├── OptionListContent
├── OptionListItem
└── OptionListOptions
```

## OpenUI Integration [#openui-integration]

Install the OpenUI React packages.

```bash
pnpm add @openuidev/react-lang zod
```

Add `OptionList` to a component library and map it to the installed component.

```tsx showLineNumbers
import { createLibrary, defineComponent } from "@openuidev/react-lang";
import { z } from "zod/v4";

import {
  OptionList,
  OptionListActions,
  OptionListContent,
  OptionListOptions,
} from "@/components/ui/option-list";

const OpenUIOptionList = defineComponent({
  name: "OptionList",
  description:
    "Tag-style option selector with single or multiple selection modes.",
  props: z.object({}),
  component: () => (
    <OptionList>
      <OptionListContent>
        <OptionListOptions />
        <OptionListActions />
      </OptionListContent>
    </OptionList>
  ),
});

export const option_listLibrary = createLibrary({
  root: "OptionList",
  components: [OpenUIOptionList],
});
```

For richer generated compositions, define the child primitives separately and connect them with `.ref` fields. See [Defining Components](https://www.openui.com/docs/openui-lang/defining-components) in the OpenUI documentation.

## json-render Integration [#json-render-integration]

Install the json-render React packages.

```bash
pnpm add @json-render/core @json-render/react zod
```

Add `OptionList` to a component catalog and map it to the installed component.

```tsx
import { defineCatalog } from "@json-render/core";
import { defineRegistry } from "@json-render/react";
import { schema } from "@json-render/react/schema";
import { z } from "zod";

import {
  OptionList,
  OptionListActions,
  OptionListContent,
  OptionListOptions,
} from "@/components/ui/option-list";

export const catalog = defineCatalog(schema, {
  components: {
    OptionList: {
      props: z.object({}),
      description:
        "Tag-style option selector with single or multiple selection modes.",
    },
  },
});

export const { registry } = defineRegistry(catalog, {
  components: {
    OptionList: () => (
      <OptionList>
        <OptionListContent>
          <OptionListOptions />
          <OptionListActions />
        </OptionListContent>
      </OptionList>
    ),
  },
});
```

Use `catalog.prompt()` to constrain model output, then render the generated spec with the json-render React `Renderer`. See the [json-render Quick Start](https://json-render.dev/docs/quick-start) for the provider and streaming setup.

## API Reference [#api-reference]

See the [Base UI](https://base-ui.com/react/overview/quick-start) documentation for more information.