Components
    • Animation
    • Barcodes
    • Buttons
    • Charts
    • Common Utilities
    • Conversational UI
    • Data Grid
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputs
    • Labels
    • Layout
    • ListBox
    • ListView
    • Mapbeta
    • Notification
    • PDF Processing
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeView
    • Upload
    Sample Applications
    Styling & Themes
    Common Features
    Project Setup
    Changelog

MultiSelectTreeProps

Represents the props of the KendoReact MultiSelectTree component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the MultiSelectTree.

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.

ariaLabelledBy?

string

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

checkField?

string

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

checkIndeterminateField?

string

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

className?

string

Sets additional classes to the MultiSelectTree.

data?

any[]

Sets the data of the MultiSelectTree (see example).

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.

dir?

string

Represents the dir HTML attribute.

disabled?

boolean

Sets the disabled state of the MultiSelectTree.

expandField?

string

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

fillMode?

"null" | "flat" | "outline" | "solid"

solid

Configures the fillMode of the MultiSelectTree.

The available options are:

  • solid
  • flat
  • outline
  • nullDoes not set a fillMode className.

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 MultiSelectTree (more information and examples).

id?

string

Specifies the id of the component.

item?

React.ComponentType<MultiSelectTreeItemProps>

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.

listNoData?

React.ComponentType<MultiSelectTreeListNoDataProps>

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.

opened?

boolean

Sets the opened state of the MultiSelectTree.

placeholder?

string

The hint that is displayed when the MultiSelectTree is empty.

popupSettings?

DropDownsPopupSettings

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?

"null" | "small" | "medium" | "full" | "large"

medium

Configures the roundness of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
  • full
  • nullDoes not set a rounded className.

size?

"null" | "small" | "medium" | "large"

medium

Configures the size of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
  • nullDoes not set a size className.

style?

React.CSSProperties

The styles that are applied to the MultiSelectTree.

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

tag?

React.ComponentType<MultiSelectTreeTagProps>

tags?

TagData[]

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.

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.

Methods

onBlur

Fires each time the MultiSelectTree gets blurred.

Parameters

event

MultiSelectTreeBlurEvent

onChange

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

Parameters

event

MultiSelectTreeChangeEvent

onClose

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

Parameters

event

MultiSelectTreeCloseEvent

onExpandChange

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

Parameters

event

any

onFilterChange

Fires each time the user types in the filter input (see example). You can filter the source based on the passed filtration value.

Parameters

event

MultiSelectTreeFilterChangeEvent

onFocus

Fires each time the user focuses the MultiSelectTree.

Parameters

event

MultiSelectTreeFocusEvent

onOpen

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

Parameters

event

MultiSelectTreeOpenEvent

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.

class App extends React.Component {
   render() {
      return (
         <form>
             <MultiSelectTree
                 data={[ { text: "Austria", id: 1 } , { text: "Belarus", id: 2 } ]}
                 valueMap={value => value && value.id}
             />
             <button type="submit">Submit</button>
         </form>
      );
   }
}
ReactDOM.render(<App />, document.querySelector('my-app'));
Parameters

value

any[]

Returns

any