Getting Started with the KendoReact ListBox

This guide provides essential information about using the KendoReact ListBox package—you will learn how to install the ListBox package, add a ListBox component to your project, style the component, and activate your license.

After completing this guide, you will be able to reproduce the following example.

Setting Up Your React Project

Before you install the KendoReact ListBox, make sure that you have a running React project. The easiest way to set up a React project is to use the Create React App approach that is described in the Get Started with KendoReact article.

Installing the ListBox Package

All KendoReact packages are distributed through npm and offer a similar installation experience. To use the ListBox component, start with the installation of the ListBox npm package and its dependencies. Use Node.js v5.0.0 or later.

Copy Codenpm install --save @progress/kendo-react-listbox @progress/kendo-react-intl @progress/kendo-licensing @progress/kendo-svg-icons

Importing the Component

After installing the package, import the ListBox component in the React App. To provide a flowless data transfer between multiple ListBox components, import the processListBoxData method.

In the src/App.js file of your React project, add the imports.

Copy Code// ES2015 module syntax
import { ListBox, processListBoxData } from "@progress/kendo-react-conversational-ui";

Copy Code// CommonJS format
const { ListBox, processListBoxData } = require('@progress/kendo-react-conversational-ui');

Using the Component

1. Import the data for the ListBox.

   Copy Code  import { data } from './data';

2. Create a state variable to hold the data for the two ListBox components.

   Copy Code  const [state, setState] = React.useState({
         employees: data,
         developers: []
     });

3. Set the selectField value. That value will determine which items are selected.

   Copy Code  const SELECTED_FIELD = 'selected';

4. Handle the onItemClick event of the ListBox to select or deselect items.

   Copy Code  const handleItemClick = (event, data, connectedData) => {
         setState({
           ...state,
           [data]: state[data].map(item => {
               if (item.name === event.dataItem.name) {
                   item[SELECTED_FIELD] = !item[SELECTED_FIELD];
               } else if (!event.nativeEvent.ctrlKey) {
                   item[SELECTED_FIELD] = false;
               }
               return item;
           }),
           [connectedData]: state[connectedData].map(item => {
               item[SELECTED_FIELD] = false;
               return item;
           })
         });
     }

5. Handle the onToolClick event of the ListBoxToolbar to update the lists.

   Copy Code  const handleToolBarClick = (e: ListBoxToolbarClickEvent) => {
         let toolName: string = e.toolName || '';
         let result: any = processListBoxData(state.employees, state.developers, toolName, SELECTED_FIELD);
         setState({
             ...state,
             employees: result.listBoxOneData,
             developers: result.listBoxTwoData
         });
     }

6. Add the markup of the two components to the src/App.js file in your project.

   Copy Code  return (
       <div className='container'>
         <div className='row justify-content-center'>
           <div className='col k-pr-2'>
             <h6>Employees</h6>
             <ListBox
               style={{ height: 400, width: '100%' }}
               data={state.employees}
               textField="name"
               selectedField={SELECTED_FIELD}
               onItemClick={(e: ListBoxItemClickEvent) => handleItemClick(e, 'employees', 'developers')}
               toolbar={() => {
                               return (
                                 <ListBoxToolbar
                                   tools={['moveUp', 'moveDown', 'transferTo', 'transferFrom', 'transferAllTo', 'transferAllFrom', 'remove']}
                                   data={state.employees}
                                   dataConnected={state.developers}
                                   onToolClick={handleToolBarClick}
                                   />
                               );
                           }}
             />
           </div>
           <div className='col k-pl-0'>
             <h6>Developers</h6>
             <ListBox
               style={{ height: 400, width: '100%' }}
               data={state.developers}
               textField="name"
               selectedField={SELECTED_FIELD}
               onItemClick={(e: ListBoxItemClickEvent) => handleItemClick(e, 'developers', 'employees')}
             />
           </div>
         </div>
       </div>
     );

7. To style the ListBox, install and import the Default theme, which is one of the three beautiful themes for KendoReact.

   7.1. Install the Default theme package.

   Copy Codenpm install --save @progress/kendo-theme-default

   7.2. Import the CSS file from the package in src/App.js. Add this import before your existing App.css import.

   Copy Codeimport '@progress/kendo-theme-default/dist/all.css';

8. Build and run the application by typing the following command in the root folder of your project:

   Copy Codenpm start

9. Navigate to http://localhost:3000 to see the KendoReact ListBox component on the page.

Activating Your License Key

Using any of the UI components in the KendoReact library requires either a commercial license key or an active trial license key.

Follow the instructions on the KendoReact My License page to activate your trial or commercial license. You can skip this step if your application already contains a KendoReact license file.

Dependencies

The ListBox package requires you to install the following peer dependencies in your application:

Suggested Links

• Selection
• Drag and Drop
• Customization
• Multiple Lists

Learning Resources

• Getting Started with KendoReact
• Virtual Classroom (Introductory Course Available to Trial and Commercial License Holders)
• Explore the Finance Portfolio Sample Application
• Explore the Coffee Warehouse Sample Application
• Explore the Github Issues Grid Sample Application