Choose one value or several from a popup list.
Use a Select when someone needs to choose from a set of options. It handles opening the list, keyboard navigation, selection, and the value submitted with a form. You provide the parts and styles.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const roles = [
{ value: "viewer", label: "Viewer" },
{ value: "commenter", label: "Commenter" },
{ value: "editor", label: "Editor" },
{ value: "admin", label: "Admin" },
]
</script>
<Field>
<FieldLabel>Role</FieldLabel>
<Select placeholder="Select a role">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each roles as role (role.value)}
<SelectItem value={role.value}>
{role.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Installation
npm install @ui-sdk/svelte @ui-sdk/coreComposition
Use the following composition to build a Select:
Select
โโโ SelectLabel
โโโ SelectTrigger
โ โโโ SelectValue
โโโ SelectContent
โโโ SelectItem
โโโ SelectItemStart with a label, a trigger, and a list of items. SelectValue shows the selected item's label inside the trigger. SelectLabel names the trigger; inside a Field, use its FieldLabel instead, as the examples do.
Usage
Import the parts and put them together:
<script lang="ts">
import {
Select,
SelectContent,
SelectItem,
SelectLabel,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
</script>
<Select placeholder="Select a role">
<SelectLabel>Role</SelectLabel>
<SelectTrigger>
<SelectValue />
</SelectTrigger>
<SelectContent>
<SelectItem value="viewer">Viewer</SelectItem>
<SelectItem value="editor">Editor</SelectItem>
</SelectContent>
</Select>Items as Data
Pass an array to items when your options come from data. A string is both the value and the label. Use an object when they differ:
<Select items={["Free", "Pro"]} />
<Select items={[{ value: "pro", label: "Pro plan" }]} />These are option examples; add the label and trigger shown above. items can also include groups and separators, checked with ListData:
import type { ListData } from "@ui-sdk/svelte/select"
const plans: ListData = [
{ value: "free", label: "Free" },
{ type: "separator" },
{ type: "group", label: "Contact sales", items: ["Enterprise"] },
]The select can render bare items from this data. To style them, keep items on Select and render SelectItem parts inside SelectContent, as the example does. Keeping the data on the root also makes labels available before the list opens, including during server rendering.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectGroup,
SelectGroupLabel,
SelectItem,
SelectItemIndicator,
SelectSeparator,
SelectTrigger,
SelectValue,
type ListData,
} from "@ui-sdk/svelte/select"
const plans = [
{ value: "free", label: "Free" },
{ value: "pro", label: "Pro" },
{ value: "team", label: "Team" },
]
const sales = [
{ value: "enterprise", label: "Enterprise" },
{ value: "education", label: "Education", disabled: true },
]
const items: ListData = [
...plans,
{ type: "separator" },
{ type: "group", label: "Contact sales", items: sales },
]
</script>
<Field>
<FieldLabel>Plan</FieldLabel>
<Select {items} defaultValue="pro">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each plans as plan (plan.value)}
<SelectItem value={plan.value}>
{plan.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
<SelectSeparator />
<SelectGroup>
<SelectGroupLabel>Contact sales</SelectGroupLabel>
{#each sales as plan (plan.value)}
<SelectItem value={plan.value} disabled={plan.disabled}>
{plan.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectGroup>
</SelectContent>
</Select>
</Field>Items can change while the list is open. Navigation follows the new order, and selection and highlight stay with their values while those items remain. Removing the highlighted item clears the highlight. Lists and Menus covers shared data shapes.
Groups
Put related items inside SelectGroup and name each group with SelectGroupLabel. SelectSeparator adds a visual break without becoming an option.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectGroup,
SelectGroupLabel,
SelectItem,
SelectItemIndicator,
SelectSeparator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const fonts = [
{
label: "Sans serif",
items: [
{ value: "inter", label: "Inter" },
{ value: "geist", label: "Geist" },
],
},
{
label: "Serif",
items: [
{ value: "source-serif", label: "Source Serif" },
{ value: "lora", label: "Lora" },
],
},
{
label: "Monospace",
items: [
{ value: "geist-mono", label: "Geist Mono" },
{ value: "jetbrains-mono", label: "JetBrains Mono" },
],
},
]
</script>
<Field>
<FieldLabel>Font</FieldLabel>
<Select placeholder="Select a font">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each fonts as group, index (group.label)}
{#if index > 0}
<SelectSeparator />
{/if}
<SelectGroup>
<SelectGroupLabel>{group.label}</SelectGroupLabel>
{#each group.items as item (item.value)}
<SelectItem value={item.value}>
{item.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectGroup>
{/each}
</SelectContent>
</Select>
</Field>Icons
SelectItemIcon keeps an icon separate from the item's text, so it doesn't affect its accessible name, typeahead, or search. Add SelectValueIcon to the trigger to show the selected item's icon there too.
<SelectTrigger>
<SelectValueIcon />
<SelectValue />
</SelectTrigger>The full example marks directional icons with mirror, so they flip in right-to-left layouts. Items containing only an icon still need an aria-label.
<script lang="ts">
import {
CheckIcon,
ChevronDownIcon,
TextAlignCenterIcon,
TextAlignEndIcon,
TextAlignStartIcon,
} from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIcon,
SelectItemIndicator,
SelectTrigger,
SelectValue,
SelectValueIcon,
} from "@ui-sdk/svelte/select"
</script>
<Field>
<FieldLabel>Text alignment</FieldLabel>
<Select defaultValue="start">
<SelectTrigger>
<SelectValueIcon />
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
<SelectItem value="start">
<SelectItemIcon mirror>
<TextAlignStartIcon />
</SelectItemIcon>
Start
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
<SelectItem value="center">
<SelectItemIcon>
<TextAlignCenterIcon />
</SelectItemIcon>
Center
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
<SelectItem value="end">
<SelectItemIcon mirror>
<TextAlignEndIcon />
</SelectItemIcon>
End
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
</SelectContent>
</Select>
</Field>Typeahead
With the trigger focused and closed, typing selects the next matching option without opening the list. With the list open, typing moves the highlight; Enter chooses the highlighted item.
Set an item's label when its content includes extra text that shouldn't be matched. Here, country names match typing; calling codes don't.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const countries = [
{ value: "ar", label: "Argentina", code: "+54" },
{ value: "au", label: "Australia", code: "+61" },
{ value: "at", label: "Austria", code: "+43" },
{ value: "be", label: "Belgium", code: "+32" },
{ value: "br", label: "Brazil", code: "+55" },
{ value: "ca", label: "Canada", code: "+1" },
{ value: "dk", label: "Denmark", code: "+45" },
{ value: "fr", label: "France", code: "+33" },
{ value: "de", label: "Germany", code: "+49" },
{ value: "gr", label: "Greece", code: "+30" },
{ value: "ie", label: "Ireland", code: "+353" },
{ value: "jp", label: "Japan", code: "+81" },
{ value: "es", label: "Spain", code: "+34" },
{ value: "se", label: "Sweden", code: "+46" },
{ value: "ch", label: "Switzerland", code: "+41" },
]
</script>
<Field>
<FieldLabel>Country</FieldLabel>
<Select defaultValue="fr">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each countries as country (country.value)}
<SelectItem value={country.value} label={country.label}>
{country.label}
<span data-slot="hint">{country.code}</span>
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Disabled
A disabled select can't be focused or changed and doesn't submit a value. A read-only select stays focusable and submits its value, but can't change. Keyboard navigation skips disabled items, and they can't be chosen.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const countries = [
{ value: "ca", label: "Canada" },
{ value: "dk", label: "Denmark" },
{ value: "fr", label: "France" },
{ value: "de", label: "Germany" },
{ value: "jp", label: "Japan" },
{ value: "es", label: "Spain" },
]
const fields = [
{ label: "Billing country", disabled: true },
{ label: "Shipping from", readOnly: true },
{ label: "Shipping to" },
]
</script>
<div data-slot="stack">
{#each fields as field (field.label)}
<Field>
<FieldLabel>{field.label}</FieldLabel>
<Select
defaultValue={field.disabled || field.readOnly ? "fr" : null}
placeholder="Select a country"
disabled={field.disabled}
readOnly={field.readOnly}
>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each countries as country (country.value)}
<SelectItem value={country.value} disabled={country.value === "dk"}>
{country.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>
{/each}
</div>Clear Button
placeholder appears while nothing is selected. Add SelectClear to return to that state. Clearing sets a single value to null, or multiple values to an empty array, and returns focus to the trigger.
Keep the clear button beside the trigger: a button can't contain another button. keepMounted lets it stay in the DOM when there is nothing to clear.
<script lang="ts">
import { CheckIcon, ChevronDownIcon, XIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectClear,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
import { useLog } from "./log"
const people = [
{ value: "hollis", label: "Hollis Grant" },
{ value: "ines", label: "Inรจs Moreau" },
{ value: "kofi", label: "Kofi Mensah" },
{ value: "wren", label: "Wren Takahashi" },
{ value: "tomasz", label: "Tomasz Wรณjcik" },
]
const log = useLog()
</script>
<Field>
<FieldLabel>Assignee</FieldLabel>
<Select
defaultValue="ines"
placeholder="Unassigned"
onValueChange={(value, details) =>
log(`value: ${JSON.stringify(value)} (${details.reason})`)}
>
<div data-slot="row">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectClear aria-label="Clear assignee">
<XIcon />
</SelectClear>
</div>
<SelectContent>
{#each people as person (person.value)}
<SelectItem value={person.value}>
{person.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Multiple
Set multiple to select more than one value. The value becomes an array, and choosing an item toggles it while keeping the list open.
<Select multiple defaultValue={["en", "ja"]} />SelectValue exposes the selected labels to its children snippet. Use them to summarize a long selection, as this example does.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
import { useLog } from "./log"
const languages = [
{ value: "en", label: "English" },
{ value: "fr", label: "French" },
{ value: "de", label: "German" },
{ value: "ja", label: "Japanese" },
{ value: "pt", label: "Portuguese" },
{ value: "es", label: "Spanish" },
]
const log = useLog()
</script>
<Field>
<FieldLabel>Languages</FieldLabel>
<Select
multiple
defaultValue={["en", "ja"]}
placeholder="Select languages"
onValueChange={(value) => log(`value: ${JSON.stringify(value)}`)}
>
<SelectTrigger>
<SelectValue>
{#snippet children(state)}
{state.placeholder
? "Select languages"
: state.labels.length > 2
? `${state.labels[0]} and ${state.labels.length - 1} more`
: state.label}
{/snippet}
</SelectValue>
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each languages as language (language.value)}
<SelectItem value={language.value}>
{language.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Select All
Add SelectSelectAll to select or clear every enabled item. It shows a mixed state when only some are selected. Inside a SelectGroup, it applies to that group.
SelectValue maxLabels={2} shows up to two labels and summarizes the remaining values. getMoreLabel lets you write that summary.
<script lang="ts">
import { CheckIcon, ChevronDownIcon, MinusIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectSelectAll,
SelectSeparator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const regions = [
{ value: "us-east", label: "US East" },
{ value: "us-west", label: "US West" },
{ value: "europe", label: "Europe" },
{ value: "asia-pacific", label: "Asia Pacific" },
{ value: "south-america", label: "South America" },
]
</script>
<Field>
<FieldLabel>Regions</FieldLabel>
<Select
multiple
defaultValue={["us-east", "europe", "asia-pacific"]}
placeholder="Select regions"
>
<SelectTrigger>
<SelectValue maxLabels={2} getMoreLabel={(count) => `${count} more`} />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
<SelectSelectAll>
{#snippet children(state)}
Select all
{#if state.checked}
<CheckIcon />
{/if}
{#if state.indeterminate}
<MinusIcon />
{/if}
{/snippet}
</SelectSelectAll>
<SelectSeparator />
{#each regions as region (region.value)}
<SelectItem value={region.value}>
{region.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Search with Groups
Add SelectInput inside SelectContent to filter the options. Put the items in SelectList, so the search field stays outside the scrollable list. SelectEmpty shows when nothing matches.
<SelectContent>
<SelectInput aria-label="Search countries" />
<SelectEmpty>No countries found.</SelectEmpty>
<SelectList><!-- Items go here. --></SelectList>
</SelectContent>Groups with no matching items hide automatically. SelectItemText can highlight the matching text; this example reads state.segments in its render snippet to bold the matches. Closing the popup clears the search.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectEmpty,
SelectGroup,
SelectGroupLabel,
SelectInput,
SelectItem,
SelectItemIndicator,
SelectItemText,
SelectList,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const regions = [
{
label: "Americas",
items: [
{ value: "br", label: "Brazil" },
{ value: "ca", label: "Canada" },
{ value: "mx", label: "Mexico" },
],
},
{
label: "Europe",
items: [
{ value: "fr", label: "France" },
{ value: "de", label: "Germany" },
{ value: "es", label: "Spain" },
],
},
{
label: "Asia Pacific",
items: [
{ value: "au", label: "Australia" },
{ value: "jp", label: "Japan" },
{ value: "sg", label: "Singapore" },
],
},
]
</script>
<Field>
<FieldLabel>Country</FieldLabel>
<Select placeholder="Select a country">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
<SelectInput
aria-label="Search countries"
placeholder="Search countriesโฆ"
/>
<SelectEmpty>No countries found.</SelectEmpty>
<SelectList>
{#each regions as group (group.label)}
<SelectGroup>
<SelectGroupLabel>{group.label}</SelectGroupLabel>
{#each group.items as item (item.value)}
<SelectItem value={item.value} label={item.label}>
<SelectItemText>
{#snippet render({ props, state })}
<span {...props}>
{#each state.segments as segment, index (index)}
{#if segment.match}
<b>{segment.text}</b>
{:else}
{segment.text}
{/if}
{/each}
</span>
{/snippet}
</SelectItemText>
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectGroup>
{/each}
</SelectList>
</SelectContent>
</Select>
</Field>Arrow keys move the highlight while focus stays in the search field. On a touch screen reader, focus moves into the items instead. To show recent choices before a search, pass emptyItems alongside items. Lists and Menus covers filtering options.
Async Search
Use filter={false} when the server already filters your options. Connect query and onQueryChange to your loader, and pass its items and status to Select.
This example uses Async Options to replace stale requests and load another page through onLoadMore. SelectStatus shows loading and result counts. Without a status part, Select announces result counts through the page's live region.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { useAsyncOptions } from "@ui-sdk/svelte/async-options"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectEmpty,
SelectInput,
SelectItem,
SelectItemIndicator,
SelectList,
SelectStatus,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const countryList = [
{ value: "ar", label: "Argentina" },
{ value: "au", label: "Australia" },
{ value: "at", label: "Austria" },
{ value: "be", label: "Belgium" },
{ value: "br", label: "Brazil" },
{ value: "ca", label: "Canada" },
{ value: "cl", label: "Chile" },
{ value: "cn", label: "China" },
{ value: "dk", label: "Denmark" },
{ value: "fi", label: "Finland" },
{ value: "fr", label: "France" },
{ value: "de", label: "Germany" },
{ value: "gr", label: "Greece" },
{ value: "in", label: "India" },
{ value: "ie", label: "Ireland" },
{ value: "it", label: "Italy" },
{ value: "jp", label: "Japan" },
{ value: "mx", label: "Mexico" },
{ value: "nl", label: "Netherlands" },
{ value: "no", label: "Norway" },
{ value: "pt", label: "Portugal" },
{ value: "es", label: "Spain" },
{ value: "se", label: "Sweden" },
{ value: "ch", label: "Switzerland" },
]
function searchCountries(
query: string,
{ signal, page }: { signal: AbortSignal; page: number }
) {
return new Promise<{ items: typeof countryList; hasMore: boolean }>(
(resolve, reject) => {
const timer = setTimeout(() => {
const needle = query.trim().toLowerCase()
const found = countryList.filter((country) =>
country.label.toLowerCase().includes(needle)
)
resolve({
items: found.slice(page * 6, page * 6 + 6),
hasMore: found.length > page * 6 + 6,
})
}, 400)
signal.addEventListener("abort", () => {
clearTimeout(timer)
reject(signal.reason)
})
}
)
}
let query = $state("")
const results = useAsyncOptions(searchCountries, { immediate: true })
</script>
<Field>
<FieldLabel>Country</FieldLabel>
<Select
items={results.state.items}
filter={false}
status={results.state.status}
bind:query
onQueryChange={(next) => results.setQuery(next)}
onLoadMore={results.loadMore}
placeholder="Select a country"
>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
<SelectInput
aria-label="Search countries"
placeholder="Search countriesโฆ"
/>
<SelectEmpty>
{#snippet children(state)}
{#if state.empty && !state.loading}No countries match โ{state.query}โ.{/if}
{/snippet}
</SelectEmpty>
<SelectList>
{#snippet children(state)}
{#each state.items as { value: string; label: string; disabled?: boolean }[] as item (item.value)}
<SelectItem
value={item.value}
label={item.label}
disabled={item.disabled}
>
{item.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
{/snippet}
</SelectList>
<SelectStatus>
{#snippet children(state)}
{state.loading
? "Loadingโฆ"
: state.status === "error"
? "Couldn't load countries."
: `${state.count} shown`}
{/snippet}
</SelectStatus>
</SelectContent>
</Select>
</Field>Object Values
A value can be an object. Tell Select how to identify it, display it, and compare it with another copy:
| Prop | What It Does |
|---|---|
itemToValue | Returns the string used to identify and submit the value. |
itemToLabel | Returns the text shown in the trigger. |
isItemEqualToValue | Matches an item with a selected value that may be a different object. |
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
import { useLog } from "./log"
type Member = { id: number; name: string; email: string }
const members: Member[] = [
{ id: 1, name: "Hollis Grant", email: "hollis@example.com" },
{ id: 2, name: "Inรจs Moreau", email: "ines@example.com" },
{ id: 3, name: "Kofi Mensah", email: "kofi@example.com" },
{ id: 4, name: "Wren Takahashi", email: "wren@example.com" },
]
const log = useLog()
</script>
<Field>
<FieldLabel>Assignee</FieldLabel>
<Select
defaultValue={{ ...members[1] }}
onValueChange={(member) =>
log(`Submits assignee=${member ? member.id : ""}`)}
name="assignee"
itemToValue={(member) => String(member.id)}
itemToLabel={(member) => member.name}
isItemEqualToValue={(item, value) => item.id === value.id}
placeholder="Unassigned"
>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each members as member (member.id)}
<SelectItem value={member}>
<span data-slot="stack">
{member.name}
<span data-slot="hint">{member.email}</span>
</span>
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>Virtualized
For a large list, pass every option through items and render only the visible rows. onHighlight tells your virtualizer which row to bring into view. Give each rendered item its full-list index so the accessibility attributes describe its position correctly.
The example includes its own small row-windowing helpers. You can use the same props with a virtualizer of your choice.
<script lang="ts">
import { ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectList,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const manyItems = Array.from({ length: 10_000 }, (_, index) => ({
value: `item-${index + 1}`,
label: `Item ${index + 1}`,
}))
function visibleRows(
scrollTop: number,
height: number,
count: number,
row: number
) {
const start = Math.max(0, Math.floor(scrollTop / row) - 4)
const end = Math.min(count, Math.ceil((scrollTop + height) / row) + 4)
return { start, end }
}
function scrollForRow(
index: number,
scrollTop: number,
height: number,
row: number
) {
const top = index * row
if (top < scrollTop) {
return top
}
if (top + row > scrollTop + height) {
return top + row - height
}
return scrollTop
}
const row = 32
const height = 288
let scroller: HTMLDivElement | undefined = $state()
let scrollTop = $state(0)
function visible(items: { value: string; label: string }[]) {
const { start, end } = visibleRows(scrollTop, height, items.length, row)
return items
.slice(start, end)
.map((item, offset) => ({ item, index: start + offset }))
}
</script>
<Field>
<FieldLabel>Item</FieldLabel>
<Select
items={manyItems}
placeholder="Select an item"
onHighlight={(value, { index }) => {
const el = scroller
if (el && index >= 0) {
el.scrollTop = scrollForRow(index, el.scrollTop, el.clientHeight, row)
}
}}
>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
<div
bind:this={scroller}
style:height="{height}px"
onscroll={(event) => (scrollTop = event.currentTarget.scrollTop)}
>
<SelectList>
{#snippet children(state)}
<div style:height="{state.items.length * row}px">
{#each visible(state.items as { value: string; label: string }[]) as { item, index } (item.value)}
<SelectItem
value={item.value}
label={item.label}
{index}
style="top: {index * row}px; height: {row}px"
>
{item.label}
</SelectItem>
{/each}
</div>
{/snippet}
</SelectList>
</div>
</SelectContent>
</Select>
</Field>Align Item with Trigger
Set alignItemWithTrigger on SelectContent to place the selected item over the trigger. It falls back to normal popup placement when opened by touch or when there isn't enough room.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Checkbox, CheckboxIndicator } from "@ui-sdk/svelte/checkbox"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const priorities = [
{ value: "urgent", label: "Urgent" },
{ value: "high", label: "High" },
{ value: "medium", label: "Medium" },
{ value: "low", label: "Low" },
{ value: "none", label: "No priority" },
]
let aligned = $state(true)
</script>
<div data-slot="stack">
<div data-slot="controls">
<label data-slot="label">
<Checkbox
checked={aligned}
onCheckedChange={(next) => (aligned = next === true)}
>
<CheckboxIndicator>
<CheckIcon />
</CheckboxIndicator>
</Checkbox>
Align item with trigger
</label>
</div>
<Field>
<FieldLabel>Priority</FieldLabel>
<Select defaultValue="medium">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent alignItemWithTrigger={aligned}>
{#each priorities as priority (priority.value)}
<SelectItem value={priority.value}>
{priority.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>
</div>Scrollable
Limit the content's height and allow vertical scrolling. --available-height tells you how much room the popup has; the highlighted item scrolls into view as you move with the keyboard.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectGroup,
SelectGroupLabel,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const timezones = [
{
label: "North America",
items: [
{ value: "est", label: "Eastern Standard Time" },
{ value: "cst", label: "Central Standard Time" },
{ value: "mst", label: "Mountain Standard Time" },
{ value: "pst", label: "Pacific Standard Time" },
{ value: "akst", label: "Alaska Standard Time" },
{ value: "hst", label: "Hawaii Standard Time" },
],
},
{
label: "Europe & Africa",
items: [
{ value: "gmt", label: "Greenwich Mean Time" },
{ value: "cet", label: "Central European Time" },
{ value: "eet", label: "Eastern European Time" },
{ value: "west", label: "Western European Summer Time" },
{ value: "cat", label: "Central Africa Time" },
{ value: "eat", label: "East Africa Time" },
],
},
{
label: "Asia",
items: [
{ value: "msk", label: "Moscow Time" },
{ value: "ist", label: "India Standard Time" },
{ value: "cst-china", label: "China Standard Time" },
{ value: "jst", label: "Japan Standard Time" },
{ value: "kst", label: "Korea Standard Time" },
{ value: "ist-indonesia", label: "Indonesia Central Standard Time" },
],
},
{
label: "Australia & Pacific",
items: [
{ value: "awst", label: "Australian Western Standard Time" },
{ value: "acst", label: "Australian Central Standard Time" },
{ value: "aest", label: "Australian Eastern Standard Time" },
{ value: "nzst", label: "New Zealand Standard Time" },
{ value: "fjt", label: "Fiji Time" },
],
},
]
</script>
<Field>
<FieldLabel>Time zone</FieldLabel>
<Select placeholder="Select a time zone">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each timezones as group (group.label)}
<SelectGroup>
<SelectGroupLabel>{group.label}</SelectGroupLabel>
{#each group.items as item (item.value)}
<SelectItem value={item.value}>
{item.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectGroup>
{/each}
</SelectContent>
</Select>
</Field>Invalid
Inside a Field, the field's label names the trigger, its description and errors describe it, and its name is used for submission. After invalid submission, the trigger gets aria-invalid and data-invalid.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import {
Field,
FieldDescription,
FieldError,
FieldLabel,
} from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
import { useLog } from "./log"
const methods = [
{ value: "standard", label: "Standard" },
{ value: "express", label: "Express" },
{ value: "overnight", label: "Overnight" },
]
const log = useLog()
function submit(event: SubmitEvent) {
event.preventDefault()
log(
`Submitted shipping=${new FormData(event.currentTarget as HTMLFormElement).get("shipping")}`
)
}
</script>
<form data-slot="stack" onsubmit={submit}>
<Field name="shipping">
<FieldLabel>Shipping method</FieldLabel>
<Select required placeholder="Select a shipping method">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each methods as method (method.value)}
<SelectItem value={method.value}>
{method.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
<FieldDescription>Express arrives in two business days.</FieldDescription>
<FieldError match="valueMissing">Choose a shipping method.</FieldError>
</Field>
<button type="submit" data-variant="solid">Continue</button>
</form>Forms
Set name to include a select in form submission. required blocks submission until something is selected; resetting the form restores defaultValue. Multiple values submit as separate entries under the same name.
The example also uses autoComplete="country" for autofill and form="select-newsletter" to associate the Frequency select with a form it sits outside.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
import { useLog } from "./log"
const countries = [
{ value: "au", label: "Australia" },
{ value: "br", label: "Brazil" },
{ value: "ca", label: "Canada" },
{ value: "fr", label: "France" },
{ value: "de", label: "Germany" },
{ value: "jp", label: "Japan" },
{ value: "es", label: "Spain" },
{ value: "se", label: "Sweden" },
]
const topics = ["Design", "Engineering", "Marketing", "Research", "Sales"]
const frequencies = ["Daily", "Weekly", "Monthly"]
const log = useLog()
function submit(event: SubmitEvent) {
event.preventDefault()
const entries = [
...new FormData(event.currentTarget as HTMLFormElement),
].map(([name, value]) => `${name}=${value}`)
log(`Submitted ${entries.join("&")}`)
}
</script>
<div data-slot="stack">
<form id="select-newsletter" data-slot="stack" onsubmit={submit}>
<Field>
<FieldLabel>Country</FieldLabel>
<Select
name="country"
autoComplete="country"
required
placeholder="Select a country"
>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each countries as country (country.value)}
<SelectItem value={country.value}>
{country.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>
<Field>
<FieldLabel>Topics</FieldLabel>
<Select name="topics" multiple defaultValue={["Design"]}>
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each topics as topic (topic)}
<SelectItem value={topic}>
{topic}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>
</form>
<Field>
<FieldLabel>Frequency</FieldLabel>
<Select name="frequency" form="select-newsletter" defaultValue="Weekly">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each frequencies as frequency (frequency)}
<SelectItem value={frequency}>
{frequency}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>
<div data-slot="row">
<button type="submit" form="select-newsletter" data-variant="solid"
>Save</button
>
<button type="reset" form="select-newsletter">Reset</button>
</div>
</div>Presentation
Use presentation="sheet" to open the options in a bottom sheet, or "auto" to use a sheet on small touch screens. Choosing an item still selects it and closes the single-select list.
The content gets data-presentation, and its render state includes presentation. Use either to give sheet items more space. Keep the sheet's translate property free for its drag behavior, and include safe-area padding at the bottom.
<script lang="ts">
import { CheckIcon, ChevronDownIcon } from "@lucide/svelte"
import { Field, FieldLabel } from "@ui-sdk/svelte/field"
import {
Select,
SelectContent,
SelectItem,
SelectItemIndicator,
SelectTrigger,
SelectValue,
} from "@ui-sdk/svelte/select"
const statuses = [
{ value: "backlog", label: "Backlog" },
{ value: "todo", label: "Todo" },
{ value: "in-progress", label: "In Progress" },
{ value: "in-review", label: "In Review" },
{ value: "done", label: "Done" },
]
</script>
<Field>
<FieldLabel>Status</FieldLabel>
<Select defaultValue="todo" presentation="sheet">
<SelectTrigger>
<SelectValue />
<ChevronDownIcon />
</SelectTrigger>
<SelectContent>
{#each statuses as status (status.value)}
<SelectItem value={status.value}>
{status.label}
<SelectItemIndicator>
<CheckIcon />
</SelectItemIndicator>
</SelectItem>
{/each}
</SelectContent>
</Select>
</Field>A sheet makes the page behind it inert and locks scrolling unless modal={false}. Popups explains the shared presentation options.
Controlled
Use bind:value to own the selection and bind:open to own the popup state. A single value is T | null; with multiple, it is T[]. onValueChange and onOpenChange receive the requested value first and change details second. Call details.cancel() to refuse a change.
State and Events explains this pattern. The reason tables list Select's reasons, including item-press, list-navigation, and clear-press.
Controller
createSelectController() can open, read, or change the select from outside its component. It can also connect a separate trigger. See Controllers for setup and waiting for a popup to close, and the Select controller reference for its methods.
Positioning
Use side, align, and offsets to place the popup. SelectArrow follows the side it lands on. Popups covers anchoring and collisions.
Modal
By default, pressing outside closes the list without activating the element behind it. modal={true} also locks scrolling and makes the page inert. modal={false} allows outside presses through. See Control Dismissal.
Container
The popup uses the top layer without a portal. Use container when it must render in another DOM container. Mounting and Containers covers the shared setup.
Animation
Select keeps closing content mounted until its exit animation finishes. onOpenChangeComplete runs afterward. Use keepMounted when your animation library needs the closed content to remain in the DOM. Styling and Animation covers the lifecycle attributes.
Custom Rendering
Use a render snippet to choose a part's element, or a children snippet to customize its content from state. Parts and Composition explains how props merge. Select's part states are listed under State.
Styling
Use data-highlighted for the active item, data-selected for chosen items, and data-placeholder on the trigger and value while nothing is selected. data-modality="keyboard" on the content tells a keyboard highlight from a pointer one.
--anchor-width matches the trigger's width, and --available-height says how much room the popup has. Use them to size the content.
Each part has a data-slot, such as select-trigger, and its state attributes are listed under Data Attributes.
SelectContent
| Variable | What it holds |
|---|---|
--anchor-width | Width of the anchor, usually the trigger. Use it to match widths. |
--anchor-height | Height of the anchor. |
--available-width | Space beside the popup, up to the viewport edge. Not inherited either. |
--available-height | Space between the anchor and the viewport edge. Use it for max-height. Not inherited, so a child that needs it copies it on the popup, like [--list-height:var(--available-height)], and reads max-h-(--list-height). The first popup registers both names for the whole page with CSS.registerProperty, so they don't inherit anywhere. A page that needs them to inherit calls it first, with inherits: true. An @property rule can't, since a registration in script wins. |
--transform-origin | The point on the anchor the popup opens from. Use it to scale from the right place. |
--arrow-offset | Where the anchor's center falls along the popup's edge, kept arrowPadding from the corners. Position a ::before arrow with it. |
--drawer-progress | While it presents as a sheet: how far open the sheet is, from 0 closed to 1 at its largest snap point. Never past 1. |
--drawer-dim | While it presents as a sheet: how dim the page behind is, from 0 to 1. The backdrop's opacity follows it. |
--drawer-expand | While it presents as a sheet: 0 at the second-largest snap point and below, 1 at the largest. With one snap point, the whole travel. |
--drawer-stack | While it presents as a sheet: how many sheets opened from inside this one are open above it, rising smoothly as each one opens. Push it back with it. |
--sheet-backdrop | Set it yourself: the color the page dims to while it presents as a sheet. Black at 0.2 by default. |
Viewport
| Variable | What it holds |
|---|---|
--keyboard-inset | While it presents as a sheet: how many pixels of the page the on-screen keyboard covers, 0 without one. |
--visual-viewport-width | While it presents as a sheet: the width of the part of the page you can see. |
--visual-viewport-height | While it presents as a sheet: the height of the part of the page you can see, above the keyboard. |
--visual-viewport-top | While it presents as a sheet: how far the part of the page you can see is scrolled from the top of the layout, as when the keyboard pushes it up. |
Data Attributes
SelectList, SelectInput, SelectGroup, SelectGroupLabel, SelectSeparator and SelectValueIcon have no state attributes.
SelectLabel
[data-slot="select-label"]
| Attribute | What it means |
|---|---|
data-disabled | Present when the select is disabled, by its own prop, a field or a <fieldset>. |
data-readonly | Present when the select is read-only. |
data-required | Present when the select is required. |
SelectTrigger
[data-slot="select-trigger"]
| Attribute | What it means |
|---|---|
data-closed | Present while the list is closed, including while it animates out. |
data-disabled | Present when the select or the trigger is disabled. |
data-open | Present while the list is open. |
data-placeholder | Present while nothing is selected, so the placeholder shows. |
data-readonly | Present when the select is read-only. |
data-required | Present when the select is required. |
SelectValue
[data-slot="select-value"]
| Attribute | What it means |
|---|---|
data-placeholder | Present while nothing is selected, so the placeholder shows. |
SelectClear
[data-slot="select-clear"]
| Attribute | What it means |
|---|---|
data-disabled | Present when the select is disabled or read-only. |
SelectContent
[data-slot="select-content"]
| Attribute | What it means |
|---|---|
data-closed | Present while the list is closed, including while it animates out. |
data-presentation | popoversheetHow the list presents this time it's open. |
data-open | Present while the list is open. |
data-starting-style | Present for the first frame. Style the state you animate from. |
data-ending-style | Present while the list animates out. Style the state you animate to. |
data-modality | keyboardpointerWhether the keyboard or a pointer is in use, for focus styles. |
data-has-icons | Present while any item inside holds an icon part, so items without one can line up. |
SelectItem
[data-slot="select-item"]
| Attribute | What it means |
|---|---|
data-selected | Present on selected items, and on the check inside them. |
data-disabled | Present when the item can't be chosen. |
data-highlighted | Present on the item with keyboard focus or under the pointer, or highlighted while focus stays in the search field. |
data-has-icon | Present on an item while it holds an icon part. |
SelectItemText
[data-slot="select-item-text"]
| Attribute | What it means |
|---|---|
data-matched | Present on an item's text while the search matched part of it, which is marked. |
SelectItemIndicator
[data-slot="select-item-indicator"]
| Attribute | What it means |
|---|---|
data-selected | Present on selected items, and on the check inside them. |
SelectSelectAll
[data-slot="select-select-all"]
| Attribute | What it means |
|---|---|
data-disabled | Present when nothing the select-all option covers can be chosen. |
data-unchecked | Present on a select-all option while none of its items is selected. |
data-highlighted | Present on the item with keyboard focus or under the pointer, or highlighted while focus stays in the search field. |
SelectEmpty
[data-slot="select-empty"]
| Attribute | What it means |
|---|---|
data-loading | Present while results load, with status="loading". |
data-empty | Present while no item matches the search. |
SelectStatus
[data-slot="select-status"]
| Attribute | What it means |
|---|---|
data-loading | Present while results load, with status="loading". |
SelectArrow
[data-slot="select-arrow"]
| Attribute | What it means |
|---|---|
data-closed | Present while the list is closed, including while it animates out. |
data-open | Present while the list is open. |
SelectItemIcon
[data-slot="select-item-icon"]
| Attribute | What it means |
|---|---|
data-mirror | Present on an icon that flips in right-to-left text, with mirror. |
API Reference
Props and callbacks are the same as below, as Svelte props. value, open and query can be bound with bind:.
Select
container?DocumentFragment | Element | null- Renders the popup into this element instead of in place, like a container inside a shadow root or an iframe. On web components, a CSS selector. Nested popups stay inside their parent.
open?boolean- Whether the list is open. Pass it to control it.
defaultOpen?boolean- Whether the list starts open, when uncontrolled.
onOpenChange?((open: boolean, details: ChangeDetails<SelectOpenChangeReason>) => void)- Runs when the list wants to open or close.
details.reasonsays why, anddetails.cancel()stops it. onOpenChangeComplete?((open: boolean) => void)- Runs once the list has finished opening or closing, after any animation.
items?ListData<T>- The items as data. Renders the list for you, and lets the trigger show labels and find items by typing before the list has ever opened.
emptyItems?ListData<T>- Items shown instead of
itemswhile the search field is empty, like recent choices. Groups work, like{ type: "group", label: "Recent", items }. Needsitemsand aSelectInput. query?string- The text in the search field, which filters the list. Pass it to control it. Closing the list empties it.
defaultQuery?string- The search field's text at first, when uncontrolled.
onQueryChange?((query: string, details: ChangeDetails<SelectQueryChangeReason>) => void)- Runs when the search field's text wants to change: typing, or closing the list, which empties it.
filter?ListFilter<T>- How a
SelectInputnarrows the list:"contains","startsWith", a function of the item and the text, whose numeric result also sorts data items, orfalseto keep every item, for results a server already filtered. status?AsyncOptionsStatus- Whether results are loading or failed, for the status and empty parts. Sets
aria-busyon the list while loading. onLoadMore?(() => void)- Runs when the highlight or scrolling reaches the last item, so the next page can load, like
createAsyncOptions'sloadMore. Not again for the same items, unless the last load failed. announcement?((change: ListAnnouncement) => string | null | undefined)- What screen readers hear after typing pauses in the search field, when no
SelectStatusis rendered. Return null for nothing. placeholder?string- What the value shows while nothing is selected.
itemToValue?((value: T) => string)- The string an item's value submits as and is identified by, for object values. Strings pass through, and objects use their
valueorid. itemToLabel?((value: T) => string)- The text a value shows in the trigger, for values whose item isn't rendered, like async results.
isItemEqualToValue?((itemValue: T, value: T) => boolean)- Whether an item's value is the selected value, for object values that aren't the same object.
onHighlight?((value: T | null, details: ListHighlightDetails) => void)- Runs when the highlight moves, with the item's index among the visible items, so a virtualized list can scroll to it.
loop?boolean- Whether arrow keys wrap from the last item to the first.
modal?"pointer" | boolean"pointer": an outside press only closes the list.true: also locks scroll and makes the rest of the page inert.false: outside presses reach what they hit.presentation?PresentationSetting<"popover">- How the list presents.
"sheet"slides it up from the bottom of the screen, where it can be swiped away, and"auto"does that on small touch screens. Decided each time it opens; the server renders"popover"for"auto". disabled?boolean- Disables the select like a native one: it can't be focused or changed, and the value isn't submitted.
readOnly?boolean- Keeps the select focusable and its value submitted, but stops changes.
required?boolean- Blocks form submission until a value is selected, with the browser's own message.
name?string- The name the value submits under. Without one, the select submits nothing.
form?string- The id of a form to belong to, when the select isn't inside that form.
autoComplete?string- A hint for the browser's autofill, like
"country". controller?object- Opens, closes, reads and sets the select from anywhere. Create one with
createSelectController(). dismissible?boolean- Whether Escape, an outside press, focus or the window leaving, Android's back gesture and a sheet's swipe can close it. Triggers, Close parts and the controller always can. Pass
falsewhile it holds unsaved work, and ask inonDismissAttempt. onDismissAttempt?function- Runs when
dismissiblerefused a dismissal made on purpose: Escape, an outside press, back or a swipe. Focus or the window leaving is refused without it. Ask "Discard changes?" here. debug?boolean- Logs every state change with its reason to the console, in development builds.
multiple?boolean- Whether several items can be selected. The value is then a list, and the list stays open as items toggle. Whether several items can be selected.
value?T | T[] | null- The selected value. Pass it to control the select.
nullselects nothing. The selected values. Pass it to control the select. The selected value, or values withmultiple. Pass it to control the select. defaultValue?T | T[] | null- The value selected at first, when uncontrolled. A form reset returns to it. The values selected at first, when uncontrolled. A form reset returns to them. The value or values selected at first, when uncontrolled. A form reset returns to it.
onValueChange?union- Runs when a user, a form reset or a controller wants to change the value.
details.reasonsays why, anddetails.cancel()stops it.
SelectTrigger
A trigger outside the select also takes controller.
disabled?boolean- Stops the trigger from opening the list. A native button can't be focused or pressed.
controller?object- Connects a trigger outside the select to the select with this controller.
SelectValue
placeholder?string- What shows while nothing is selected. Overrides the select's
placeholder. maxLabels?number- With
multiple, how many labels show before the rest are counted, as in "Apple, Banana and 2 more", joined the way the page's language joins lists. getMoreLabel?((count: number) => string)- The words for the labels past
maxLabels.
SelectContent
side?Side- Which side of the anchor the popup opens on. Flips to the other side when there isn't room. Which side of the trigger the list opens on.
align?Align- How the popup lines up with the anchor along that side.
startandendfollow the reading direction. How the list lines up with the trigger along that side. sideOffset?number- Gap between the anchor and the popup, in pixels. Gap between the trigger and the list, in pixels.
alignOffset?number- Shift along the anchor, in pixels. Shift along the trigger, in pixels.
collisionPadding?number- Space to keep from the viewport edges, in pixels.
arrowPadding?number- Space to keep between the arrow and the popup's corners, in pixels.
anchor?string | Anchor | null- Positions the popup against this instead of its trigger: an element, a CSS selector, a point like
{ x, y }, or anything withgetBoundingClientRect(). It's read on every check, so it can move. A controller'sopen({ anchor })wins for that open. container?DocumentFragment | Element | null- Renders the popup into this element instead of in place, like a container inside a shadow root or an iframe. On web components, a CSS selector. Nested popups stay inside their parent.
alignItemWithTrigger?boolean- Whether the list overlaps the trigger so the selected item sits on it, like a native select on macOS. Falls back to opening below when there isn't room, and for touch.
keepMounted?boolean- Whether the list stays in the page, hidden, while closed. For animation libraries that drive the exit from state.
SelectItem
label?string- The text the trigger shows and typing finds, when the content isn't plain text. Not the accessible name: use
aria-labelfor that. disabled?boolean- Keeps the item from being chosen. The keyboard and the pointer skip it. Sets
data-disabledandaria-disabled. index?number- The item's position among all items, for virtualized lists that render only some. Sets
aria-posinsetandaria-setsize. valueT- What the value becomes when the item is chosen. A string, or any value with
itemToValue.
SelectItemIndicator
keepMounted?boolean- Whether the indicator stays in the page while its item isn't selected, so it can be styled or animated in both states.
SelectItemIcon
mirror?boolean- Flips the icon horizontally in right-to-left text, for icons that point a way, like arrows and chevrons. Icons that picture a thing, like a clock or a check, stay as they are.
SelectValueIcon takes no props of its own, and no children.
SelectClear
keepMounted?boolean- Whether the clear button stays in the page while nothing is selected.
SelectInput, SelectEmpty, SelectStatus, SelectItemText and SelectSelectAll
They take no props of their own. A SelectInput turns searching on, SelectItemText marks what the search matched in its item's text, and SelectSelectAll covers its group's items, or every item outside a group. Without a SelectStatus, result counts go to screen readers through the page's shared live region once typing pauses. announcement receives { type: "results", count, query, loading } and returns the words, or null for silence. The default is English: "3 results", "No results" or "Loading".
Items as Data
Each item in items. Groups are { type: "group", label, items } and separators { type: "separator" }.
valueT- Identifies the item, and is what choosing it reports. A string, or any value with
itemToValue. labelstring- The text shown and matched by typeahead and filtering. A select's trigger shows it once chosen.
keywords?string[]- More words filtering matches, like
["team"]for a plan called Pro. disabled?boolean- Keeps the item from being chosen. The keyboard skips it, like in a native select.
State
What render and children snippets receive, per part.
SelectTrigger:
openboolean- Whether the list is open.
disabledboolean- Whether the select is disabled, by itself or by a
<fieldset>. readOnlyboolean- Whether the select keeps its value but refuses changes, from its
readOnlyoption. Setsaria-readonly. requiredboolean- Whether a value must be selected before the form submits, from its
requiredoption. Setsaria-required. placeholderboolean- Whether nothing is selected, so the placeholder shows.
SelectValue:
valueunknown- The selected value: one,
null, or a list withmultiple. labelstring- The selected item's label, the labels joined with commas for several, or with
maxLabels, as a list in the page's language, like "Apple, Banana and 2 more". An empty string for none. labelsstring[]- Each selected item's label, in the order they were selected.
placeholderboolean- Whether nothing is selected, so the placeholder shows.
SelectContent and SelectList:
openboolean- Whether the list is open. False while it animates out.
presentation"popover" | "sheet"- How it presents this time it's open.
multipleboolean | undefined- Whether several items can be selected.
itemsListData<unknown>- The data items that match the search, for rendering a virtualized list yourself.
statusAsyncOptionsStatus- Whether results are loading or failed.
SelectItem:
highlightedboolean- Whether the item has keyboard focus or is under the pointer.
selectedboolean- Whether its value is in the select's value, compared with
isItemEqualToValuewhen you pass one. disabledboolean- Whether the item's own
disabledprop is set. It can't be highlighted or chosen.
SelectItemIndicator:
selectedboolean- Whether its item is selected. While false, the indicator isn't shown unless
keepMountedis set.
SelectItemIcon:
mirrorboolean- Whether it flips in right-to-left text.
SelectClear:
disabledboolean- Whether the select is disabled or read-only, so there's nothing it can clear.
SelectArrow:
openboolean- Whether the list is open.
SelectInput:
openboolean- Whether the list is open.
disabledboolean- Whether the select is disabled, by itself or by a
<fieldset>. A read-only select's search field stays enabled.
SelectItemText:
segmentsMatchSegment[]- The text in pieces, each marked when it matched. Joined, they're the whole text.
matchedboolean- Whether any piece matched.
SelectSelectAll:
checkedboolean- Whether every item it covers is selected.
indeterminateboolean- Whether some of its items are selected, but not all.
highlightedboolean- Whether it's highlighted, by the keyboard or the pointer.
disabledboolean- Whether it can't be used: nothing it covers can be chosen, or choosing them all would pass
maxSelected.
SelectEmpty:
loadingboolean- Whether results are loading.
emptyboolean- Whether no item matches.
querystring- The text the list is filtered by.
SelectStatus:
status"idle" | "loading" | "error"- Whether results are loading or failed.
loadingboolean- Whether results are loading.
countnumber- How many items are visible.
Reasons
details.reason says why the value changed:
item-pressMouseEvent | KeyboardEvent- A member of a collection was chosen: a menu item, a tab, a radio or a checkbox item.
list-navigationKeyboardEvent- Arrow, Home or End keys moved the selection, typing picked an item, or Ctrl or โ with A selected every item of a listbox.
clear-pressMouseEvent | KeyboardEvent- A Clear part was pressed, like on an input, a select or a combobox.
resetnone- A form reset.
restorenone- The browser restored state, like after going back, or a saved value was read back from storage.
imperativenone- A controller or
apicall, or a property set on a web component.
And why the list opened or closed:
item-pressMouseEvent | KeyboardEvent- A member of a collection was chosen: a menu item, a tab, a radio or a checkbox item.
imperativenone- A controller or
apicall, or a property set on a web component. trigger-pressMouseEvent | KeyboardEvent | TouchEvent- Click, tap, Enter or Space on the part that opens, closes or toggles. Arrow keys that open a menu or submenu count too. A tap on a combobox's input that opens a sheet reports its
touchend. outside-pressMouseEvent- A press outside the layer.
escape-keyKeyboardEvent- Escape, or a submenu's close key (ArrowLeft in left-to-right layouts).
close-pressMouseEvent | KeyboardEvent | SubmitEvent- A Close part was pressed, or a form with
method="dialog"was submitted. focus-outKeyboardEvent | FocusEvent- Focus left the layer, or Tab moved it out.
window-blurFocusEvent- The window lost focus.
backEvent- Going back: the Android back button or gesture, or Backspace in an empty command input, which returns to the previous page.
swipePointerEvent | TouchEvent- A swipe gesture: a finger, mouse or pen dragged it.
With dismissible false, the refused dismissals onDismissAttempt reports:
outside-pressMouseEvent- A press outside the layer.
escape-keyKeyboardEvent- Escape, or a submenu's close key (ArrowLeft in left-to-right layouts).
backEvent- Going back: the Android back button or gesture, or Backspace in an empty command input, which returns to the previous page.
swipePointerEvent | TouchEvent- A swipe gesture: a finger, mouse or pen dragged it.
And why the search text changed:
item-pressMouseEvent | KeyboardEvent- A member of a collection was chosen: a menu item, a tab, a radio or a checkbox item.
imperativenone- A controller or
apicall, or a property set on a web component. trigger-pressMouseEvent | KeyboardEvent | TouchEvent- Click, tap, Enter or Space on the part that opens, closes or toggles. Arrow keys that open a menu or submenu count too. A tap on a combobox's input that opens a sheet reports its
touchend. outside-pressMouseEvent- A press outside the layer.
escape-keyKeyboardEvent- Escape, or a submenu's close key (ArrowLeft in left-to-right layouts).
close-pressMouseEvent | KeyboardEvent | SubmitEvent- A Close part was pressed, or a form with
method="dialog"was submitted. focus-outKeyboardEvent | FocusEvent- Focus left the layer, or Tab moved it out.
window-blurFocusEvent- The window lost focus.
backEvent- Going back: the Android back button or gesture, or Backspace in an empty command input, which returns to the previous page.
swipePointerEvent | TouchEvent- A swipe gesture: a finger, mouse or pen dragged it.
input-changeEvent- Typing, pasting or dropping changed a text field's value; in a combobox it can also open or close it, or Enter keeps the typed text as the value.
Controller
Create one with createSelectController<Value, Multiple>() and pass it as controller, to the select and to
a trigger outside it.
Every write method takes an optional { reason, event }, passed to the change callback.
isOpen()() => boolean- Whether the list is open.
setOpen(open, options?)(open: boolean, options?: SelectChangeOptions<SelectOpenChangeReason> | undefined) => boolean- Opens or closes the list. Returns false when the change was canceled or it was already open or closed.
open(options?)(options?: (SelectChangeOptions<SelectOpenChangeReason> & { signal?: AbortSignal | undefined; }) | undefined) => Promise<...>- Opens the list, and resolves once it closes, with why and how. Resolves exactly once and never rejects: on the next close from any source, when
signalaborts, or with reason"unmount"when the select leaves the page. close(options?)(options?: SelectChangeOptions<SelectOpenChangeReason> | undefined) => boolean- Closes the list. Returns false when the close was canceled or it was already closed.
toggle(options?)(options?: SelectChangeOptions<SelectOpenChangeReason> | undefined) => boolean- Opens the list when it's closed, and closes it when it's open. Returns false when the change was canceled.
getValue()() => SelectValue<T, Multiple>- The selected value.
setValue(value, options?)(value: SelectValue<T, Multiple>, options?: SelectChangeOptions<SelectValueChangeReason> | undefined) => boolean- Selects a value, as a user would. A disabled or read-only select ignores it. Returns false when the change was canceled, ignored or the value was already selected.
clear(options?)(options?: SelectChangeOptions<SelectValueChangeReason> | undefined) => boolean- Selects nothing:
null, or an empty list withmultiple. Returns false when nothing changed. getQuery()() => string- The text in the search field.
setQuery(query, options?)(query: string, options?: SelectChangeOptions<SelectQueryChangeReason> | undefined) => boolean- Changes the text in the search field, which filters the list. Returns false when nothing changed.
focus()() => void- Moves focus to the trigger.
Events
Callbacks get the new state first, then the details. A bound value only updates when the change callback wasn't canceled.
| Prop | On | Receives |
|---|---|---|
bind:value | Select | The selected value |
bind:open | Select | Whether the list is open |
bind:query | Select | The search text |
onValueChange | Select | (value, details): the new value, and the reason |
onOpenChange | Select | (open, details): the new state, and the reason |
onOpenChangeComplete | Select | (open), after the animation |
onHighlight | Select | (value, { index, event }): the highlighted item and its row |
onQueryChange | Select | (query, details): the search text, and the reason |
onLoadMore | Select | (), when the last item is reached |
onDismissAttempt | Select | ({ reason, event }), when a dismissal was refused |
Accessibility
The select follows the WAI-ARIA select-only combobox pattern. The trigger has the combobox role and the popup is a listbox. If you don't need a visible label, give SelectTrigger an aria-label instead.
Keyboard
Arrow keys move through the open list; Home and End reach its first and last items. Set loop={false} to stop arrow keys at either end. The popup follows the trigger's inherited text direction; use logical CSS properties for spacing in right-to-left layouts.
Tested Behavior
Every line below is an automated test.
- With alignItemWithTrigger, the selected item sits over the trigger.
- A controller opens the list.
- Is a combobox named by its label that shows the placeholder.
- Click opens the list.
- Enter opens the list and focuses the first item.
- Space opens the list and focuses the first item.
- ArrowDown opens the list and focuses the first item.
- Points to the list it controls while open.
- A click on the open trigger closes the list.
- A click on a trigger in a shadow root opens the list, and it stays open. Vue and web components only.
- Arrow keys move focus through the items.
- Home and End move to the first and last items.
- Arrow keys skip disabled items.
- Typing focuses the next item that starts with the text.
- Enter chooses the focused item, closes and returns focus to the trigger.
- Space chooses the focused item.
- Escape closes without choosing and returns focus to the trigger.
- The chosen item is selected when the list opens again, and takes focus.
- Selects the next item that starts with the text, like a native select.
- Skips disabled items.
- Clicking an item chooses it and closes the list.
- Clicking a disabled item does nothing.
- Moving over a disabled item leaves the highlight where it was.
- Clicking outside closes without choosing.
- Pressing, dragging to an item and releasing chooses it.
- Enter opens the list after a drag chose an item.
- Enter opens the list after pressing the open trigger and releasing elsewhere.
- A disabled value stays in the trigger, and the list opens on the first enabled item.
- A default value shows its label and is selected.
- Opening with a selected item focuses it.
- Canceling the change keeps the value.
- The list allows several selections.
- Choosing toggles items and keeps the list open.
- Items sit in groups named by their labels.
- Arrow keys move across groups.
- The form submits the value under the select's name.
- A required select blocks submission until a value is chosen.
- A disabled select can't be opened.
- A read-only select doesn't change its value.
- A disabled fieldset disables the select and leaves it out of the form.
- The list opens below the trigger, at least as wide.
Runs in React, Vue and web components.
Also tested:
- A data select whose content part is wrapped in a component renders one list.
- The list is named by the select's label.
- A clear button selects nothing and keeps focus on the select.
- Alt+ArrowUp chooses the focused item and closes, as the APG asks.
- The content says whether the keyboard or a pointer is in use, for styling the highlight.
- A form reset returns the select to its default value.
- Typing on the closed trigger selects items before the list has ever been in the page.
Runs in React, Vue and web components.
Searching, with a search field in the list:
- Opening focuses the search field and highlights the selected item.
- The search field is a combobox that controls the listbox in the list.
- Typing filters the list and highlights the first match.
- Typing never jumps by first letter: the characters go into the field.
- Arrow keys move the highlight while focus stays in the field.
- Home and End are the field's, so the highlight stays.
- Enter chooses the highlighted item, closes, and focus returns to the trigger.
- A click on an item chooses it.
- Escape closes the list and focus returns to the trigger.
- The search empties once the list closes.
- An empty message shows when nothing matches.
- Matches ignore case and accents.
- Labels mark what the search matched.
- With multiple, choosing keeps the list open and focus in the field.
- Tab closes the list and moves on from the trigger.
- No axe violations while searching.
- Typing on the closed trigger still selects by first letter.
- Recent items show until the user types, then the results.
- A recent item is chosen like any other, and its label shows in the trigger.
Runs in React, Vue and web components.
Screen readers hear the same thing in each tested framework, recorded by a virtual screen reader:
- Announcements while choosing with a keyboard.
Runs in React, Vue and web components.