DevExtreme v24.1 is now available.

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

Your search did not match any results.

Customize Item

You can use the items[] array to configure all form items. This array can contain strings (formData field names) and objects (item configurations).

Use a string to create a simple item with default configuration as shown for the Email item.

Backend API
<template> <DxForm :on-content-ready="validateForm" :form-data="employee" > <DxGroupItem :col-count="2" caption="Employee Details" > <DxItem :editor-options="nameEditorOptions" data-field="FirstName" > <DxLabel template="nameLabel"/> </DxItem> <DxItem :editor-options="positionEditorOptions" :validation-rules="validationRules.position" data-field="Position" editor-type="dxSelectBox" > <DxLabel template="positionLabel"/> </DxItem> <DxItem :editor-options="nameEditorOptions" data-field="LastName" > <DxLabel template="nameLabel"/> </DxItem> <DxItem :editor-options="hireDateEditorOptions" :validation-rules="validationRules.hireDate" data-field="HireDate" editor-type="dxDateBox" > <DxLabel template="dateLabel"/> </DxItem> <DxItem :editor-options="birthDateEditorOptions" data-field="BirthDate" editor-type="dxDateBox" > <DxLabel template="dateLabel"/> </DxItem> <DxItem data-field="Address" > <DxLabel template="addressLabel"/> </DxItem> <DxItem :col-span="2" :editor-options="notesEditorOptions" data-field="Notes" editor-type="dxTextArea" > <DxLabel template="notesLabel"/> </DxItem> <DxItem :editor-options="phoneEditorOptions" data-field="Phone" > <DxLabel template="phoneLabel"/> </DxItem> <DxItem data-field="Email" > <DxLabel template="emailLabel"/> </DxItem> </DxGroupItem> <template #nameLabel="{ data }"> <LabelTemplate :data="data" icon="user" /> </template> <template #positionLabel="{ data }"> <LabelTemplate :data="data" icon="info" /> </template> <template #dateLabel="{ data }"> <LabelTemplate :data="data" icon="event" /> </template> <template #addressLabel="{ data }"> <LabelTemplate :data="data" icon="home" /> </template> <template #notesLabel="{ data }"> <LabelNotesTemplate :data="data" /> </template> <template #phoneLabel="{ data }"> <LabelTemplate :data="data" icon="tel" /> </template> <template #emailLabel="{ data }"> <LabelTemplate :data="data" icon="email" /> </template> </DxForm> </template> <script setup lang="ts"> import { DxForm, DxItem, DxLabel, DxGroupItem, } from 'devextreme-vue/form'; import service from './data.ts'; import 'devextreme-vue/text-area'; import LabelTemplate from './LabelTemplate.vue'; import LabelNotesTemplate from './LabelNotesTemplate.vue'; const employee = service.getEmployee(); const positions = service.getPositions(); const validationRules = { position: [ { type: 'required', message: 'Position is required.' }, ], hireDate: [ { type: 'required', message: 'Hire Date is required.' }, ], }; const nameEditorOptions = { disabled: true }; const positionEditorOptions = { items: positions, searchEnabled: true, value: '' }; const hireDateEditorOptions = { width: '100%', value: null }; const birthDateEditorOptions = { width: '100%', disabled: true }; const notesEditorOptions = { height: 90, maxLength: 200 }; const phoneEditorOptions = { mask: '+1 (X00) 000-0000', maskRules: { X: /[02-9]/ } }; function validateForm(e) { e.component.validate(); } </script>
<template> <div id="template-content"> <i id="helpedInfo" class="dx-icon dx-icon-info" /> Additional <br> {{ data.text }} <DxTooltip target="#helpedInfo" show-event="mouseenter" hide-event="mouseleave" > <template #content> <div id="tooltip-content">This field must not exceed 200 characters</div> </template> </DxTooltip> </div> </template> <script setup lang="ts"> import { DxTooltip } from 'devextreme-vue/tooltip'; withDefaults(defineProps<{ data?: Record<string, any> }>(), { data: () => ({}), }); </script> <style scoped> #helpedInfo { color: #42a5f5; } #tooltip-content { font-size: 14px; font-weight: bold; } #template-content { display: inline-flex; } </style>
<template> <div> <i :class="`dx-icon dx-icon-${icon}`"/>{{ data.text }} </div> </template> <script setup lang="ts"> withDefaults(defineProps<{ data?: Record<string, any> icon?: string }>(), { data: () => {}, icon: 'info', }); </script>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.2.47/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-vue': 'npm:devextreme-vue@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, }, }; System.config(window.config);
const employee = { ID: 1, FirstName: 'John', LastName: 'Heart', Position: 'CEO', 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., Los Angeles, CA', Phone: '360-684-1334', Email: 'jheart@dx-email.com', }; const positions = [ 'HR Manager', 'IT Manager', 'CEO', 'Controller', 'Sales Manager', 'Support Manager', 'Shipping Manager', ]; export default { getEmployee() { return employee; }, getPositions() { return positions; }, };
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!DOCTYPE html> <html 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" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>

To change the default settings, declare an item configuration object. Use the dataField property to bind an item to a field in the formData object. Use the editorType property to specify an item's data editor or configure the editor in the editorOptions object. You can also specify any other properties described in the SimpleItem section.

To customize item labels, use the label.template property. The demo uses this property to add icons to the labels. Refer to the Additional Notes item's implementation for instructions on how to add an icon with a tooltip to the label.

This demo shows how to specify editorOptions, editorType, validationRules, and colSpan properties for simple items in a Form component.