AutoComplete

Autocomplete function of input field.

Usage

import { AutoComplete } from 'rsuite';

Examples

Default

AutoComplete

Custom Render Item

Disabled

Combined with InputGroup

Controlled

Props

<AutoComplete>

Property Type(Default) Description
classPrefix string ('auto-complete') The prefix of the component CSS class
data * string[], Array<DataItemType> The data of component
defaultValue string Default value
disabled boolean Whether disabled select
filterBy (value: string, item: DataItemType) => boolean Custom filter rules (will only display items that value is a substring of which by default)
menuClassName string A css class to apply to the Menu DOM
onChange (value:string, event) => void Called when select an option or input value change, or value of input is changed
onClose () => void Callback fired when hidden
onEnter () => void Callback fired before the overlay transitions in
onEntered () => void Callback fired after the overlay finishes transitioning in
onEntering () => void Callback fired as the overlay begins to transition in
onExit () => void Callback fired right before the overlay transitions out
onExited () => void Callback fired after the overlay finishes transitioning out
onExiting () => void Callback fired as the overlay begins to transition out
onSelect (item: DataItemType, event) => void Called when a option is selected.
placeholder React.Node The placeholder of input
renderItem (label:React.Node, item: DataItemType) => React.Node Custom selected option
selectOnEnter boolean (true) When set to false, the Enter key selection function is invalid
value string Value (Controlled)