---
url: "https://vueda.dev/v3/reference/api/vue/Combobox.md"
title: "Combobox"
---

# Combobox

## Overview

Root of a Combobox widget. Combines a searchable input with a filtered option list.

## Props

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="prop-modelValue">modelValue</span> | `string\|number\|boolean\|object\|array` |  | `undefined` | The controlled value. Can be bound with v-model. |
| <span id="prop-defaultValue">defaultValue</span> | `string\|number\|boolean\|object\|array` |  | `undefined` | Initial value when uncontrolled. |
| <span id="prop-open">open</span> | `boolean` |  | `undefined` | The controlled open state. Can be bound with v-model:open. |
| <span id="prop-defaultOpen">defaultOpen</span> | `boolean` |  | `undefined` | Initial open state when uncontrolled. |
| <span id="prop-multiple">multiple</span> | `boolean` |  | `undefined` | Whether multiple options can be selected. |
| <span id="prop-dir">dir</span> | `string` |  | `undefined` | Reading direction. |
| <span id="prop-disabled">disabled</span> | `boolean` |  | `undefined` | When true, prevents user interaction. |
| <span id="prop-highlightOnHover">highlightOnHover</span> | `boolean` |  | `undefined` | Whether hovering an item triggers highlight. |
| <span id="prop-by">by</span> | `string\|func` |  | `undefined` | Field for object comparison, or a custom comparison function. |
| <span id="prop-name">name</span> | `string` |  | `undefined` | Name for form submission. |
| <span id="prop-required">required</span> | `boolean` |  | `undefined` | Whether the field is required. |
| <span id="prop-resetSearchTermOnBlur">resetSearchTermOnBlur</span> | `boolean` |  | `undefined` | Whether to reset the search term when the input blurs. |
| <span id="prop-resetSearchTermOnSelect">resetSearchTermOnSelect</span> | `boolean` |  | `undefined` | Whether to reset the search term when a value is selected. |
| <span id="prop-as">as</span> | `string\|object` |  | `undefined` | The HTML element or component to render as. |
| <span id="prop-asChild">asChild</span> | `boolean` |  | `undefined` | Whether to render as a child element. |

## Slots

### `default` {#slot-default}

Scoped slot.

## Events

| Name | Description |
| --- | --- |
| `update:modelValue` | Emitted when the value changes. |
| `update:open` | Emitted when the open state changes. |
| `highlight` | Emitted when an item is highlighted. |

[Full event reference](/v3/reference/api/vue/Combobox/events.md)

## Source

`client/lib/controls/combobox/Combobox.vue`