Vue Lookup - Customize Item Appearance
For a minor customization of Lookup items, you can define specific fields in item data objects. For example, the following code generates three items: the first is not customized, the second is disabled and the third is hidden.
- <template>
- <DxLookup
- :data-source="dataSource"
- value-expr="text"
- display-expr="text"
- />
- </template>
- <script>
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import { DxLookup } from 'devextreme-vue/lookup';
- export default {
- components: {
- DxLookup
- },
- data() {
- return {
- dataSource: [
- { text: 'HD Video Player' },
- { text: 'SuperHD Video Player', disabled: true },
- { text: 'SuperPlasma 50', visible: false }
- ]
- };
- }
- }
- </script>
If you need a more flexible solution, define an itemTemplate. In Angular and Vue, you can declare it in the markup. In React, you can use a rendering function (shown in the code below) or component:
- <template>
- <DxLookup
- :data-source="dataSource"
- value-expr="id"
- item-template="item">
- <template #item="{ data, index }">
- <div>
- <img :src="data.imgSrc"/>
- <div
- :style="{'display': 'inline-block', 'font-style': index % 2 === 0 ? 'italic' : 'normal'}">
- {{data.name}}
- </div>
- </div>
- </template>
- </DxLookup>
- </template>
- <script>
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import { DxLookup } from 'devextreme-vue/lookup';
- export default {
- components: {
- DxLookup
- },
- data() {
- return {
- dataSource: [{
- id: 1,
- name: "HD Video Player",
- imgSrc: "images/products/1-small.png"
- }, {
- id: 2,
- name: "UltraHD Player",
- imgSrc: "images/products/2-small.png"
- },
- // ...
- ]
- };
- }
- }
- </script>
If you use jQuery alone, use DOM manipulation methods to combine the HTML markup for items. To apply this markup, use the itemTemplate callback function as shown in the following code.
- const lookupData = [{
- id: 1,
- name: "HD Video Player",
- imgSrc: "images/products/1-small.png"
- }, {
- id: 2,
- name: "UltraHD Player",
- imgSrc: "images/products/2-small.png"
- },
- // ...
- ];
- $(function() {
- $("#lookupContainer").dxLookup({
- dataSource: lookupData,
- valueExpr: 'id',
- displayExpr: 'name',
- itemTemplate: function (itemData, itemIndex, itemElement) {
- return $("<div />").append(
- $("<img />").attr("src", itemData.imgSrc),
- $("<p />").text(itemData.name)
- .css("display", "inline-block")
- .css("font-style", (itemIndex % 2 == 0) ? "italic" : "normal")
- );
- }
- });
- });
You can also customize an individual Lookup item. For this purpose, declare a template for this item as a script and pass its id
to the template field.
- <script id="individualTemplate" type="text/html">
- <!-- ... -->
- </script>
- const lookupData = [
- { text: "SuperHD Player"},
- { text: "HD Video Player", template: $("#individualTemplate") },
- // ...
- ];
Using similar techniques, you can customize the input field of the Lookup. The template for it should be assigned to the fieldTemplate property.
- <template>
- <DxLookup
- :data-source="dataSource"
- value-expr="id"
- display-expr="name"
- field-template="fieldInput">
- <template #fieldInput="{ data }">
- <img :src="data && data.imgSrc"/>
- </template>
- </DxLookup>
- </template>
- <script>
- import 'devextreme/dist/css/dx.common.css';
- import 'devextreme/dist/css/dx.light.css';
- import { DxLookup } from 'devextreme-vue/lookup';
- export default {
- components: {
- DxLookup
- },
- data() {
- return {
- dataSource: [{
- id: 1,
- name: "HD Video Player",
- imgSrc: "images/products/1-small.png"
- }, {
- id: 2,
- name: "UltraHD Player",
- imgSrc: "images/products/2-small.png"
- },
- // ...
- ]
- };
- }
- }
- </script>
In addition, you can use a 3rd-party template engine to perform the needed customizations. For more information, see the 3rd-Party Template Engines article.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.