React UI Components Documentation

ReactJS ListBox Component

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

Prerequisites

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

Configuration

The ListBox component for ReactJS requires the following imports.

 
import React from 'react';
import ReactDOM from 'react-dom';
import JqxListBox from 'jqwidgets-react/react_jqxlistbox.js';

Then we create our component class. Properties and methods are put as ReactJS props.

  
class App extends React.Component {
render () {
return (
<JqxListBox width={220} height={220} source={source} />
)
}
}

Finally we render our class in the desired HTML element:

 
ReactDOM.render(<App />, document.getElementById('app'));

Events Methods & Properties

In order to bind to any event, change any property or call any method, we need a reference to the component.
For that we use the ReactJS "ref" Callback Attribute:

 
<JqxListBox ref='myListBox' width={220} height={220}..... />

Now, when we have a reference, we need to call the desired event/property/method.
This is done in the componentDidMount() ReactJS Component Lifecycle method.

Events

The change event is triggered when the ListBox's selection is changed.

The following example demonstrates how to add an event listener:

Methods & Properties

This is how you call methods & props:

Every component have a method setOptions which accepts a object as an argument. This object contains component settings.

Every component also have a method getOptions which returns a object containing the component settings.

ListBox Examples

Overview

The following example demonstrates how to create a ListBox component.

Disabled ListBox

The following example demonstrates how to disable the ListBox component.

ListBox API

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