---
url: "https://vueda.dev/v3/reference/api/js/use/useComboboxSearch/functions/useComboboxSearch.md"
title: "useComboboxSearch"
---

# useComboboxSearch

## Overview

Manages reactive state and API data-fetching for a combobox widget backed by a vueda model endpoint.
Only call this composable when `app` and `model` props are present.

## Signature

`useComboboxSearch(props, widgetContext)`

### Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <span id="param-props">props</span> | `object` | yes | Component props containing app, model, and search configuration. |
| <span id="param-widgetContext">widgetContext</span> | [WidgetContext](/v3/reference/api/js/use/useWidget/types/WidgetContext.md) | yes | The widget context. |

#### props Properties

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="param-props-app">app</span> | `string` |  |  | Django app label for the model to search. |
| <span id="param-props-extraParams">extraParams</span> | `object` |  |  | Extra query parameters merged into every API request. |
| <span id="param-props-getExtraParams">getExtraParams</span> | `Function` |  |  | Function returning additional parameters from dependency values. |
| <span id="param-props-groupBy">groupBy</span> | `string` |  |  | Field name to group options by. Requires `grouped: true`. |
| <span id="param-props-grouped">grouped</span> | `boolean` |  |  | Whether to group options by a field. |
| <span id="param-props-model">model</span> | `string` |  |  | Django model name. |
| <span id="param-props-modelExpandFields">modelExpandFields</span> | `string[]` |  |  | Fields to expand in the fetch. |
| <span id="param-props-modelFields">modelFields</span> | `string[]` |  |  | Additional fields to fetch alongside the label and PK. |
| <span id="param-props-modelOrdering">modelOrdering</span> | `string[]` |  |  | Default ordering for the list. |
| <span id="param-props-optionLabel">optionLabel</span> | `string` |  |  | Field name to display as the option label in the search list. |
| <span id="param-props-placeholder">placeholder</span> | `string` |  |  | Placeholder text. |
| <span id="param-props-selectedOptionLabel">selectedOptionLabel</span> | `string` |  |  | Field name for the closed-state display label. |

### Returns

`Reactive search state.`

## Source

`client/lib/use/useComboboxSearch.js:94`