DropDownListProps
Represents the props of the KendoReact DropDownList component.
Definition
Package:@progress/kendo-react-dropdowns
Properties
accessKey?
string
Specifies the accessKey of the DropDownList.
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
The accessible label of the component. By default is set to value of label prop.
ariaLabelledBy?
string
Identifies the element(s) which will label the component.
className?
string
Sets additional classes to the DropDownList.
data?
any[]
Sets the data of the DropDownList (see example).
dataItemKey?
string
Sets the key for comparing the data items of the DropDownList. If dataItemKey is not set, the DropDownList compares the items by reference (see example).
defaultItem?
any
Sets the text of the default empty item. The type of the defined value has to match the data type.
Sets the default value of the DropDownList (see example). Similar to the native select HTML element.
delay?
number
Sets the delay before an item search is performed. When filtration is disabled, use this option.
dir?
string
Represents the dir HTML attribute.
disabled?
boolean
Sets the disabled state of the DropDownList.
fillMode?
"solid" | "flat" | "outline"
Configures the fillMode of the DropDownList.
The available options are:
- solid
- flat
- outline
undefined (theme-controlled)
filter?
string
Sets the value of filtering input. Useful for making the filtering input a controlled component.
filterable?
boolean
Enables the filtering functionality of the DropDownList (more information and examples).
If set, the DropDownList 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 DropDownList (see example).
groupField?
string
Sets the data item field that represents the start of a group. Applicable to objects data.
Fires when a DropDownList's group header item is about to be rendered. Used to override the default appearance of the group's headers.
ReactNode
Fires when a DropDownList's 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 DropDownList (see example).
iconClassName?
string
Sets CSS classes to the expand icon DOM element.
id?
string
Specifies the id of the component.
ignoreCase?
boolean
Enables a case-insensitive search. When filtering is disabled, use this option.
Fires when a DropDownList 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 DropDownList.
leftRightKeysNavigation?
boolean
If set to false, the DropDownList will not navigate over its data through left and right keys.
Useful when the DropDownList is placed inside a toolbar which needs to handle left and right keys.
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 DropDownList.
name?
string
Specifies the name property of the select DOM element.
onBlur?
(event: DropDownListBlurEvent) => void
Fires each time the DropDownList gets blurred.
onChange?
(event: DropDownListChangeEvent) => void
Fires each time the value of the DropDownList is about to change (see examples).
onClose?
(event: DropDownListCloseEvent) => void
Fires each time the popup of the DropDownList is about to close.
onFilterChange?
(event: DropDownListFilterChangeEvent) => void
Fires each time the user types in the filter input. You can filter the source based on the passed filtration value.
onFocus?
(event: DropDownListFocusEvent) => void
Fires each time the user focuses the DropDownList.
onOpen?
(event: DropDownListOpenEvent) => void
Fires each time the popup of the DropDownList is about to open.
onPageChange?
(event: DropDownListPageChangeEvent) => void
Fires when both the virtual scrolling of the DropDownList is enabled and the component requires data for another page (see example).
opened?
boolean
Sets the opened and closed state of the DropDownList.
Configures the popup of the DropDownList.
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 DropDownList.
The available options are:
- small
- medium
- large
- full
undefined (theme-controlled)
size?
"small" | "medium" | "large"
Configures the size of the DropDownList.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
skipDisabledItems?
boolean
Defines if DropDownList'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 DropDownList.
svgIcon?
SVGIcon
Sets the specified SVG icon.
tabIndex?
number
Specifies the tabIndex of the DropDownList.
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.
title?
string
Sets the title attribute to the DropDownList DOM element.
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?
any
Sets the value of the DropDownList (see example). It can either be of the primitive (string, numbers) or of the complex (objects) type.
Represents a callback function, which returns the value for submitting. The returned value will be rendered in an option of a hidden select element.
any
Fires when the element which renders the value is about to be rendered (see example). Used to override the default appearance of the element.
ReactNode
Configures the virtual scrolling of the DropDownList (see example).
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.