Leave Yamada UI a star

Star
Yamada UIYamada UIv1.6.4

Autocomplete

Autocomplete is a component used to display suggestions in response to user text input.

Source@yamada-ui/autocomplete

Props

AutocompleteProps

allowCreate

Description

If true, enables the creation of autocomplete option.

Type

boolean

Default

false

allowFree

Description

If true, enables the free input.

Type

boolean

animation

Description

The animation of the popover.

Type

"bottom" | "left" | "right" | "scale" | "top" | "none"

Default

'scale'

boundary

Description

The boundary area for the popper. Used within the preventOverflow modifier.

Type

HTMLElement | "clippingParents" | "scrollParent"

Default

'clippingParents'

closeDelay

Description

The number of delay time to close.

Type

number

Default

200

closeOnBlur

Description

If true, the popover will close when you blur out it by clicking outside or tabbing out.

Type

boolean

Default

true

closeOnEsc

Description

If true, the popover will close when you hit the Esc key.

Type

boolean

Default

true

closeOnSelect

Description

If true, the list element will be closed when value is selected.

Type

boolean

Default

true

colorScheme

Description

The visual color appearance of the component.

Type

"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"

containerProps

Description

Props for autocomplete container element.

Type

Omit<HTMLUIProps, "children">

contentProps

Description

Props for autocomplete content element.

Type

Omit<MotionProps, "children">

createProps

Description

Props for autocomplete create element.

Type

Omit<AutocompleteCreateProps, "children">

defaultIsOpen

Description

If true, the popover will be initially opened.

Type

boolean

defaultValue

Description

The initial value of the autocomplete.

Type

string

duration

Description

The animation duration.

Type

number | MotionLifecycleProps<number>

emptyMessage

Description

The message displayed when the search yields no hits.

Type

string

Default

'No results found'

emptyProps

Description

Props for autocomplete empty element.

Type

Omit<AutocompleteEmptyProps, "children">

errorBorderColor

Description

The border color when the input is invalid.

Type

string

eventListeners

Description

If provided, determines whether the popper will reposition itself on scroll and resize of the window.

Type

type ONLY_FOR_FORMAT = | boolean | { resize?: boolean | undefined; scroll?: boolean | undefined }

Default

true

fieldProps

Description

Props for autocomplete field element.

Type

Omit<AutocompleteFieldProps, "children" | "inputProps">

flip

Description

If true, the popper will change its placement and flip when it's about to overflow its boundary area.

Type

boolean

Default

true

focusBorderColor

Description

The border color when the input is focused.

Type

string

format

Description

Function to format text when search input.

Type

(value: string) => string

gutter

Description

The distance or margin between the reference and popper. It is used internally to create an offset modifier.

Type

UIValue<number>

Default

8

header

Description

The header of the autocomplete content element.

Type

string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | FC<...>

iconProps

Description

Props for autocomplete icon element.

Type

AutocompleteIconProps

inputProps

Description

Props for autocomplete input element.

Type

HTMLUIProps<"input">

insertPositionItem

Description

The position to be inserted when the autocomplete option is created.

Type

[string, "first" | "last"] | Union<"first" | "last">

Default

'first'

isDisabled

Description

If true, the form control will be disabled.

Type

boolean

Default

false

isInvalid

Description

If true, the form control will be invalid.

Type

boolean

Default

false

isLazy

Description

If true, the PopoverContent rendering will be deferred until the popover is open.

Type

boolean

Default

false

isOpen

Description

If true, the popover will be opened.

Type

boolean

isReadOnly

Description

If true, the form control will be readonly.

Type

boolean

Default

false

isRequired

Description

If true, the form control will be required.

Type

boolean

Default

false

items

Description

If provided, generate options based on items.

Type

AutocompleteItem[]

lazyBehavior

Description

The lazy behavior of popover's content when not visible. Only works when isLazy={true} - unmount: The popover's content is always unmounted when not open. - keepMounted: The popover's content initially unmounted, but stays mounted when popover is open.

Type

LazyMode

Default

'unmount'

listProps

Description

Props for autocomplete list element.

Type

Omit<AutocompleteListProps, "children">

matchWidth

Description

If true, the popper will match the width of the reference at all times. It's useful for autocomplete, date-picker and select patterns.

Type

boolean

Default

false

modifiers

Description

Array of popper.js modifiers. Check the docs to see the list of possible modifiers you can pass.

Type

Partial<Modifier<string, any>>[]

Docs

https://popper.js.org/docs/v2/modifiers/

offset

Description

The main and cross-axis offset to displace popper element from its reference element.

Type

[number, number]

onChange

Description

The callback invoked when value state changes.

Type

(value: string) => void

onClose

Description

Callback fired when the popover closes.

Type

() => void

onCreate

Description

The callback invoked when autocomplete option created.

Type

( newItem: AutocompleteItem, newItems: AutocompleteItem[], ) => void

onOpen

Description

Callback fired when the popover opens.

Type

() => void

onSearch

Description

The callback invoked when search input.

Type

(ev: ChangeEvent<HTMLInputElement>) => void

openDelay

Description

The number of delay time to open.

Type

number

Default

200

optionProps

Description

Props for select option element.

Type

Omit<AutocompleteOptionProps, "value" | "children">

placement

Description

The placement of the popper relative to its reference.

Type

UIValue<Placement>

Default

'bottom'

portalProps

Description

Props to be forwarded to the portal component.

Type

Omit<PortalProps, "children">

Default

'{ isDisabled: true }'

preventOverflow

Description

If true, will prevent the popper from being cut off and ensure it's visible within the boundary area.

Type

boolean

Default

true

size

Description

The size of the Autocomplete.

Type

"xs" | "sm" | "md" | "lg" | "xl"

Default

"md"

strategy

Description

The CSS positioning strategy to use.

Type

"fixed" | "absolute"

Default

'absolute'

value

Description

The value of the autocomplete.

Type

string

variant

Description

The variant of the Autocomplete.

Type

"filled" | "flushed" | "outline" | "unstyled"

Default

"outline"

Edit this page on GitHub

PreviousNativeSelectNextMultiAutocomplete