Angular ListBox Component

The ListBox component for Angular represents a listbox widget that contains a list of selectable items.

Prerequisites

Refer to Angular Getting Started before you start with this help topic.

Configuration

The ListBox component for Angular requires the following imports.

Mark a class as an Angular component through the @Component decorator:

The full list of @Component decorator properties is available on: Angular @Component Decorator API

Every jQWidgets Angular component has an [auto-create] attribute which determines whether the component is automatically created or is created on demand by API method call.
By default, the [auto-create] attribute value is true.


Create the AppComponent class.

The AppComponent class is used to instantiate the app. In some of the examples, we use @ViewChild and ngAfterViewInit.

The following example demonstrates the ListBox component for Angular.

app.component.htm

app.component.ts

Run Code

Create ListBox component with JSON

Properties

The properties which are defined as attributes can be changed directly:

To get or set a property, which we did not define or call a method, we can do the following:

Every component has a method setOptions which accepts a JSON object as an argument. This object contains component settings and you can use it to set a single or multiple properties dynamically.

Events

The change event is triggered when the user selects an item.

The following example demonstrates how to add an event listener.

Note: Event Names of the ListBox component for Angular are the same as the Event Names of the jqxListBox widget.
The only thing you need to do is to put "on" before the event name and upperCase it's the first letter.

Methods

To invoke methods, you can use the ListBox reference.
 ( enableAt(index) to enable item of the widget )  - this.myListBox.enableAt(0).

The following example demonstrates how to invoke methods of the ListBox component for Angular.

ListBox Examples

Overview

The following example demonstrates how to create a ListBox component for Angular.

Disabling

The following example demonstrates how to disable the ListBox component for Angular.

Using ListBox with Angular Directives

<jqxListBox #component
       [width]="250"  
       [height]="300">  
           <ul>  
                <li *ngFor="let hero of heroes">  
                     <span class="badge">{{hero.id}}</span> {{hero.name}}  
                </li>  
           </ul>  
 </jqxListBox>  

ListBox API

API Reference of the jQWidgets ListBox component for Angular: ListBox API