• Introduction
  • Getting Started
  • Vue 2 End of Support
  • Vue Wrappers End of Life
  • Native Components
    • Animation
    • Buttons
    • Chartsupdated
    • Conversational UI
    • Data Query
    • Data Tools
    • Date Inputs
    • Date Math
    • Dialogs
    • Drawing
    • Dropdowns
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gauges
    • Gridupdated
    • Icons
    • Indicators
    • Inputsupdated
    • Labels
    • Layout
    • ListBox
    • ListView
    • Notification
    • PDF Processing
    • Popup
    • Progress Bars
    • Scheduler
    • ScrollView
    • Tooltip
    • TreeList
    • TreeView
    • Upload
  • Wrapper Components
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • FAQ
  • Troubleshooting
New to Kendo UI for Vue? Start a free 30-day trial

MultiSelectTreeProps

Represents the props of the Kendo UI for Vue MultiSelectTree component.

NameTypeDefaultDescription

accessKey?

string

Specifies the accessKey of the MultiSelectTree.

adaptive?

boolean

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

adaptiveTitle?

string

Specifies the text that is rendered as title in the adaptive popup.

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.

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.

dataItems?

any[]

Sets the data of the MultiSelectTree (see example).

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" | string

solid

Configures the fillMode of the MultiSelectTree.

The available options are:

  • solid
  • flat
  • outline
  • null—Does 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).

any

header?

any

id?

string

Specifies the id of the component.

item?

any

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?

any

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

modelValue?

any[]

Sets the modelValue of the MultiSelectTree. It can either be an array of the primitive (string, numbers) or of the complex (objects) type.

name?

string

Specifies the name property of the input DOM element.

onBlur?

(event: MultiSelectTreeBlurEvent) => void

Fires each time the MultiSelectTree gets blurred.

onChange?

(event: MultiSelectTreeChangeEvent) => void

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

onClose?

(event: MultiSelectTreeCloseEvent) => void

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

onExpandChange?

(event: any) => void

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

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.

onFocus?

(event: MultiSelectTreeFocusEvent) => void

Fires each time the user focuses the MultiSelectTree.

onOpen?

(event: MultiSelectTreeOpenEvent) => void

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

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.

rounded?

"null" | string

medium

Configures the roundness of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
  • full
  • null—Does not set a rounded className.

size?

"null" | string

medium

Configures the size of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

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?

any

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.

validationMessage?

string

Specifies the validationMessage of the component.

validityStyles?

boolean

If set to false, no visual representation of the invalid state of the component will be applied.

value?

any[]

Sets the value of the MultiSelectTree. It can either be an array of the primitive (string, numbers) or of the complex (objects) type.

valueMap?

(value: any[]) => any

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'));