Maia Documentation

Appearance

maia.component-library / AutocompleteFilterProps

Interface: AutocompleteFilterProps ​

Defined in: node_modules/.pnpm/@heroui+react@3.2.1_@react-_0c36d9022f1aaf46c104e0a6d2192bf4/node_modules/@heroui/react/dist/components/autocomplete/autocomplete.d.ts:29

Extends ​

  • ComponentPropsWithRef<typeof AutocompletePrimitive>

Properties ​

children ​

children: ReactNode

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/autocomplete/useAutocompleteState.d.ts:23

The children wrapped by the autocomplete. Consists of at least an input element and a collection element to filter.

Inherited from ​

ComponentPropsWithRef.children

defaultInputValue? ​

optional defaultInputValue?: string

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/autocomplete/useAutocompleteState.d.ts:16

The default value of the autocomplete input (uncontrolled).

Inherited from ​

ComponentPropsWithRef.defaultInputValue

disableAutoFocusFirst? ​

optional disableAutoFocusFirst?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/autocomplete/useAutocomplete.d.ts:25

Whether or not to focus the first item in the collection after a filter is performed. Note this is only applicable if virtual focus behavior is not turned off via disableVirtualFocus.

Default ​

ts
false

Inherited from ​

ComponentPropsWithRef.disableAutoFocusFirst

disableVirtualFocus? ​

optional disableVirtualFocus?: boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/autocomplete/useAutocomplete.d.ts:32

Whether the autocomplete should disable virtual focus, instead making the wrapped collection directly tabbable.

Default ​

ts
false

Inherited from ​

ComponentPropsWithRef.disableVirtualFocus

filter? ​

optional filter?: (textValue, inputValue, node) => boolean

Defined in: node_modules/.pnpm/react-aria@3.49.0_react-dom_79276432c5f5a855702fa36e2a7ee0e4/node_modules/react-aria/dist/types/src/autocomplete/useAutocomplete.d.ts:18

An optional filter function used to determine if a option should be included in the autocomplete list. Include this if the items you are providing to your wrapped collection aren't filtered by default.

Parameters ​

textValue ​

string

inputValue ​

string

node ​

Node<unknown>

Returns ​

boolean

Inherited from ​

ComponentPropsWithRef.filter

inputValue? ​

optional inputValue?: string

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/autocomplete/useAutocompleteState.d.ts:14

The value of the autocomplete input (controlled).

Inherited from ​

ComponentPropsWithRef.inputValue

onInputChange? ​

optional onInputChange?: (value) => void

Defined in: node_modules/.pnpm/react-stately@3.47.0_react@19.2.7/node_modules/react-stately/dist/types/src/autocomplete/useAutocompleteState.d.ts:18

Handler that is called when the autocomplete input value changes.

Parameters ​

value ​

string

Returns ​

void

Inherited from ​

ComponentPropsWithRef.onInputChange

slot? ​

optional slot?: string | null

Defined in: node_modules/.pnpm/react-aria-components@1.18._652bbfc7b5fa5f84b16cd32a1196785b/node_modules/react-aria-components/dist/types/src/utils.d.ts:158

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

Inherited from ​

ComponentPropsWithRef.slot