New to Kendo UI for Vue? Start a free 30-day trial

Represents the Kendo UI for Vue MultiSelectTree component. Use the MultiSelectTree to select more than one item from hierarchical data.

Definition

Package:@progress/kendo-vue-dropdowns

Properties Interface:MultiSelectTreeProps

Syntax:

vue
<MultiSelectTree :data-items="treeData" :data-item-key="'id'" :text-field="'text'" :check-field="'checkField'" :placeholder="'Please select ...'" />

Properties

Sets the accessKey attribute of the MultiSelectTree.

adaptive?

boolean

Changes the rendering of the popup based on the screen size.

Sets the title of the adaptive popup.

Sets the id values of the elements that describe the MultiSelectTree, like the HTML aria-describedby attribute. For example, these elements can contain an error or a hint message.

Sets the id values of the elements that label the MultiSelectTree.

Sets the name of the field that holds the boolean checked state of the item.

Default:

'checkField'

Sets the name of the field that holds the boolean indeterminate checked state of the item.

Default:

'checkIndeterminateField'

Sets additional CSS classes to the MultiSelectTree.

Sets the key that the MultiSelectTree uses to compare the data items (see example). When you do not set dataItemKey, the MultiSelectTree compares the items by reference.

Sets the data of the MultiSelectTree (see example).

Default:

[]

dir?

string

Sets the dir HTML attribute of the MultiSelectTree.

disabled?

boolean

Sets the disabled state of the MultiSelectTree.

Sets the name of the field that holds the boolean expanded state of the item.

fillMode?

"solid" | "outline" | "flat"

Configures the fillMode of the MultiSelectTree.

The available options are:

  • solid
  • flat
  • outline
Default:

undefined

filter?

string

Sets the value of the filter input. Use it when you want to control the filter input.

Turns on the filtering of the MultiSelectTree (more information and examples).

Sets the template that renders the footer of the MultiSelectTree popup.

Sets the template that renders the header of the MultiSelectTree popup.

id?

string

Sets the id of the focusable element of the MultiSelectTree. The floating label uses it as its target.

Sets the template that renders each MultiSelectTree item (see example).

label?

string

Renders a floating label for the MultiSelectTree. The MultiSelectTree also uses it as its aria-label.

Sets the template that the MultiSelectTree popup renders when there is no data (see example).

loading?

boolean

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

Sets the value of the MultiSelectTree when you use v-model. The value is an array of primitives (strings or numbers) or of complex types (objects).

name?

string

Sets the name attribute of the input DOM element.

Fires each time the MultiSelectTree loses focus.

Parameters:eventMultiSelectTreeBlurEvent

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

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

onExpandChange?

(event: any) => void

Fires when the user expands or collapses an item (see examples).

Parameters:eventany

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

Fires each time the MultiSelectTree receives focus.

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

Parameters:eventMultiSelectTreeOpenEvent

opened?

boolean

Sets whether the popup of the MultiSelectTree is open.

Sets the hint that the MultiSelectTree shows when it is empty.

Configures the popup of the MultiSelectTree.

Default:

{ animate: true, height: '200px', anchor: '' }

required?

boolean

Sets whether the MultiSelectTree requires a value.

rounded?

"none" | "small" | "medium" | "large" | "full"

Configures the roundness of the MultiSelectTree.

The available options are:

  • none
  • small
  • medium
  • large
  • full
Default:

undefined

size?

"small" | "medium" | "large"

Configures the size of the MultiSelectTree.

The available options are:

  • small
  • medium
  • large
Default:

undefined

Sets the name of the field that holds the array of child items.

Default:

'items'

tabIndex?

number

Sets the tabIndex attribute of the MultiSelectTree.

tag?

any

Sets the template that renders each tag of the MultiSelectTree.

Sets the tags of the MultiSelectTree (see example).

textField

string

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

valid?

boolean

Overrides the validity state of the MultiSelectTree. When you set valid, the MultiSelectTree ignores the required property.

Sets the validation message of the MultiSelectTree.

When you set it to false, the MultiSelectTree does not show the invalid state.

Default:

true

value?

any[]

Sets the value of the MultiSelectTree. The value is an array of primitives (strings or numbers) or of complex types (objects).

Sets a function that returns the value to submit. The MultiSelectTree renders the returned value in an option of a hidden select element.

Parameters:valueany[]Returns:

any

Example:
vue
<form>
    <MultiSelectTree
        :data-items="[{ text: 'Austria', id: 1 }, { text: 'Belarus', id: 2 }]"
        :data-item-key="'id'"
        :text-field="'text'"
        :value-map="(value) => value && value.map((item) => item.id)"
    />
    <button type="submit">Submit</button>
</form>