aq-uiTypeaheadControls
interfaceSource L17Type contract for TypeaheadControls.
interface TypeaheadControlsMembers
| Name | Type |
|---|---|
search | (character: string) => number |
onKeyDown | (event: React.KeyboardEvent) => void |
reset | () => void |
Use Typeahead
Open-code aq-ui React hook for Use Typeahead.
Installation
pnpm dlx aq-ui@alpha add use-typeaheadAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useTypeahead } from "@/hooks/use-typeahead"useTypeahead
functionSource L23Open-code aq-ui React hook for Use Typeahead.
function useTypeahead<T>({ items, activeIndex, onActiveIndexChange, getTextValue = (item) => String(item), timeout = 500, loop = true, disabledIndices = [], }: UseTypeaheadOptions<T>): TypeaheadControls- Returns
TypeaheadControls
Parameters
| Name | Type |
|---|---|
options | UseTypeaheadOptions<T> |
UseTypeaheadOptions
interfaceSource L7Type contract for UseTypeaheadOptions.
interface UseTypeaheadOptions<T>Members
| Name | Type | Default |
|---|---|---|
items | T[] | — |
activeIndex | number | — |
onActiveIndexChange | (index: number) => void | — |
getTextValue? | (item: T) => string | (item) => String(item) |
timeout? | number | 500 |
loop? | boolean | true |
disabledIndices? | Iterable<number> | [] |
Registry dependencies
use-stable-callback
Files
- hooks/use-typeahead.ts