JavaScript/jQuery Lookup - Templates

You can use the following properties to specify custom templates for JavaScript Lookup elements.

JavaScript Lookup Element	Property
Input field	fieldTemplate
Drop-down list items	itemTemplate
Group captions	groupTemplate

To customize elements, you can also define specific fields in data objects. Visit the items documentation for a full list of such fields. Refer to the Default Templates help topic for more information about this feature.

Backend API

$(() => { $('#lookupFieldTemplateOption').dxLookup({ items: employees, displayExpr: getDisplayExpr, dropDownOptions: { title: 'Select employee', }, valueExpr: 'ID', value: employees[0].ID, inputAttr: { 'aria-label': 'Custom Field Template', }, fieldTemplate(data) { return getTemplateMarkup(data, 'custom-field'); }, }); $('#lookupItemTemplateOptions').dxLookup({ items: employees, searchExpr: ['FirstName', 'LastName', 'Prefix'], valueExpr: 'ID', displayExpr: getDisplayExpr, dropDownOptions: { title: 'Select employee', }, placeholder: 'Select employee', inputAttr: { 'aria-label': 'Custom Item Template', }, itemTemplate(data) { return getTemplateMarkup(data, 'custom-item'); }, }); function getTemplateMarkup(data, containerClass) { return `<div class='${containerClass}'><img alt='${data.FirstName}' src='${ data.Picture}' /><div>${data.Prefix} ${ data.FirstName} ${data.LastName}</div></div>`; } function getDisplayExpr(item) { if (!item) { return ''; } return `${item.FirstName} ${item.LastName}`; } });

<!DOCTYPE html> <html> <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.6/css/dx.light.css" /> <script src="js/dx.all.js?v=25.1.6"></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 class="dx-fieldset"> <div class="dx-fieldset-header">Custom Field Template</div> <div class="dx-field"> <div id="lookupFieldTemplateOption" class="field-customization"></div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Custom Item Template</div> <div class="dx-field"> <div id="lookupItemTemplateOptions"></div> </div> </div> </div> </body> </html>

.field-customization { min-height: 32px; } .dx-lookup { height: 36px; } .dx-theme-material .dx-lookup { height: 48px; } .dx-lookup.field-customization .dx-lookup-field { padding: 2px 5px; } .custom-field > img { vertical-align: middle; height: 30px; } .dx-theme-material .custom-field > img { height: 36px; } .dx-theme-material .dx-lookup.field-customization .dx-lookup-field { padding: 6px 5px; } .custom-field > div { display: inline-block; vertical-align: middle; font-size: 14px; margin-left: 5px; } .custom-item > img { height: 48px; width: 38px; margin-right: 10px; } .custom-item > div { display: inline-block; vertical-align: top; line-height: 48px; font-size: 15px; } .dx-viewport .dx-fieldset { width: 40%; float: left; } .dx-field > .dx-lookup { flex: 1; }

const employees = [{ ID: 1, FirstName: 'John', LastName: 'Heart', Prefix: 'Mr.', Position: 'CEO', Picture: '../../../../images/employees/01.png', BirthDate: '1964/03/16', HireDate: '1995/01/15', Notes: 'John has been in the Audio/Video industry since 1990. He has led DevAv as its CEO since 2003.\r\n\r\nWhen not working hard as the CEO, John loves to golf and bowl. He once bowled a perfect game of 300.', Address: '351 S Hill St.', }, { ID: 2, FirstName: 'Olivia', LastName: 'Peyton', Prefix: 'Mrs.', Position: 'Sales Assistant', Picture: '../../../../images/employees/09.png', BirthDate: '1981/06/03', HireDate: '2012/05/14', Notes: 'Olivia loves to sell. She has been selling DevAV products since 2012. \r\n\r\nOlivia was homecoming queen in high school. She is expecting her first child in 6 months. Good Luck Olivia.', Address: '807 W Paseo Del Mar', }, { ID: 3, FirstName: 'Robert', LastName: 'Reagan', Prefix: 'Mr.', Position: 'CMO', Picture: '../../../../images/employees/03.png', BirthDate: '1974/09/07', HireDate: '2002/11/08', Notes: 'Robert was recently voted the CMO of the year by CMO Magazine. He is a proud member of the DevAV Management Team.\r\n\r\nRobert is a championship BBQ chef, so when you get the chance ask him for his secret recipe.', Address: '4 Westmoreland Pl.', }, { ID: 4, FirstName: 'Greta', LastName: 'Sims', Prefix: 'Ms.', Position: 'HR Manager', Picture: '../../../../images/employees/04.png', BirthDate: '1977/11/22', HireDate: '1998/04/23', Notes: "Greta has been DevAV's HR Manager since 2003. She joined DevAV from Sonee Corp.\r\n\r\nGreta is currently training for the NYC marathon. Her best marathon time is 4 hours. Go Greta.", Address: '1700 S Grandview Dr.', }, { ID: 5, FirstName: 'Brett', LastName: 'Wade', Prefix: 'Mr.', Position: 'IT Manager', Picture: '../../../../images/employees/05.png', BirthDate: '1968/12/01', HireDate: '2009/03/06', Notes: 'Brett came to DevAv from Microsoft and has led our IT department since 2012.\r\n\r\nWhen he is not working hard for DevAV, he coaches Little League (he was a high school pitcher).', Address: '1120 Old Mill Rd.', }, { ID: 6, FirstName: 'Sandra', LastName: 'Johnson', Prefix: 'Mrs.', Position: 'Controller', Picture: '../../../../images/employees/06.png', BirthDate: '1974/11/15', HireDate: '2005/05/11', Notes: "Sandra is a CPA and has been our controller since 2008. She loves to interact with staff so if you've not met her, be certain to say hi.\r\n\r\nSandra has 2 daughters both of whom are accomplished gymnasts.", Address: '4600 N Virginia Rd.', }, { ID: 7, FirstName: 'Kevin', LastName: 'Carter', Prefix: 'Mr.', Position: 'Shipping Manager', Picture: '../../../../images/employees/07.png', BirthDate: '1978/01/09', HireDate: '2009/08/11', Notes: 'Kevin is our hard-working shipping manager and has been helping that department work like clockwork for 18 months.\r\n\r\nWhen not in the office, he is usually on the basketball court playing pick-up games.', Address: '424 N Main St.', }, { ID: 8, FirstName: 'Cynthia', LastName: 'Stanwick', Prefix: 'Ms.', Position: 'HR Assistant', Picture: '../../../../images/employees/08.png', BirthDate: '1985/06/05', HireDate: '2008/03/24', Notes: 'Cindy joined us in 2008 and has been in the HR department for 2 years. \r\n\r\nShe was recently awarded employee of the month. Way to go Cindy!', Address: '2211 Bonita Dr.', }, { ID: 9, FirstName: 'Kent', LastName: 'Samuelson', Prefix: 'Dr.', Position: 'Ombudsman', Picture: '../../../../images/employees/02.png', BirthDate: '1972/09/11', HireDate: '2009/04/22', Notes: 'As our ombudsman, Kent is on the front-lines solving customer problems and helping our partners address issues out in the field. He is a classically trained musician and is a member of the Chamber Orchestra.', Address: '12100 Mora Dr', }];