DropDownListComponent

Represents the Kendo UI DropDownList component for Angular.

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

Selector

kendo-dropdownlist

Export Name

Accessible in templates as #kendoDropDownListInstance="kendoDropDownList"

Inputs

defaultItem

any

Sets the text of the default empty item. The type of the defined value has to match the data type.

delay

number

Sets the delay before an item search is performed. When filtration is disabled, use this option.

disabled

boolean

Sets the disabled state of the component.

filterable

boolean

Enables the filtering functionality of the DropDownList.

ignoreCase

boolean

Enables a case-insensitive search. When filtration is disabled, use this option.

listHeight

number

Sets the height of the options list. By default, listHeight is 200px.

The listHeight property affects only the list of options and not the whole popup container. To set the height of the popup container, use popupSettings.height.

loading

boolean

Sets and gets the loading state of the DropDownList.

readonly

boolean

Sets the read-only state of the component.

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.

data

any

Sets the data of the DropDownList.

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

itemDisabled

ItemDisabledFn

Defines a Boolean function that is executed for each data item in the component (see examples). Determines whether the item will be disabled.

popupSettings

PopupSettings

Configures the popup of the DropDownList.

The available options are:

  • animate: BooleanControls the popup animation. By default, the open and close animations are enabled.
  • width: Number | StringSets the width of the popup container. By default, the width of the host element is used. If set to auto, the component automatically adjusts the width of the popup and no item labels are wrapped. The auto mode is not supported when virtual scrolling is enabled.
  • height: NumberSets the height of the popup container.
  • popupClass: StringSpecifies a list of CSS classes that are used to style the popup.
  • appendTo: "root" | "component" | ViewContainerRefSpecifies the component to which the popup will be appended.

value

any

Sets the value of the DropDownList. 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.

valuePrimitive

boolean

Specifies the type of the selected value (more information and example). If set to true, the selected value has to be of a primitive value.

virtual

boolean | VirtualizationSettings

Enables the virtualization functionality.

Fields

isOpen

boolean

Returns the current open state of the popup.

Events

close

EventEmitter<PreventableEvent>

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

filterChange

EventEmitter<any>

Fires each time the user types in the input field (see example). You can filter the source based on the passed filtration value. When the value of the component is programmatically changed to ngModel or formControl through its API or form binding, the valueChange event is not triggered because it might cause a mix-up with the built-in valueChange mechanisms of the ngModel or formControl bindings.

blur

EventEmitter<any>

Fires each time the DropDownList gets blurred.

focus

EventEmitter<any>

Fires each time the user focuses the DropDownList.

open

EventEmitter<PreventableEvent>

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

selectionChange

EventEmitter<any>

Fires each time the item selection is changed (see example).

valueChange

EventEmitter<any>

Fires each time the value is changed (see example).

Methods

blur

Blurs the DropDownList.

focus

Focuses the DropDownList.

reset

Resets the value of the DropDownList. If you use the reset method to clear the value of the component, the model will not update automatically and the selectionChange and valueChange events will not be fired.

toggle

Toggles the visibility of the popup (see example). 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.