Combobox · base-ui-svelte

API Reference

Props mirror Base UI React where applicable, adapted for Svelte 5. Native HTML attributes for the rendered element are also accepted unless noted.

Combobox.Root

Extends div HTML attributes.

Property	Type	Default	Description
`value`	`ComboboxValue \| undefined`	`—`	Controlled value.
`defaultValue`	`ComboboxValue`	`—`	Uncontrolled initial value.
`onValueChange`	`((value: ComboboxValue, event: Event) => void) \| undefined`	`—`	Event handler called when the value changes.
`inputValue`	`string \| undefined`	`—`	—
`defaultInputValue`	`string`	`—`	—
`onInputChange`	`((value: string, event?: Event) => void) \| undefined`	`—`	—
`open`	`boolean \| undefined`	`—`	Whether the component is open (controlled).
`defaultOpen`	`boolean`	`—`	Whether the component is initially open (uncontrolled).
`onOpenChange`	`((open: boolean, eventDetails: { reason: OpenChangeReason }) => void) \| undefined`	`—`	Event handler called when the open state changes.
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.
`filter`	`boolean`	`—`	—
`multiple`	`boolean`	`—`	—
`items`	`ComboboxItemsProp \| undefined`	`—`	—
`children`	`Snippet< [{ value: ComboboxValue; inputValue: string; open: boolean; disabled: boolean }] >`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-disabled`	Present when the part is disabled.
`data-open`	Present when the part is open.

Combobox.Arrow

Extends span HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Backdrop

Extends div HTML attributes.

Property	Type	Default	Description
`render`	`string`	`—`	HTML element tag to render instead of the default host element.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Chip

Extends div HTML attributes.

Property	Type	Default	Description
`value`	`string`	`—`	Controlled value.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.

Combobox.ChipRemove

Extends button HTML attributes.

Property	Type	Default	Description
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.

Combobox.Chips

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Combobox.Clear

Extends button HTML attributes.

Property	Type	Default	Description
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.
`data-empty`	Present on the element when applicable.
`data-hidden`	Present on the element when applicable.

Combobox.Collection

Property	Type	Default	Description
`children`	`Snippet<[ComboboxCollectionItem]>`	`—`	Content rendered inside the part.

Combobox.Empty

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-empty`	Present on the element when applicable.

Combobox.Group

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Combobox.GroupLabel

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Combobox.Icon

Extends span HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Input

Extends input HTML attributes.

Property	Type	Default	Description
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-disabled`	Present when the part is disabled.
`data-open`	Present when the part is open.

Combobox.InputGroup

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-disabled`	Present when the part is disabled.
`data-open`	Present when the part is open.

Combobox.Item

Extends div HTML attributes.

Property	Type	Default	Description
`value`	`string`	`—`	Controlled value.
`label`	`string`	`—`	—
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.
`children`	`Snippet<[{ selected: boolean; highlighted: boolean; disabled: boolean }]>`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.
`data-highlighted`	Present when the item is highlighted.
`data-selected`	Present when the item is selected.

Combobox.ItemIndicator

Extends span HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.
`data-selected`	Present when the item is selected.

Combobox.Label

Extends label HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-disabled`	Present when the part is disabled.

Combobox.List

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Popup

Extends div HTML attributes.

Property	Type	Default	Description
`render`	`string`	`—`	HTML element tag to render instead of the default host element.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-ending-style`	Present while the exit animation can run.
`data-open`	Present when the part is open.
`data-starting-style`	Present while the enter animation can run.

Combobox.Portal

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Combobox.Positioner

Extends div HTML attributes.

Property	Type	Default	Description
`side`	`Side`	`—`	—
`align`	`Align`	`—`	—
`sideOffset`	`number`	`—`	—
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Row

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Combobox.Separator

Extends div HTML attributes.

No component-specific props — HTML attributes and children only.

Combobox.Status

Extends div HTML attributes.

Property	Type	Default	Description
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-open`	Present when the part is open.

Combobox.Trigger

Extends button HTML attributes.

Property	Type	Default	Description
`render`	`string`	`—`	HTML element tag to render instead of the default host element.
`disabled`	`boolean`	`false`	Whether the control ignores user interaction.
`children`	`Snippet`	`—`	Content rendered inside the part.

Data attribute	Description
`data-closed`	Present when the part is closed.
`data-disabled`	Present when the part is disabled.
`data-open`	Present when the part is open.

Combobox.Value

Extends span HTML attributes.

Property	Type	Default	Description
`placeholder`	`string`	`—`	—
`children`	`Snippet<[ComboboxValue]>`	`—`	Content rendered inside the part.

Data attribute	Description
`data-placeholder`	Present when showing placeholder content.