Autocomplete

Autocompleteは、ユーザーのテキスト入力に応じて候補を表示するために使用されるコンポーネントです。

ソース @yamada-ui/autocomplete

Props

AutocompleteProps

説明

If true, enables the creation of autocomplete option.

タイプ

boolean

デフォルト

false

説明

If true, enables the free input.

タイプ

boolean

説明

The animation of the popover.

タイプ

デフォルト

'scale'

説明

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

タイプ

HTMLElement | "clippingParents" | "scrollParent"

デフォルト

'clippingParents'

説明

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

タイプ

boolean

デフォルト

true

説明

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

タイプ

boolean

デフォルト

true

説明

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

タイプ

boolean

デフォルト

true

説明

The visual color appearance of the component.

タイプ

"whiteAlpha" | "blackAlpha" | "gray" | "neutral" | "red" | "rose" | "pink" | "flashy" | "orange" | "amber" | "yellow" | "lime" | "green" | "emerald" | "teal" | "cyan" | "sky" | "blue" | "indigo" | "violet" | "purple" | "fuchsia"

説明

Props for autocomplete container element.

タイプ

Omit<HTMLUIProps<"div">, "children">

説明

Props for autocomplete create element.

タイプ

Omit<AutocompleteCreateProps, "children">

説明

If true, the popover will be initially opened.

タイプ

boolean

説明

The initial value of the autocomplete.

タイプ

string

説明

The animation duration.

タイプ

number | Partial<Record<"enter" | "exit", number>>

説明

The message displayed when the search yields no hits.

タイプ

string

デフォルト

'No results found'

説明

Props for autocomplete empty element.

タイプ

Omit<AutocompleteEmptyProps, "children">

説明

The border color when the input is invalid.

タイプ

string

説明

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

タイプ

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

デフォルト

true

説明

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

タイプ

boolean

デフォルト

true

説明

The border color when the input is focused.

タイプ

string

説明

Function to format text when search input.

タイプ

(value: string) => string

説明

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

タイプ

UIValue<number>

デフォルト

8

説明

Props for autocomplete icon element.

タイプ

AutocompleteIconProps

説明

Props for autocomplete input element.

タイプ

HTMLUIProps<"input">

説明

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

タイプ

string | [string, "first" | "last"]

デフォルト

'first'

説明

If true, the form control will be disabled.

タイプ

boolean

デフォルト

false

説明

If true, the form control will be invalid.

タイプ

boolean

デフォルト

false

説明

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

タイプ

boolean

デフォルト

false

説明

If true, the popover will be opened.

タイプ

boolean

説明

If true, the form control will be readonly.

タイプ

boolean

デフォルト

false

説明

If true, the form control will be required.

タイプ

boolean

デフォルト

false

説明

If provided, generate options based on items.

タイプ

AutocompleteItem[]

説明

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.

タイプ

LazyMode

デフォルト

'unmount'

説明

Props for autocomplete list element.

タイプ

Omit<AutocompleteListProps, "children">

説明

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

タイプ

boolean

デフォルト

false

説明

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

タイプ

Partial<Modifier<string, any>>[]

ドキュメント

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

説明

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

タイプ

[number, number]

説明

The callback invoked when value state changes.

タイプ

(value: string) => void

説明

Callback fired when the popover closes.

タイプ

() => void

説明

The callback invoked when autocomplete option created.

タイプ

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

説明

Callback fired when the popover opens.

タイプ

() => void

説明

The callback invoked when search input.

タイプ

(ev: ChangeEvent<HTMLInputElement>) => void

説明

Props for select option element.

タイプ

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

説明

The placement of the popper relative to its reference.

タイプ

UIValue<Placement>

デフォルト

'bottom'

説明

Props to be forwarded to the portal component.

タイプ

Omit<PortalProps, "children">

デフォルト

'{ isDisabled: true }'

説明

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

タイプ

boolean

デフォルト

true

説明

The ref of the element related to the popover. This is used during the onBlur event.

タイプ

RefObject<HTMLElement>

説明

The size of the Autocomplete.

タイプ

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

デフォルト

md

説明

The CSS positioning strategy to use.

タイプ

"fixed" | "absolute"

デフォルト

'absolute'

説明

The value of the autocomplete.

タイプ

string

説明

The variant of the Autocomplete.

タイプ

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

デフォルト

outline

AutocompleteOptionGroupProps

説明

The label of the autocomplete option group.

タイプ

string

AutocompleteOptionProps

説明

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

タイプ

boolean

デフォルト

false

説明

The autocomplete option icon to use.

タイプ

ReactElement<any, string | JSXElementConstructor<any>>

説明

If true, the select option will be disabled.

タイプ

boolean

デフォルト

false

説明

If true, the select option will be focusable.

タイプ

boolean

デフォルト

false

説明

The value of the select option.

タイプ

string

AutocompleteCreateProps

説明

The autocomplete create option icon to use.

タイプ

ReactElement<any, string | JSXElementConstructor<any>>

AutocompleteEmptyProps

説明

The autocomplete empty option icon to use.

タイプ

ReactElement<any, string | JSXElementConstructor<any>>

GitHubでこのページを編集する

前NativeSelect 次MultiAutocomplete