DropDownTreeProps
Represents the props of the KendoReact DropDownTree component.
Definition
Package:@progress/kendo-react-dropdowns
Properties
accessKey?
string
Specifies the accessKey of the DropDownTree.
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 DropDownTree.
data?
any[]
Sets the data of the DropDownTree (see example).
dataItemKey
string
Sets the key for comparing the data items of the DropDownTree (see example).
If dataItemKey is not set, the DropDownTree compares the items by reference.
dir?
string
Represents the dir HTML attribute.
disabled?
boolean
Sets the disabled state of the DropDownTree.
expandField?
string
Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.
fillMode?
"solid" | "flat" | "outline"
Configures the fillMode of the DropDownTree.
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 DropDownTree (more information and examples).
id?
string
Specifies the id of the component.
Defines the component that will be used for rendering each of the DropDownTree items (see example).
label?
string
Renders a floating label for the DropDownTree.
listNoData?
ComponentType<ListNoDataProps>
Defines the component that will be rendered in the DropDownTree popup when no data is available (see example).
loading?
boolean
Sets the loading state of the DropDownTree (see example).
name?
string
Specifies the name property of the input DOM element.
This property is part of the FormComponentProps interface.
onBlur?
(event: DropDownTreeBlurEvent) => void
Fires each time the DropDownTree gets blurred.
onChange?
(event: DropDownTreeChangeEvent) => void
Fires each time the value of the DropDownTree is about to change (see examples).
onClose?
(event: DropDownTreeCloseEvent) => void
Fires each time the popup of the DropDownTree is about to close.
onExpandChange?
(event: any) => void
Fires when the expanding or collapsing of an item is requested (see examples).
onFilterChange?
(event: DropDownTreeFilterChangeEvent) => void
Fires each time the user types in the filter input (see example). You can filter the source based on the passed filtration value.
onFocus?
(event: DropDownTreeFocusEvent) => void
Fires each time the user focuses the DropDownTree.
onOpen?
(event: DropDownTreeOpenEvent) => void
Fires each time the popup of the DropDownTree is about to open.
opened?
boolean
Sets the opened state of the DropDownTree.
placeholder?
string
The hint that is displayed when the DropDownTree is empty.
Configures the popup of the DropDownTree.
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 DropDownTree.
The available options are:
- small
- medium
- large
- full
undefined (theme-controlled)
selectField?
string
Specifies the name of the field which will provide a Boolean representation of the selected state of the item.
size?
"small" | "medium" | "large"
Configures the size of the DropDownTree.
The available options are:
- small
- medium
- large
undefined (theme-controlled)
style?
CSSProperties
The styles that are applied to the DropDownTree.
subItemsField?
string
Specifies the name of the field which will provide an array representation of the item subitems. Defaults to 'items'.
tabIndex?
number
Specifies the tabIndex of the DropDownTree.
textField
string
Sets the data item field that represents the item text (see example).
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 DropDownTree (see example). It can be an object from the data-tree.
valueHolder?
ComponentType<ValueHolderProps>
Defines the component that will be used for rendering the selected value (see example).
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
webMcp?
boolean | WebMcpProps
Enables Web MCP tool registration for this component.
Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.