AutoCompleteProps
Represents the props of the KendoReact AutoComplete component.
Definition
Package:@progress/kendo-react-dropdowns
Properties
accessKey?
string
Specifies the accessKey of the AutoComplete.
adaptive?
boolean
Providing different rendering of the popup element based on the screen dimensions.
false
adaptiveSubtitle?
string
Specifies the text that is rendered as subtitle in the adaptive popup(action sheet).
Applicable only when adaptive is set to true.
adaptiveTitle?
string
Specifies the text that is rendered as title in the adaptive popup(action sheet).
Applicable only when adaptive is set to true.
If not provided, the title will be the same as the label.
ariaDescribedBy?
string
Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.
ariaLabel?
string
Defines a string value that labels the component.
ariaLabelledBy?
string
Identifies the element(s) which will label the component.
className?
string
Sets additional classes to the AutoComplete.
clearButton?
boolean
By default, the AutoComplete renders a button on hovering over the component, which resets the value.
If clearButton is set to false, the button will not be rendered.
data?
any[]
Sets the data of the AutoComplete (more information and example).
dataItemKey?
string
Sets the key for comparing the data items of the AutoComplete. If dataItemKey is not set, the AutoComplete compares the items by reference.
defaultValue?
string
Sets the default value of the AutoComplete. Similar to the native input HTML element.
dir?
string
Represents the dir HTML attribute.
disabled?
boolean
Sets the disabled state of the AutoComplete.
fillMode?
"solid" | "flat" | "outline"
Configures the fillMode of the AutoComplete.
The available options are:
- solid
- flat
- outline
undefined (theme-controlled)
If set, the AutoComplete will use it to get the focused item index.
Default functionality returns the first item which starts with the input text.
number
footer?
ReactNode
Sets the footer component of the AutoComplete (see example).
groupField?
string
Sets the data item field that represents the start of a group. Applicable to objects data.
Fires when a AutoComplete group header item is about to be rendered. Used to override the default appearance of the group's headers.
ReactNode
Fires when a AutoComplete sticky group header item is about to be rendered. Used to override the default appearance of the sticky group header of the component.
ReactNode
header?
ReactNode
Sets the header component of the AutoComplete (see example).
id?
string
Specifies the id of the component.
inputAttributes?
InputHTMLAttributes<HTMLInputElement>
Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.
Fires when an AutoComplete list item is about to be rendered (see example). Used to override the default appearance of the list items.
ReactNode
label?
string
Renders a floating label for the AutoComplete.
Fires when the element which indicates no data in the popup is about to be rendered (see example). Used to override the default appearance of the element.
ReactNode
loading?
boolean
Sets the loading state of the AutoComplete (see example).
name?
string
Specifies the name property of the input DOM element.
This property is part of the FormComponentProps interface.
onBlur?
(event: AutoCompleteBlurEvent) => void
Fires each time the AutoComplete gets blurred.
onChange?
(event: AutoCompleteChangeEvent) => void
Fires each time the value of the AutoComplete is about to change (more information and example).
onClose?
(event: AutoCompleteCloseEvent) => void
Fires each time the popup of the AutoComplete is about to close.
onFocus?
(event: AutoCompleteFocusEvent) => void
Fires each time the user focuses the AutoComplete.
onOpen?
(event: AutoCompleteOpenEvent) => void
Fires each time the popup of the AutoComplete is about to open.
opened?
boolean
Sets the opened and closed state of the AutoComplete.
placeholder?
string
The hint that is displayed when the AutoComplete is empty.
Configures the popup of the AutoComplete.
prefix?
CustomComponent<any>
Sets a custom prefix to the AutoComplete component.
readonly?
boolean
Sets the read-only state of the AutoComplete.
required?
boolean
Specifies if null is a valid value for the component.
This property is part of the FormComponentProps interface.
rounded?
"small" | "medium" | "large" | "full" | "none"
Configures the roundness of the AutoComplete.
The available options are:
- small
- medium
- large
- full
undefined (theme-controlled)
size?
"small" | "medium" | "large"
Configures the size of the AutoComplete.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
skipDisabledItems?
boolean
Defines if AutoComplete's disabled items will be skipped or focused when navigating through the list of items using a keyboard. Defaults to true.
style?
CSSProperties
The styles that are applied to the AutoComplete.
suffix?
CustomComponent<any>
Sets a custom suffix to the AutoComplete component.
suggest?
string | boolean
Enables the auto-completion of the text based on the first data item (see example).
tabIndex?
number
Specifies the tabIndex of the AutoComplete.
textField?
string
Sets the data item field that represents the item text (see example). If the data contains only primitive values, do not define it.
valid?
boolean
Overrides the validity state of the component.
If valid is set, the required property will be ignored.
This property is part of the FormComponentProps interface.
validationMessage?
string
Controls the form error message of the component. If set to an empty string, no error will be thrown.
This property is part of the FormComponentProps interface.
validityStyles?
boolean
If set to false, no visual representation of the invalid state of the component will be applied.
This property is part of the FormComponentProps interface.
value?
string
Sets the value of the AutoComplete (more information and example).
Fires when the AutoComplete input element is about to be rendered. Use it to override the default appearance of the component.
ReactNode
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.