New to KendoReact? Start a free 30-day trial

DropDownTreeProps

Interface

Represents the props of the KendoReact DropDownTree component.

Definition

Package:@progress/kendo-react-dropdowns

Properties

accessKey?

string

Specifies the accessKey of the DropDownTree.

Example:

jsx

<DropDownTree accessKey="k" />

adaptive?

boolean

Providing different rendering of the popup element based on the screen dimensions.

Default:

false

Example:

jsx

<DropDownTree 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.

Example:

jsx

<DropDownTree 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.

Example:

jsx

<DropDownTree 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.

Example:

jsx

<DropDownTree ariaDescribedBy="description" />

ariaLabel?

string

Defines a string value that labels the component.

Example:

jsx

<DropDownTree ariaLabel="Select item" />

ariaLabelledBy?

string

Identifies the element(s) which will label the component.

Example:

jsx

<DropDownTree ariaLabelledBy="label" />

className?

string

Sets additional classes to the DropDownTree.

Example:

jsx

<DropDownTree className="custom-class" />

data?

any[]

Sets the data of the DropDownTree (see example).

Example:

jsx

<DropDownTree data={[{ text: 'Parent', items: [{ text: 'Child' }] }]} />

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.

Example:

jsx

<DropDownTree dataItemKey="id" />

dir?

string

Represents the dir HTML attribute.

Example:

jsx

<DropDownTree dir="rtl" />

disabled?

boolean

Sets the disabled state of the DropDownTree.

Example:

jsx

<DropDownTree disabled={true} />

expandField?

string

Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.

Example:

jsx

<DropDownTree expandField="expanded" />

fillMode?

"solid" | "flat" | "outline"

Configures the fillMode of the DropDownTree.

The available options are:

solid
flat
outline

Default:

undefined (theme-controlled)

Example:

jsx

<DropDownTree fillMode="flat" />

filter?

string

Sets the value of filtering input. Useful for making the filtering input a controlled component.

Example:

jsx

<DropDownTree filter="search text" />

filterable?

boolean

Enables the filtering functionality of the DropDownTree (more information and examples).

Example:

jsx

<DropDownTree filterable={true} />

id?

string

Specifies the id of the component.

Example:

jsx

<DropDownTree id="dropdown-tree" />

item?

ComponentType<ItemProps>

Defines the component that will be used for rendering each of the DropDownTree items (see example).

Example:

jsx

<DropDownTree item={(props) => <CustomItem {...props} />} />

label?

string

Renders a floating label for the DropDownTree.

Example:

jsx

<DropDownTree label="Select an item" />

listNoData?

ComponentType<ListNoDataProps>

Defines the component that will be rendered in the DropDownTree popup when no data is available (see example).

Example:

jsx

<DropDownTree listNoData={() => <div>No data available</div>} />

loading?

boolean

Sets the loading state of the DropDownTree (see example).

Example:

jsx

<DropDownTree loading={true} />

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.

Parameters:eventDropDownTreeBlurEvent

Example:

jsx

<DropDownTree onBlur={(event) => console.log(event)} />

onChange?

(event: DropDownTreeChangeEvent) => void

Fires each time the value of the DropDownTree is about to change (see examples).

Parameters:eventDropDownTreeChangeEvent

Example:

jsx

<DropDownTree onChange={(event) => console.log(event)} />

onClose?

(event: DropDownTreeCloseEvent) => void

Fires each time the popup of the DropDownTree is about to close.

Parameters:eventDropDownTreeCloseEvent

Example:

jsx

<DropDownTree onClose={(event) => console.log(event)} />

onExpandChange?

(event: any) => void

Fires when the expanding or collapsing of an item is requested (see examples).

Parameters:eventany

Example:

jsx

<DropDownTree onExpandChange={(event) => console.log(event)} />

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.

Parameters:eventDropDownTreeFilterChangeEvent

Example:

jsx

<DropDownTree onFilterChange={(event) => console.log(event)} />

onFocus?

(event: DropDownTreeFocusEvent) => void

Fires each time the user focuses the DropDownTree.

Parameters:eventDropDownTreeFocusEvent

Example:

jsx

<DropDownTree onFocus={(event) => console.log(event)} />

onOpen?

(event: DropDownTreeOpenEvent) => void

Fires each time the popup of the DropDownTree is about to open.

Parameters:eventDropDownTreeOpenEvent

Example:

jsx

<DropDownTree onOpen={(event) => console.log(event)} />

opened?

boolean

Sets the opened state of the DropDownTree.

Example:

jsx

<DropDownTree opened={true} />

placeholder?

string

The hint that is displayed when the DropDownTree is empty.

Example:

jsx

<DropDownTree placeholder="Select an item" />

popupSettings?

DropDownsPopupSettings

Configures the popup of the DropDownTree.

Example:

jsx

<DropDownTree popupSettings={{ animate: false }} />

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

Default:

undefined (theme-controlled)

Example:

jsx

<DropDownTree rounded="full" />

selectField?

string

Specifies the name of the field which will provide a Boolean representation of the selected state of the item.

Example:

jsx

<DropDownTree selectField="selected" />

size?

"small" | "medium" | "large"

Configures the size of the DropDownTree.

The available options are:

small
medium
large

Default:

undefined (theme-controlled)

Example:

jsx

<DropDownTree size="large" />

style?

CSSProperties

The styles that are applied to the DropDownTree.

Example:

jsx

<DropDownTree style={{ width: '300px' }} />

subItemsField?

string

Specifies the name of the field which will provide an array representation of the item subitems. Defaults to 'items'.

Example:

jsx

<DropDownTree subItemsField="children" />

tabIndex?

number

Specifies the tabIndex of the DropDownTree.

Example:

jsx

<DropDownTree tabIndex={0} />

textField

string

Sets the data item field that represents the item text (see example).

Example:

jsx

<DropDownTree 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?

any

Sets the value of the DropDownTree (see example). It can be an object from the data-tree.

Example:

jsx

<DropDownTree value={{ text: 'Parent' }} />

valueHolder?

ComponentType<ValueHolderProps>

Defines the component that will be used for rendering the selected value (see example).

Example:

jsx

<DropDownTree valueHolder={(props) => <CustomValueHolder {...props} />} />

valueMap?

Represents a callback function, which returns the value for submitting. The returned value will be rendered in an option of a hidden select element.

Parameters:valueanyReturns:

any

Example:

jsx

<DropDownTree valueMap={value => value && value.id} />

webMcp?

boolean | WebMcpProps

Enables Web MCP tool registration for this component. Requires a parent WebMcpProvider from @progress/kendo-react-webmcp.