React List - List Selection

There are three List item selection modes: "single", "multiple", and "all". To enable item selection, pass the mode name to the selectionMode property. If you set this property to "none" (default setting), item selection is disabled. In this demo, you can try out all the selection modes. Use the drop-down Selection Mode menu to switch between modes.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

TS JS

Backend API

import React, { useCallback, useState } from 'react'; import SelectBox from 'devextreme-react/select-box'; import List, { ListTypes } from 'devextreme-react/list'; import CheckBox from 'devextreme-react/check-box'; import ArrayStore from 'devextreme/data/array_store'; import { tasks, selectAllModeLabel, selectionModeLabel, selectByClickLabel, } from './data.ts'; const dataSource = new ArrayStore({ key: 'id', data: tasks, }); const selectionModes = ['none', 'single', 'multiple', 'all']; const selectAllModes = ['page', 'allPages']; export default function App() { const [selectionMode, setSelectionMode] = useState<ListTypes.Properties['selectionMode']>('all'); const [selectAllMode, setSelectAllMode] = useState<ListTypes.Properties['selectAllMode']>('page'); const [selectByClick, setSelectByClick] = useState(false); const [selectedItemKeys, setSelectedItemKeys] = useState([]); const onSelectedItemKeysChange = useCallback(({ name, value }) => { if (name === 'selectedItemKeys') { if (selectionMode !== 'none' || selectedItemKeys.length !== 0) { setSelectedItemKeys(value); } } }, [selectionMode, selectedItemKeys, setSelectedItemKeys]); const onSelectionModeChange = useCallback((value) => { setSelectionMode(value); }, [setSelectionMode]); const onSelectAllModeChange = useCallback((value) => { setSelectAllMode(value); }, [setSelectAllMode]); const onSelectByClickChange = useCallback((value) => { setSelectByClick(value); }, [setSelectByClick]); return ( <React.Fragment> <div className="widget-container"> <List dataSource={dataSource} height={400} showSelectionControls={true} selectionMode={selectionMode} selectAllMode={selectAllMode} selectedItemKeys={selectedItemKeys} selectByClick={selectByClick} onOptionChanged={onSelectedItemKeysChange}> </List> <div className="selected-data"> <span className="caption">Selected IDs: </span> <span>{ selectedItemKeys.join(', ') }</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Selection Mode</span>   <SelectBox items={selectionModes} inputAttr={selectionModeLabel} value={selectionMode} onValueChange={onSelectionModeChange}> </SelectBox> </div> <div className="option"> <span>Select All Mode</span>   <SelectBox disabled={selectionMode !== 'all'} items={selectAllModes} inputAttr={selectAllModeLabel} value={selectAllMode} onValueChange={onSelectAllModeChange}> </SelectBox> </div> <div className="option"> <span>Select By Click</span>   <CheckBox value={selectByClick} elementAttr={selectByClickLabel} onValueChange={onSelectByClickChange}> </CheckBox> </div> </div> </React.Fragment> ); }

import React, { useCallback, useState } from 'react'; import SelectBox from 'devextreme-react/select-box'; import List from 'devextreme-react/list'; import CheckBox from 'devextreme-react/check-box'; import ArrayStore from 'devextreme/data/array_store'; import { tasks, selectAllModeLabel, selectionModeLabel, selectByClickLabel, } from './data.js'; const dataSource = new ArrayStore({ key: 'id', data: tasks, }); const selectionModes = ['none', 'single', 'multiple', 'all']; const selectAllModes = ['page', 'allPages']; export default function App() { const [selectionMode, setSelectionMode] = useState('all'); const [selectAllMode, setSelectAllMode] = useState('page'); const [selectByClick, setSelectByClick] = useState(false); const [selectedItemKeys, setSelectedItemKeys] = useState([]); const onSelectedItemKeysChange = useCallback( ({ name, value }) => { if (name === 'selectedItemKeys') { if (selectionMode !== 'none' || selectedItemKeys.length !== 0) { setSelectedItemKeys(value); } } }, [selectionMode, selectedItemKeys, setSelectedItemKeys], ); const onSelectionModeChange = useCallback( (value) => { setSelectionMode(value); }, [setSelectionMode], ); const onSelectAllModeChange = useCallback( (value) => { setSelectAllMode(value); }, [setSelectAllMode], ); const onSelectByClickChange = useCallback( (value) => { setSelectByClick(value); }, [setSelectByClick], ); return ( <React.Fragment> <div className="widget-container"> <List dataSource={dataSource} height={400} showSelectionControls={true} selectionMode={selectionMode} selectAllMode={selectAllMode} selectedItemKeys={selectedItemKeys} selectByClick={selectByClick} onOptionChanged={onSelectedItemKeysChange} ></List> <div className="selected-data"> <span className="caption">Selected IDs: </span> <span>{selectedItemKeys.join(', ')}</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Selection Mode</span>   <SelectBox items={selectionModes} inputAttr={selectionModeLabel} value={selectionMode} onValueChange={onSelectionModeChange} ></SelectBox> </div> <div className="option"> <span>Select All Mode</span>   <SelectBox disabled={selectionMode !== 'all'} items={selectAllModes} inputAttr={selectAllModeLabel} value={selectAllMode} onValueChange={onSelectAllModeChange} ></SelectBox> </div> <div className="option"> <span>Select By Click</span>   <CheckBox value={selectByClick} elementAttr={selectByClickLabel} onValueChange={onSelectByClickChange} ></CheckBox> </div> </div> </React.Fragment> ); }

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

export const tasks = [{ id: 1, text: 'Prepare 2016 Financial' }, { id: 2, text: 'Prepare 2016 Marketing Plan' }, { id: 3, text: 'Update Personnel Files' }, { id: 4, text: 'Review Health Insurance Options Under the Affordable Care Act' }, { id: 5, text: 'New Brochures' }, { id: 6, text: '2016 Brochure Designs' }, { id: 7, text: 'Brochure Design Review' }, { id: 8, text: 'Website Re-Design Plan' }, { id: 9, text: 'Rollout of New Website and Marketing Brochures' }, { id: 10, text: 'Create 2012 Sales Report' }, { id: 11, text: 'Direct vs Online Sales Comparison Report' }, { id: 12, text: 'Review 2012 Sales Report and Approve 2016 Plans' }, { id: 13, text: 'Submit Signed NDA' }, { id: 14, text: 'Update Revenue Projections' }, { id: 15, text: 'Review Revenue Projections' }, { id: 16, text: 'Comment on Revenue Projections' }, { id: 17, text: 'Scan Health Insurance Forms' }, { id: 18, text: 'Sign Health Insurance Forms' }, { id: 19, text: 'Follow up with West Coast Stores' }, { id: 20, text: 'Follow up with East Coast Stores' }, { id: 21, text: 'Submit Refund Report for 2016 Recall' }, { id: 22, text: 'Give Final Approval for Refunds' }, { id: 23, text: 'Prepare Product Recall Report' }, { id: 24, text: 'Review Product Recall Report by Engineering Team' }, { id: 25, text: 'Review Training Course for any Omissions' }, { id: 26, text: 'Review Overtime Report' }, { id: 27, text: 'Submit Overtime Request Forms' }, { id: 28, text: 'Overtime Approval Guidelines' }, { id: 29, text: 'Create Report on Customer Feedback' }, { id: 30, text: 'Review Customer Feedback Report' }, { id: 31, text: 'Customer Feedback Report Analysis' }, { id: 32, text: 'Prepare Shipping Cost Analysis Report' }, { id: 33, text: 'Complete Shipper Selection Form' }, { id: 34, text: 'Upgrade Server Hardware' }, { id: 35, text: 'Upgrade Personal Computers' }, { id: 36, text: 'Approve Personal Computer Upgrade Plan' }, { id: 37, text: 'Estimate Time Required to Touch-Enable Apps' }, { id: 38, text: 'Report on Tranistion to Touch-Based Apps' }, { id: 39, text: 'Try New Touch-Enabled WinForms Apps' }, { id: 40, text: 'Site Up-Time Report' }, { id: 41, text: 'Review Site Up-Time Report' }, { id: 42, text: 'Review Online Sales Report' }, { id: 43, text: 'Determine New Online Marketing Strategy' }, { id: 44, text: 'Submit New Website Design' }, { id: 45, text: 'Create Icons for Website' }, { id: 46, text: 'Review PSDs for New Website' }, { id: 47, text: 'Create New Shopping Cart' }, { id: 48, text: 'Launch New Website' }, { id: 49, text: 'Update Customer Shipping Profiles' }, { id: 50, text: 'Create New Shipping Return Labels' }]; export const selectionModeLabel = { 'aria-label': 'Selection Mode' }; export const selectAllModeLabel = { 'aria-label': 'Select All Mode' }; export const selectByClickLabel = { 'aria-label': 'Select By Click' };

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));

export const tasks = [ { id: 1, text: 'Prepare 2016 Financial' }, { id: 2, text: 'Prepare 2016 Marketing Plan' }, { id: 3, text: 'Update Personnel Files' }, { id: 4, text: 'Review Health Insurance Options Under the Affordable Care Act' }, { id: 5, text: 'New Brochures' }, { id: 6, text: '2016 Brochure Designs' }, { id: 7, text: 'Brochure Design Review' }, { id: 8, text: 'Website Re-Design Plan' }, { id: 9, text: 'Rollout of New Website and Marketing Brochures' }, { id: 10, text: 'Create 2012 Sales Report' }, { id: 11, text: 'Direct vs Online Sales Comparison Report' }, { id: 12, text: 'Review 2012 Sales Report and Approve 2016 Plans' }, { id: 13, text: 'Submit Signed NDA' }, { id: 14, text: 'Update Revenue Projections' }, { id: 15, text: 'Review Revenue Projections' }, { id: 16, text: 'Comment on Revenue Projections' }, { id: 17, text: 'Scan Health Insurance Forms' }, { id: 18, text: 'Sign Health Insurance Forms' }, { id: 19, text: 'Follow up with West Coast Stores' }, { id: 20, text: 'Follow up with East Coast Stores' }, { id: 21, text: 'Submit Refund Report for 2016 Recall' }, { id: 22, text: 'Give Final Approval for Refunds' }, { id: 23, text: 'Prepare Product Recall Report' }, { id: 24, text: 'Review Product Recall Report by Engineering Team' }, { id: 25, text: 'Review Training Course for any Omissions' }, { id: 26, text: 'Review Overtime Report' }, { id: 27, text: 'Submit Overtime Request Forms' }, { id: 28, text: 'Overtime Approval Guidelines' }, { id: 29, text: 'Create Report on Customer Feedback' }, { id: 30, text: 'Review Customer Feedback Report' }, { id: 31, text: 'Customer Feedback Report Analysis' }, { id: 32, text: 'Prepare Shipping Cost Analysis Report' }, { id: 33, text: 'Complete Shipper Selection Form' }, { id: 34, text: 'Upgrade Server Hardware' }, { id: 35, text: 'Upgrade Personal Computers' }, { id: 36, text: 'Approve Personal Computer Upgrade Plan' }, { id: 37, text: 'Estimate Time Required to Touch-Enable Apps' }, { id: 38, text: 'Report on Tranistion to Touch-Based Apps' }, { id: 39, text: 'Try New Touch-Enabled WinForms Apps' }, { id: 40, text: 'Site Up-Time Report' }, { id: 41, text: 'Review Site Up-Time Report' }, { id: 42, text: 'Review Online Sales Report' }, { id: 43, text: 'Determine New Online Marketing Strategy' }, { id: 44, text: 'Submit New Website Design' }, { id: 45, text: 'Create Icons for Website' }, { id: 46, text: 'Review PSDs for New Website' }, { id: 47, text: 'Create New Shopping Cart' }, { id: 48, text: 'Launch New Website' }, { id: 49, text: 'Update Customer Shipping Profiles' }, { id: 50, text: 'Create New Shipping Return Labels' }, ]; export const selectionModeLabel = { 'aria-label': 'Selection Mode' }; export const selectAllModeLabel = { 'aria-label': 'Select All Mode' }; export const selectByClickLabel = { 'aria-label': 'Select By Click' };

<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.2.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

.selected-data, .options { margin-top: 20px; padding: 20px; background-color: rgba(191, 191, 191, 0.15); } .selected-data .caption { font-weight: bold; font-size: 115%; } .options .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; } .option > span { width: 120px; display: inline-block; } .option > .dx-widget { display: inline-block; vertical-align: middle; width: 100%; max-width: 350px; }

List items can display checkboxes or radio buttons. To show these controls, enable the showSelectionControls property. Otherwise, users can click or tap list items to select them. The showSelectionControls property should also be enabled when you use the "all" selectionMode to show the Select All checkbox.

When the List data is paginated, you can choose whether the Select All checkbox selects all items on all pages or only the items on the current page. To configure this functionality, set the selectAllMode property to "allPages" or "page". In this demo, you can use the drop-down Select All Mode menu to change the selectAllMode property at runtime.

To configure the initial selection or access the keys of selected items, use the selectedItemKeys array. This example shows the contents of this array in the Selected IDs section below the List.

You can also implement the onSelectionChanged event handler to perform an action when users select items.