DevExtreme v25.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

JavaScript/jQuery List - Selection

There are three JavaScript 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.

Backend API
$(() => { const listWidget = $('#simpleList').dxList({ dataSource: new DevExpress.data.DataSource({ store: new DevExpress.data.ArrayStore({ key: 'id', data: tasks, }), }), height: 400, showSelectionControls: true, selectionMode: 'all', selectByClick: false, onSelectionChanged() { $('#selectedItemKeys').text(listWidget.option('selectedItemKeys').join(', ')); }, }).dxList('instance'); $('#selectionMode').dxSelectBox({ value: 'all', items: ['none', 'single', 'multiple', 'all'], inputAttr: { 'aria-label': 'Selection Mode' }, onValueChanged(data) { listWidget.option('selectionMode', data.value); selectAllModeChooser.option('disabled', data.value !== 'all'); if (data.value === 'none') { $('#selectedItemKeys').text(''); } }, }); const selectAllModeChooser = $('#selectAllMode').dxSelectBox({ disabled: false, items: ['page', 'allPages'], value: 'page', inputAttr: { 'aria-label': 'Select All Mode' }, onValueChanged(data) { listWidget.option('selectAllMode', data.value); }, }).dxSelectBox('instance'); $('#selectByClick').dxCheckBox({ value: false, elementAttr: { 'aria-label': 'Selection By Click' }, onValueChanged(e) { listWidget.option('selectByClick', e.value); }, }); });
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" 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" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.3/css/dx.light.css" /> <script src="js/dx.all.js"></script> <script src="data.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="list-demo"> <div class="widget-container"> <div id="simpleList"></div> <div class="selected-data"> <span class="caption">Selected IDs: </span> <span id="selectedItemKeys"></span> </div> </div> <div class="options"> <div class="caption">Options</div> <div class="option"> <span>Selection Mode</span> <div id="selectionMode"></div> </div> <div class="option"> <span>Select All Mode</span> <div id="selectAllMode"></div> </div> <div class="option"> <span>Select By Click</span> <div id="selectByClick"></div> </div> </div> </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; }
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' }];

JavaScript 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 JavaScript 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 JavaScript List.

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