AutoCompleteProps

Represents the props of the KendoReact AutoComplete component.

Name	Type	Default	Description
accessKey?	string		Specifies the accessKey of the AutoComplete. jsx <AutoComplete accessKey="a" />
adaptive?	boolean	false	Providing different rendering of the popup element based on the screen dimensions. jsx <AutoComplete adaptive={true} />
adaptiveSubtitle?	string		Specifies the text that is rendered as subtitle in the adaptive popup(action sheet). Applicable only when adaptive is set to true. jsx <AutoComplete adaptiveSubtitle="Adaptive Popup Subtitle" />
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. jsx <AutoComplete adaptiveTitle="Adaptive Popup Title" />
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. jsx <AutoComplete ariaDescribedBy="description" />
ariaLabelledBy?	string		Identifies the element(s) which will label the component. jsx <AutoComplete ariaLabelledBy="label" />
className?	string		Sets additional classes to the AutoComplete. jsx <AutoComplete className="custom-class" />
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. jsx <AutoComplete clearButton={false} />
data?	any[]		Sets the data of the AutoComplete (more information and example). jsx <AutoComplete data={['Apple', 'Orange', 'Banana']} />
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. jsx <AutoComplete dataItemKey="id" />
defaultValue?	string		Sets the default value of the AutoComplete. Similar to the native input HTML element. jsx <AutoComplete defaultValue="Orange" />
dir?	string		Represents the dir HTML attribute. jsx <AutoComplete dir="rtl" />
disabled?	boolean		Sets the disabled state of the AutoComplete. jsx <AutoComplete disabled={true} />
fillMode?	"null" | "flat" | "solid" | "outline"	solid	Configures the fillMode of the AutoComplete. The available options are: solid flat outline null—Does not set a fillMode className. jsx <AutoComplete fillMode="flat" />
focusedItemIndex?	(data: any, inputText: string, textField?: string) => number		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. jsx const focusedItemIndex = (data, inputText, textField) => { let text = inputText.toLowerCase(); return data.findIndex(item => String(textField ? item[textField] : item).toLowerCase().includes(text)); }; <AutoComplete focusedItemIndex={focusedItemIndex} />
footer?	React.ReactNode		Sets the footer component of the AutoComplete (see example). jsx <AutoComplete footer={<div>Footer</div>} />
groupField?	string		Sets the data item field that represents the start of a group. Applicable to objects data. jsx <AutoComplete groupField="category" />
groupHeaderItemRender?	(li: ReactElement<HTMLLIElement>, itemProps: ListGroupItemProps) => ReactNode		Fires when a AutoComplete group header item is about to be rendered. Used to override the default appearance of the group's headers. jsx <AutoComplete groupHeaderItemRender={(li, itemProps) => <li>{itemProps.dataItem}</li>} />
groupStickyHeaderItemRender?	(div: ReactElement<HTMLDivElement>, stickyHeaderProps: GroupStickyHeaderProps) => 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. jsx <AutoComplete groupStickyHeaderItemRender={(div, stickyHeaderProps) => <div>{stickyHeaderProps.dataItem}</div>} />
header?	React.ReactNode		Sets the header component of the AutoComplete (see example). jsx <AutoComplete header={<div>Header</div>} />
id?	string		Specifies the id of the component. jsx <AutoComplete id="autocomplete" />
inputAttributes?	React.InputHTMLAttributes<HTMLInputElement>		Sets the HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed. jsx <AutoComplete inputAttributes={{ maxLength: 10 }} />
itemRender?	(li: ReactElement<HTMLLIElement>, itemProps: ListItemProps) => ReactNode		Fires when an AutoComplete list item is about to be rendered (see example). Used to override the default appearance of the list items. jsx <AutoComplete itemRender={(li, itemProps) => <li>{itemProps.dataItem}</li>} />
label?	string		Renders a floating label for the AutoComplete. jsx <AutoComplete label="Search" />
listNoDataRender?	(element: ReactElement<HTMLDivElement>) => ReactNode		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. jsx <AutoComplete listNoDataRender={(element) => <div>No data available</div>} />
loading?	boolean		Sets the loading state of the AutoComplete (see example). jsx <AutoComplete loading={true} />
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. jsx <AutoComplete onBlur={(event) => console.log('Blurred', event)} />
onChange?	(event: AutoCompleteChangeEvent) => void		Fires each time the value of the AutoComplete is about to change (more information and example). jsx <AutoComplete onChange={(event) => console.log('Value changed', event)} />
onClose?	(event: AutoCompleteCloseEvent) => void		Fires each time the popup of the AutoComplete is about to close. jsx <AutoComplete onClose={(event) => console.log('Popup closed', event)} />
onFocus?	(event: AutoCompleteFocusEvent) => void		Fires each time the user focuses the AutoComplete. jsx <AutoComplete onFocus={(event) => console.log('Focused', event)} />
onOpen?	(event: AutoCompleteOpenEvent) => void		Fires each time the popup of the AutoComplete is about to open. jsx <AutoComplete onOpen={(event) => console.log('Popup opened', event)} />
opened?	boolean		Sets the opened and closed state of the AutoComplete. jsx <AutoComplete opened={true} />
placeholder?	string		The hint that is displayed when the AutoComplete is empty. jsx <AutoComplete placeholder="Type here..." />
popupSettings?	DropDownsPopupSettings		Configures the popup of the AutoComplete. jsx <AutoComplete popupSettings={{ animate: true }} />
prefix?	CustomComponent<any>		Sets a custom prefix to the AutoComplete component. jsx <AutoComplete prefix={<span>Prefix</span>} />
readonly?	boolean		Sets the read-only state of the AutoComplete. jsx <AutoComplete readonly={true} />
required?	boolean		Specifies if null is a valid value for the component. This property is part of the FormComponentProps interface.
rounded?	"null" | "small" | "large" | "medium" | "full"	medium	Configures the roundness of the AutoComplete. The available options are: small medium large full null—Does not set a rounded className. jsx <AutoComplete rounded="large" />
size?	"null" | "small" | "large" | "medium"	medium	Configures the size of the AutoComplete. The available options are: small medium large null—Does not set a size className. jsx <AutoComplete size="small" />
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. jsx <AutoComplete skipDisabledItems={false} />
style?	React.CSSProperties		The styles that are applied to the AutoComplete. jsx <AutoComplete style={{ width: '300px' }} />
suffix?	CustomComponent<any>		Sets a custom suffix to the AutoComplete component. jsx <AutoComplete suffix={<span>Suffix</span>} />
suggest?	string | boolean		Enables the auto-completion of the text based on the first data item (see example). jsx <AutoComplete suggest={true} />
tabIndex?	number		Specifies the tabIndex of the AutoComplete. jsx <AutoComplete tabIndex={0} />
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. jsx <AutoComplete textField="name" />
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). jsx <AutoComplete value="Apple" />
valueRender?	(rendering: ReactElement<HTMLSpanElement>) => ReactNode		Fires when the AutoComplete input element is about to be rendered. Use it to override the default appearance of the component. jsx <AutoComplete valueRender={(rendering) => <span>{rendering}</span>} />