New to KendoReact? Start a free 30-day trial

MultiSelectTreeProps

Interface

Represents the props of the KendoReact MultiSelectTree component.

Definition

Package:@progress/kendo-react-dropdowns

Properties

accessKey?

string

Specifies the accessKey of the MultiSelectTree.

Example:

jsx

<MultiSelectTree accessKey="m" />

adaptive?

boolean

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

Default:

false

Example:

jsx

<MultiSelectTree 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

<MultiSelectTree adaptiveSubtitle="Adaptive Popup Subtitle" />

adaptiveTitle?

ReactNode

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

<MultiSelectTree 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

<MultiSelectTree ariaDescribedBy="description" />

ariaLabel?

string

Defines a string value that labels the component.

Example:

jsx

<MultiSelectTree ariaLabel="Select items" />

ariaLabelledBy?

string

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

Example:

jsx

<MultiSelectTree ariaLabelledBy="label" />

checkField?

string

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

Example:

jsx

<MultiSelectTree checkField="checked" />

checkIndeterminateField?

string

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

Example:

jsx

<MultiSelectTree checkIndeterminateField="indeterminate" />

className?

string

Sets additional classes to the MultiSelectTree.

Example:

jsx

<MultiSelectTree className="custom-class" />

data?

any[]

Sets the data of the MultiSelectTree (see example).

Example:

jsx

<MultiSelectTree data={[{ text: 'Node1' }, { text: 'Node2' }]} />

dataItemKey

string

Sets the key for comparing the data items of the MultiSelectTree (see example). If dataItemKey is not set, the MultiSelectTree compares the items by reference.

Example:

jsx

<MultiSelectTree dataItemKey="id" />

dir?

string

Represents the dir HTML attribute.

Example:

jsx

<MultiSelectTree dir="rtl" />

disabled?

boolean

Sets the disabled state of the MultiSelectTree.

Example:

jsx

<MultiSelectTree 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

<MultiSelectTree expandField="expanded" />

fillMode?

"solid" | "flat" | "outline"

Configures the fillMode of the MultiSelectTree.

The available options are:

solid
flat
outline

Default:

undefined (theme-controlled)

Example:

jsx

<MultiSelectTree fillMode="outline" />

filter?

string

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

Example:

jsx

<MultiSelectTree filter="search text" />

filterable?

boolean

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

Example:

jsx

<MultiSelectTree filterable={true} />

id?

string

Specifies the id of the component.

Example:

jsx

<MultiSelectTree id="multi-select-tree" />

item?

ComponentType<MultiSelectTreeItemProps>

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

Example:

jsx

<MultiSelectTree item={(props) => <div>{props.item.text}</div>} />

label?

string

Renders a floating label for the MultiSelectTree.

Example:

jsx

<MultiSelectTree label="Select items" />

listNoData?

ComponentType<MultiSelectTreeListNoDataProps>

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

Example:

jsx

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

loading?

boolean

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

Example:

jsx

<MultiSelectTree loading={true} />

name?

string

Specifies the name property of the input DOM element.

This property is part of the FormComponentProps interface.

onBlur?

(event: MultiSelectTreeBlurEvent) => void

Fires each time the MultiSelectTree gets blurred.

Parameters:eventMultiSelectTreeBlurEvent

Example:

jsx

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

onCancel?

(event: MultiSelectTreeCancelEvent) => void

Fires each time the popup of the MultiSelectTree is about to cancel in (adaptive mode).

Parameters:eventMultiSelectTreeCancelEvent

Example:

jsx

<MultiSelectTree onCancel={(event) => console.log(event)} />

onChange?

(event: MultiSelectTreeChangeEvent) => void

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

Parameters:eventMultiSelectTreeChangeEvent

Example:

jsx

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

onClose?

(event: MultiSelectTreeCloseEvent) => void

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

Parameters:eventMultiSelectTreeCloseEvent

Example:

jsx

<MultiSelectTree 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

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

onFilterChange?

(event: MultiSelectTreeFilterChangeEvent) => 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:eventMultiSelectTreeFilterChangeEvent

Example:

jsx

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

onFocus?

(event: MultiSelectTreeFocusEvent) => void

Fires each time the user focuses the MultiSelectTree.

Parameters:eventMultiSelectTreeFocusEvent

Example:

jsx

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

onOpen?

(event: MultiSelectTreeOpenEvent) => void

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

Parameters:eventMultiSelectTreeOpenEvent

Example:

jsx

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

opened?

boolean

Sets the opened state of the MultiSelectTree.

Example:

jsx

<MultiSelectTree opened={true} />

placeholder?

string

The hint that is displayed when the MultiSelectTree is empty.

Example:

jsx

<MultiSelectTree placeholder="Select items" />

popupSettings?

DropDownsPopupSettings

Configures the popup of the MultiSelectTree.

Example:

jsx

<MultiSelectTree popupSettings={{ animate: true }} />

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

The available options are:

small
medium
large
full

Default:

undefined (theme-controlled)

Example:

jsx

<MultiSelectTree rounded="full" />

size?

"small" | "medium" | "large"

Configures the size of the MultiSelectTree.

The available options are:

small
medium
large

Default:

undefined (theme-controlled)

Example:

jsx

<MultiSelectTree size="large" />

style?

CSSProperties

The styles that are applied to the MultiSelectTree.

Example:

jsx

<MultiSelectTree style={{ width: '400px' }} />

subItemsField?

string

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

Example:

jsx

<MultiSelectTree subItemsField="children" />

tabIndex?

number

Specifies the tabIndex of the MultiSelectTree.

Example:

jsx

<MultiSelectTree tabIndex={0} />

tag?

ComponentType<MultiSelectTreeTagProps>

Defines the component that will be used for rendering each of the MultiSelectTree tags.

Example:

jsx

<MultiSelectTree tag={(props) => <span>{props.tagData.text}</span>} />

tags?

TagData[]

Sets the tags of the MultiSelect (see example).

Example:

jsx

<MultiSelectTree tags={[{ text: 'Tag1' }, { text: 'Tag2' }]} />

textField

string

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

Example:

jsx

<MultiSelectTree 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 MultiSelectTree. It can either be of the primitive (string, numbers) or of the complex (objects) type.

Example:

jsx

<MultiSelectTree value={['Node1']} />

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:valueany[]Returns:

any

Example:

jsx

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