Grouping in EJ2 JavaScript MultiSelect Dropdown
4 Sep 202611 minutes to read
The MultiSelect supports wrapping nested elements into a group based on different categories. The category of each list item can be mapped through the groupBy field in the data table. The group header is displayed both as inline and fixed headers. The fixed group header content is updated dynamically on scrolling the popup list with its category value.
In the following sample, vegetables are grouped according to their category using the groupBy field.
var sportsData = ['Badminton', 'Cricket', 'Football', 'Golf', 'Tennis'];
// initialize MultiSelect component
var listObj = new ej.dropdowns.MultiSelect({
dataSource: sportsData,
// set placeholder to MultiSelect input element
placeholder: "Select games"});
listObj.appendTo('#select');<!DOCTYPE html><html lang="en"><head>
<title>Essential JS 2 MultiSelect</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Typescript UI Controls">
<meta name="author" content="Syncfusion">
<link href="styles.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-base/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-inputs/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-dropdowns/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-buttons/styles/material.css" rel="stylesheet">
<script src="https://cdn.syncfusion.com/ej2/34.2.2/dist/ej2.min.js" type="text/javascript"></script>
</head>
<body>
<div id="container" style="margin:0 auto; width:250px;">
<br>
<!--element which is going to render the MultiSelect-->
<input type="text" tabindex="1" id="select">
</div>
<script>
var ele = document.getElementById('container');
if(ele) {
ele.style.visibility = "visible";
}
</script>
<script src="index.js" type="text/javascript"></script>
</body></html>HTML select
The MultiSelect also supports grouping list items by initializing the <select> element with <optgroup> tags. The nested items are wrapped based on the <optgroup> element present in the <select> element.
<select id="selectElement">
<optgroup label="Beans">
<option value="1">Chickpea</option>
<option value="2">Green bean</option>
<option value="3">Horse gram</option>
</optgroup>
<optgroup label="Leafy and Salad">
<option value="4">Spinach</option>
<option value="5" selected="selected">Cabbage</option>
<option value="6">Wheat grass</option>
</optgroup>
</select>
// initialize MultiSelect component
var listObj = new ej.dropdowns.MultiSelect({
// set placeholder to MultiSelect input element
placeholder: "Select games"});
listObj.appendTo('#selectElement');<!DOCTYPE html><html lang="en"><head>
<title>Essential JS 2 MultiSelect</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Typescript UI Controls">
<meta name="author" content="Syncfusion">
<link href="styles.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-base/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-inputs/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-dropdowns/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-buttons/styles/material.css" rel="stylesheet">
<script src="https://cdn.syncfusion.com/ej2/34.2.2/dist/ej2.min.js" type="text/javascript"></script>
</head>
<body>
<div id="container" style="margin:0 auto; width:250px;">
<select id="selectElement">
<optgroup label="Beans">
<option value="1">Chickpea</option>
<option value="2">Green bean</option>
<option value="3">Horse gram</option>
</optgroup>
<optgroup label="Leafy and Salad">
<option value="4" selected="selected">Cabbage</option>
<option value="5">Spinach</option>
<option value="6">Wheat grass</option>
</optgroup>
</select>
</div>
<script>
var ele = document.getElementById('container');
if(ele) {
ele.style.visibility = "visible";
}
</script>
<script src="index.js" type="text/javascript"></script>
</body></html>Customization
The grouping header can also be customized for both inline and fixed headers using the groupTemplate property.
Grouping with CheckBox
Previously, there was no checkbox for group headers. Now, this feature allows you to render a checkbox in the group header to select the group items in a single selection. You can enable this feature by setting the enableGroupCheckBox property value to true and the mode property to CheckBox.
Inject the CheckBoxSelection module into the MultiSelect to use the checkbox.
var vegetableData = [
{ id: 'vegetable1', vegetable: 'Cabbage', category: 'Leafy and Salad' },
{ id: 'vegetable2', vegetable: 'Spinach', category: 'Leafy and Salad' },
{ id: 'vegetable3', vegetable: 'Wheat grass', category: 'Leafy and Salad' },
{ id: 'vegetable4', vegetable: 'Yarrow', category: 'Leafy and Salad' },
{ id: 'vegetable5', vegetable: 'Pumpkin', category: 'Leafy and Salad' },
{ id: 'vegetable6', vegetable: 'Chickpea', category: 'Beans' },
{ id: 'vegetable7', vegetable: 'Green bean', category: 'Beans' },
{ id: 'vegetable8', vegetable: 'Horse gram', category: 'Beans' },
{ id: 'vegetable9', vegetable: 'Garlic', category: 'Bulb and Stem' },
{ id: 'vegetable10', vegetable: 'Nopal', category: 'Bulb and Stem' },
{ id: 'vegetable11', vegetable: 'Onion', category: 'Bulb and Stem' }
];
// initialize MultiSelect component
var listObj = new ej.dropdowns.MultiSelect({
dataSource: vegetableData,
// maps the appropriate column to fields property
fields: { text: 'vegetable', value: 'id', groupBy: 'category' },
// set placeholder to MultiSelect input element
placeholder: "Select vegetables",
// set placeholder to filterbar
filterBarPlaceholder: "Search vegetables",
// set the type of mode for checkbox to visualized the checkbox added in li element.
mode: 'CheckBox',
// set true for enable the selectAll support.
showSelectAll: true,
// set true for enableGroupCheckBox property
enableGroupCheckBox: true});
listObj.appendTo('#select');<!DOCTYPE html><html lang="en"><head>
<title>Essential JS 2 MultiSelect</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Typescript UI Controls">
<meta name="author" content="Syncfusion">
<link href="styles.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-base/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-inputs/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-dropdowns/styles/material.css" rel="stylesheet">
<link href="https://cdn.syncfusion.com/ej2/34.2.2/ej2-buttons/styles/material.css" rel="stylesheet">
<script src="https://cdn.syncfusion.com/ej2/34.2.2/dist/ej2.min.js" type="text/javascript"></script>
</head>
<body>
<div id="container" style="margin:0 auto; width:250px;">
<br>
<!--element which is going to render the MultiSelect-->
<input type="text" tabindex="1" id="select">
</div>
<script>
var ele = document.getElementById('container');
if(ele) {
ele.style.visibility = "visible";
}
</script>
<script src="index.js" type="text/javascript"></script>
</body></html>