Your search did not match any results.
Form

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.

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.

Backend API
Copy to CodeSandBox
Apply
Reset
<div id="form-container"> <dx-form id="form" [formData]="employee"> <dxi-item itemType="group" [colCount]="2" caption="Employee Details"> <dxi-item dataField="FirstName" [editorOptions]="nameEditorOptions"> <dxo-label template="name"></dxo-label> </dxi-item> <dxi-item dataField="Position" editorType="dxSelectBox" [editorOptions]="positionEditorOptions" > <dxi-validation-rule type="required" message="Position is required" ></dxi-validation-rule> <dxo-label template="position"></dxo-label> </dxi-item> <dxi-item dataField="LastName" [editorOptions]="nameEditorOptions"> <dxo-label template="name"></dxo-label> </dxi-item> <dxi-item dataField="HireDate" editorType="dxDateBox" [editorOptions]="hireDateEditorOptions" > <dxi-validation-rule type="required" message="Hire date is required" ></dxi-validation-rule> <dxo-label template="date"></dxo-label> </dxi-item> <dxi-item dataField="BirthDate" editorType="dxDateBox" [editorOptions]="birthDateEditorOptions" > <dxo-label template="date"></dxo-label> </dxi-item> <dxi-item dataField="Address"> <dxo-label template="address"></dxo-label> </dxi-item> <dxi-item dataField="Notes" editorType="dxTextArea" [editorOptions]="notesEditorOptions" [colSpan]="2" > <dxo-label template="notes"></dxo-label> </dxi-item> <dxi-item dataField="Phone" [editorOptions]="phoneEditorOptions"> <dxo-label template="phone"></dxo-label> </dxi-item> <dxi-item dataField="Email"> <dxo-label template="email"></dxo-label> </dxi-item> </dxi-item> <ng-container *ngFor="let label of labelTemplates"> <div *dxTemplate="let data of label.name"> <div><i class="dx-icon {{ label.icon }}"></i>{{ data.text }}</div> </div> </ng-container> <div *dxTemplate="let data of 'notes'"> <div id="template-content"> <i id="helpedInfo" class="dx-icon dx-icon-info"></i> Additional <br /> {{ data.text }} </div> <dx-tooltip target="#helpedInfo" showEvent="mouseenter" hideEvent="mouseleave" > <div *dxTemplate="let data = data; of: 'content'"> <div id="tooltip-content"> This field must not exceed 200 characters </div> </div> </dx-tooltip> </div> </dx-form> </div>
import { NgModule, Component, ViewChild, enableProdMode, AfterViewInit, } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { DxSelectBoxModule, DxTextAreaModule, DxFormModule, DxFormComponent, DxTooltipModule, } from 'devextreme-angular'; import { Employee, Service } from './app.service'; if (!/localhost/.test(document.location.host)) { enableProdMode(); } @Component({ selector: 'demo-app', providers: [Service], templateUrl: 'app/app.component.html', styleUrls: ['app/app.component.css'], }) export class AppComponent implements AfterViewInit { @ViewChild(DxFormComponent, { static: false }) myform: DxFormComponent; employee: Employee; positions: string[]; nameEditorOptions: Object; positionEditorOptions: Object; validationRules: Object; hireDateEditorOptions: Object; birthDateEditorOptions: Object; notesEditorOptions: Object; phoneEditorOptions: Object; labelTemplates: Object; constructor(service: Service) { this.employee = service.getEmployee(); this.nameEditorOptions = { disabled: true }; this.positionEditorOptions = { items: service.getPositions(), searchEnabled: true, value: '' }; this.validationRules = { position: [ { type: 'required', message: 'Position is required.' }, ], hireDate: [ { type: 'required', message: 'Hire Date is required.' }, ], }; this.hireDateEditorOptions = { width: '100%', value: null }; this.birthDateEditorOptions = { width: '100%', disabled: true }; this.notesEditorOptions = { height: 90, maxLength: 200 }; this.phoneEditorOptions = { mask: '+1 (X00) 000-0000', maskRules: { X: /[02-9]/ } }; this.labelTemplates = [ { name: 'name', icon: 'dx-icon-user' }, { name: 'position', icon: 'dx-icon-info' }, { name: 'date', icon: 'dx-icon-event' }, { name: 'address', icon: 'dx-icon-home' }, { name: 'phone', icon: 'dx-icon-tel' }, { name: 'email', icon: 'dx-icon-email' }, ]; } ngAfterViewInit() { this.myform.instance.validate(); } } @NgModule({ imports: [ BrowserModule, DxSelectBoxModule, DxTextAreaModule, DxFormModule, DxTooltipModule, ], declarations: [AppComponent], bootstrap: [AppComponent], }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep #helpedInfo { color: #42a5f5; } ::ng-deep #tooltip-content { font-size: 14px; font-weight: bold; } ::ng-deep #template-content { display: inline-flex; }
import { Injectable } from '@angular/core'; export class Employee { ID: number; FirstName: string; LastName: string; Position: string; BirthDate: string; HireDate: string; Notes: string; Address: string; Phone: string; Email: string; } const employee : 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 : string[] = [ 'HR Manager', 'IT Manager', 'CEO', 'Controller', 'Sales Manager', 'Support Manager', 'Shipping Manager', ]; @Injectable() export class Service { getEmployee() : Employee { return employee; } getPositions() : string[] { return positions; } }
// In real applications, you should not transpile code in the browser. // You can see how to create your own application with Angular and DevExtreme here: // https://js.devexpress.com/Documentation/Guide/Angular_Components/Getting_Started/Create_a_DevExtreme_Application/ window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, }, meta: { 'typescript': { 'exports': 'ts', }, 'devextreme/localization.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', '@angular/core': 'npm:@angular/core@12.2.16', '@angular/platform-browser': 'npm:@angular/platform-browser@12.2.16', '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.16', '@angular/forms': 'npm:@angular/forms@12.2.16', '@angular/common': 'npm:@angular/common@12.2.16', '@angular/compiler': 'npm:@angular/compiler@12.2.16', 'tslib': 'npm:tslib@2.3.1/tslib.js', 'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js', 'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@22.2.3/cjs', 'devextreme/bundles/dx.all': 'npm:devextreme@22.2.3/bundles/dx.all.js', 'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.5.18/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.65', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.37', 'devextreme-angular': 'npm:devextreme-angular@22.2.3', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat@7.4.11/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@7.4.11/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class@7.4.11/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras@7.4.11/dist/inferno-extras.min.js', // Prettier 'prettier/standalone': 'npm:prettier@2.7.1/standalone.js', 'prettier/parser-html': 'npm:prettier@2.7.1/parser-html.js', }, packages: { 'app': { main: './app.component.ts', defaultExtension: 'ts', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, 'rxjs': { defaultExtension: 'js', }, 'rxjs/operators': { defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.11/inferno/package.json', 'npm:@angular/*/package.json', 'npm:@angular/common@12.2.16/*/package.json', 'npm:rxjs@7.5.3/package.json', 'npm:rxjs@7.5.3/operators/package.json', 'npm:devextreme-angular@22.2.3/*/package.json', 'npm:devextreme-angular@22.2.3/ui/*/package.json', 'npm:devextreme-angular@22.2.3/package.json', 'npm:devexpress-diagram@2.1.65/package.json', 'npm:devexpress-gantt@4.1.37/package.json', ], }; System.config(window.config);
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/22.2.3/css/dx.light.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/zone.js@0.12.0/dist/zone.js"></script> <script src="https://unpkg.com/reflect-metadata@0.1.13/Reflect.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script src="config.js"></script> <script> System.import("app").catch(console.error.bind(console)); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <demo-app>Loading...</demo-app> </div> </body> </html>