All Components

MultiSelectComponent

Represents the Kendo UI MultiSelect component for Angular.

@Component({
selector: 'my-app',
template: `
 <kendo-multiselect [data]="listItems">
 </kendo-multiselect>
`
})
class AppComponent {
  public listItems: Array<string> = ["Item 1", "Item 2", "Item 3", "Item 4"];
}

Selector

kendo-multiselect

Export Name

Accessible in templates as #kendoMultiSelectInstance="kendoMultiSelect"

Inputs

autoClose boolean (default: true)

Controls whether to close the suggestion list of the MultiSelect after the selection of an item.

clearButton boolean

If set to true, renders a button on hovering over the component. Clicking this button resets the value of the component to an empty array and triggers the change event.

disabled boolean

Sets the disabled state of the component.

filterable boolean

Enables the filtering functionality of the MultiSelect.

loading boolean

Sets and gets the loading state of the MultiSelect.

tabIndex number

Specifies the tabIndex of the component.

textField string

Sets the data item field that represents the item text. If the data contains only primitive values, do not define it.

valueField string

Sets the data item field that represents the item value. If the data contains only primitive values, do not define it.

valuePrimitive boolean

Specifies the type of the selected value. If set to true, the selected value has to be of the primitive type.

For more details, refer to the section on the
valuePrimitive property.

data any[]

Sets the data of the MultiSelect.

The data has to be provided in an array-like list of items.

placeholder string

The hint displayed when the component is empty. When the values are selected, it disappears.

popupSettings PopupSettings

Configures the popup of the MultiSelect.

The available options are:

  • animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled.
  • width: Number—Sets the width of the popup container. By default, the width of the host element is used.
  • height: Number—Sets the height of the popup container. By default, the height is 200px.
  • popupClass: String—Specifies a list of CSS classes that are used to style the popup.

value any[]

Sets the value of the MultiSelect. It can either be of the primitive (string, numbers) or of the complex (objects) type. To define the type, use the valuePrimitive option.

All selected values which are not present in the source are ignored.

Fields

isOpen boolean

Returns the current open state of the popup.

Events

close EventEmitter

Fires each time the popup is about to close.
This event is preventable. If you cancel it, the popup will remain open.

filterChange EventEmitter

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

blur EventEmitter

Fires each time the MultiSelect gets blurred.

focus EventEmitter

Fires each time the user focuses the MultiSelect.

open EventEmitter

Fires each time the popup is about to open.
This event is preventable. If you cancel it, the popup will remain closed.

valueChange EventEmitter

Fires each time the value is changed.

For more details, refer to the example on events.

Methods

blur

Blurs the MultiSelect.

focus

Focuses the MultiSelect.

reset

Resets the value of the MultiSelect.

toggle

Toggles the visibility of the popup. If you use the toggle method to open or close the popup, the open and close events will not be fired.

Parameters

open boolean

The state of the popup.

In this article