For the complete documentation index, see 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.
30
Sponsor

Option List

PreviousNext

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

Installation

$ pnpm dlx shadcn@latest add @mcpcn/option-list

Usage

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

Composition

Use the following composition to build an OptionList:

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

OpenUI Integration

Install the OpenUI React packages.

pnpm add @openuidev/react-lang zod

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

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 in the OpenUI documentation.

json-render Integration

Install the json-render React packages.

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

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

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 for the provider and streaming setup.

API Reference

See the Base UI documentation for more information.