DevExtreme Angular - Enable Grouping

The Lookup can organize items in groups. If you use a simple array as a data source, its objects must have the key and items fields.

TypeScript
HTML
  • import { DxLookupModule } from "devextreme-angular";
  • // ...
  • export class AppComponent {
  • lookupDataSource = [{
  • key: "Mr. John Heart",
  • items: ["Google AdWords Strategy", "New Brochures", "Update NDA Agreement"]
  • }, {
  • key: "Mrs. Olivia Peyton",
  • items: ["Update Personnel Files", "Non-Compete Agreements", "Give Final Approval for Refunds"]
  • }, // ...
  • ];
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxLookupModule
  • ],
  • // ...
  • })
  • <dx-lookup
  • [dataSource]="lookupDataSource"
  • [grouped]="true">
  • </dx-lookup>
NOTE
Only one-level grouping is supported.

If you use the DevExtreme DataSource, specify its group option. In both cases, you need to make the Lookup know that its data source is grouped by assigning true to the grouped option.

TypeScript
HTML
  • import { DxLookupModule } from "devextreme-angular";
  • import DataSource from "devextreme/data/data_source";
  • // ...
  • export class AppComponent {
  • data = [
  • { name: "Amelia", birthYear: 1991, gender: "female" },
  • { name: "Benjamin", birthYear: 1983, gender: "male" },
  • { name: "Andrew", birthYear: 1991, gender: "male" },
  • { name: "Daniela", birthYear: 1983, gender: "female" },
  • { name: "Lee", birthYear: 1983, gender: "male" },
  • { name: "Betty", birthYear: 1983, gender: "female" }
  • ];
  • lookupDataSource = new DataSource({
  • store: data,
  • group: "gender"
  • });
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxLookupModule
  • ],
  • // ...
  • })
  • <dx-lookup
  • [dataSource]="lookupDataSource"
  • [grouped]="true"
  • displayExpr="name"
  • valueExpr="name">
  • </dx-lookup>

You can define a custom template for the group headers. For Angular, AngularJS and Knockout apps, DevExtreme provides a markup component called dxTemplate. The following code shows how you can use dxTemplate to define a template for the Lookup group headers.

HTML
TypeScript
  • <dx-lookup
  • [dataSource]="lookupDataSource"
  • [grouped]="true"
  • groupTemplate="groupTemplate">
  • <div *dxTemplate="let group of 'groupTemplate'; let i = index">
  • <div>[{{i + 1}}] Assigned: {{group.key}}</div>
  • </div>
  • </dx-lookup>
  • import { DxLookupModule } from "devextreme-angular";
  • import DataSource from "devextreme/data/data_source";
  • // ...
  • export class AppComponent {
  • lookupDataSource = [{
  • key: "Mr. John Heart",
  • items: ["Google AdWords Strategy", "New Brochures", "Update NDA Agreement"]
  • }, {
  • key: "Mrs. Olivia Peyton",
  • items: ["Update Personnel Files", "Non-Compete Agreements", "Give Final Approval for Refunds"]
  • }, // ...
  • ];
  • }
  • @NgModule({
  • imports: [
  • // ...
  • DxLookupModule
  • ],
  • // ...
  • })

If you use jQuery alone, combine the HTML markup for items manually with jQuery DOM manipulation methods. To apply this markup, use the itemTemplate callback function as shown in the following code.

JavaScript
  • var lookupData = [{
  • key: "Mr. John Heart",
  • items: ["Google AdWords Strategy", "New Brochures", "Update NDA Agreement"]
  • }, {
  • key: "Mrs. Olivia Peyton",
  • items: ["Update Personnel Files", "Non-Compete Agreements", "Give Final Approval for Refunds"]
  • }, // ...
  • ];
  •  
  • $(function() {
  • $("#lookupContainer").dxLookup({
  • dataSource: lookupData,
  • grouped: true,
  • groupTemplate: function (data) {
  • return $("<div>Assigned: " + data.key + "</div>");
  • }
  • });
  • });
See Also