# useTypeahead API

> Auto-generated API reference for `useTypeahead` from @vuetify/v0 (Vuetify0).
> Source of truth: https://0.vuetifyjs.com/api/use-typeahead

## Related

- https://0.vuetifyjs.com/composables/system/use-typeahead
- https://0.vuetifyjs.com/composables/system/use-timer
- https://0.vuetifyjs.com/composables/reactivity/use-proxy-registry
- https://0.vuetifyjs.com/composables/reactivity/use-proxy-model
- https://0.vuetifyjs.com/components/forms/select

## Functions

### useTypeahead

Match typed characters against a list.

`items` is read on every key, in the order given. Matching is a
case-insensitive `startsWith` against `options.text`. Text is not trimmed.
Disabled items are not skipped — omit them from `items` to filter.

```ts
(items: () => readonly T[], options: TypeaheadOptions<T>) => TypeaheadReturn<T>
```

## Options

| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| `text` | `(item: T) => string` | — | yes | Text used for prefix matching. Read on every key. |
| `duration` | `MaybeRefOrGetter<number> \| undefined` | `1000` | no | Inactivity window before the buffer clears, in milliseconds. Accepts a plain number, ref, or getter — read fresh on each key. |

## Methods

| Name | Type | Description |
|---|---|---|
| `typeahead` | `(char: string) => TypeaheadMatch<T> \| undefined` | Append `char` to the buffer and return the next prefix match. Restarts the inactivity window on every call, hit or miss. |
| `reset` | `() => void` | Clear the buffer and stop the inactivity window. |