Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.4 KB
Raw Blame
---
title: Multi Select
description: Multiple selection component.
component: true
fragment: true
---

<ComponentPreview name="multi-select-demo" description="" peekCode wide />

## Usage

```tsx
import {
  MultiSelector,
  MultiSelectorContent,
  MultiSelectorItem,
  MultiSelectorTrigger,
} from 'ui-patterns/multi-select'
```

```tsx
<MultiSelector
  open={open}
  onOpenChange={setOpen}
  selected={selected}
  onSelectedChange={onSelectedChange}
>
  <MultiSelectorTrigger className="w-72" label="Fruits" />
  <MultiSelectorContent sameWidthAsTrigger>
    <MultiSelectorItem value="Apple">Apple</MultiSelectorItem>
    <MultiSelectorItem value="Banana">Banana</MultiSelectorItem>
    <MultiSelectorItem value="Grape">Grape</MultiSelectorItem>
    <MultiSelectorItem value="Strawberry">Strawberry</MultiSelectorItem>
  </MultiSelectorContent>
</MultiSelector>
```

## Examples

### Disabled

<ComponentPreview name="multi-select-disabled" />

### Without trigger icon

Set `showIcon={false}` to hide the trigger icon.

<ComponentPreview name="multi-select-without-icon" />

### Badge Combo Box

Use `MultiSelectorInput`to add a search input.

<ComponentPreview name="multi-select-combobox" />

### Badge Combo Box with creatable selector

creatable: `boolean`
`creatable` prop on the `MultiSelectorList` component can be used to add a new option if no items match

<ComponentPreview name="multi-select-combobox-creatable" />

### Badge limit

badgeLimit: `number` | `"wrap"`.
`badgeLimit` prop on the `MultiSelectorTrigger` component can be used to limit the number of badges displayed.

<ComponentPreview name="multi-select-badge-limit" />

### Wrapped badge limit

Combine `badgeLimit` with `wrapBadges` to limit the number of badges and allow them to wrap onto additional lines. Use `badgeLimit="wrap"` to show and wrap every selected badge.

<ComponentPreview name="multi-select-badge-limit-wrap" />

### Deletable Badge

Add the `deletableBadge` prop on the `MultiSelectorTrigger` component to enable badge removal directly from the badge.

<ComponentPreview name="multi-select-deletable-badge" />

### Inline search input

Use `mode="inline-combobox"` on the `MultiSelectorTrigger` component to add an inline search input.

<ComponentPreview name="multi-select-inline-search-input" />

### Inside a dialog

Use `mode="inline-combobox"` on the `MultiSelectorTrigger` component to add an inline search input.

<ComponentPreview name="multi-select-in-dialog" />