New to KendoReactStart a free 30-day trial

Represents the props of the KendoReact MultiSelectTree component.

Definition

Package:@progress/kendo-react-dropdowns

Properties

Specifies the accessKey of the MultiSelectTree.

adaptive?

boolean

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

Default:

false

Specifies the text that is rendered as subtitle in the adaptive popup(action sheet). Applicable only when adaptive is set to true.

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.

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.

Defines a string value that labels the component.

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

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

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

Sets additional classes to the MultiSelectTree.

data?

any[]

Sets the data of the MultiSelectTree (see example).

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.

dir?

string

Represents the dir HTML attribute.

disabled?

boolean

Sets the disabled state of the MultiSelectTree.

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

The available options are:

  • solid
  • flat
  • outline
Default:

undefined (theme-controlled)

filter?

string

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

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

id?

string

Specifies the id of the component.

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

label?

string

Renders a floating label for the MultiSelectTree.

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

loading?

boolean

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

name?

string

Specifies the name property of the input DOM element.

This property is part of the FormComponentProps interface.

Fires each time the MultiSelectTree gets blurred.

Parameters:eventMultiSelectTreeBlurEvent

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

Parameters:eventMultiSelectTreeCancelEvent

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

Parameters:eventMultiSelectTreeChangeEvent

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

Parameters:eventMultiSelectTreeCloseEvent

onExpandChange?

(event: any) => void

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

Parameters:eventany

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

Fires each time the user focuses the MultiSelectTree.

Parameters:eventMultiSelectTreeFocusEvent

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

Parameters:eventMultiSelectTreeOpenEvent

opened?

boolean

Sets the opened state of the MultiSelectTree.

The hint that is displayed when the MultiSelectTree is empty.

Configures the popup of the MultiSelectTree.

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)

size?

"small" | "medium" | "large"

Configures the size of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
Default:

undefined (theme-controlled)

style?

CSSProperties

The styles that are applied to the MultiSelectTree.

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

tag?

ComponentType​<MultiSelectTreeTagProps>

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

Sets the tags of the MultiSelect (see example).

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.

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.

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.

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