Overview
The Form component builds a data entry UI for an object assigned to the formData property. The component displays and aligns label-editor pairs for each field in the bound object.
You can use the editors on the right to modify the following properties:
-
labelMode: "outside" | "static" | "floating" | "hidden"
Specifies label display mode. -
labelLocation: "top" | "left" | "right"
Specifies whether to place outer labels above, to the left, or to the right of corresponding editors. The latter location is not demonstrated in this example. -
colCount
Specifies the number of columns in the layout. To build an adaptive layout where the column count depends on the container width, set this property's value to "auto". -
minColWidth
Specifies the minimum column width. Use this property when the colCount property's value is "auto". -
width
Specifies the Form component's width. -
readOnly
Makes the Form editors read-only. -
showColonAfterLabel
Specifies whether the Form displays a colon after a label.
To get started with the DevExtreme Form component, refer to the following tutorial for step-by-step instructions: Getting Started with Form.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<div id="form-demo">
<div class="widget-container">
<div *ngIf="labelMode === 'outside'">Select company:</div>
<dx-select-box
#company
displayExpr="Name"
[(dataSource)]="companies"
label="Select company"
[labelMode]="getCompanySelectorLabelMode()"
[value]="companies[0]"
></dx-select-box>
<dx-form
id="form"
[(formData)]="company.value"
[readOnly]="readOnly"
[labelMode]="labelMode"
[showColonAfterLabel]="showColon"
[labelLocation]="labelLocation"
[minColWidth]="minColWidth"
[colCount]="colCount"
[width]="width"
></dx-form>
</div>
<div class="options">
<div class="caption">Options</div>
<div class="option">
<span>Label mode:</span>
<dx-select-box
[items]="['outside', 'static', 'floating', 'hidden']"
[(value)]="labelMode"
></dx-select-box>
</div>
<div class="option">
<span>Label location:</span>
<dx-select-box
[items]="['left', 'top']"
[(value)]="labelLocation"
></dx-select-box>
</div>
<div class="option">
<span>Columns count:</span>
<dx-select-box
[items]="['auto', 1, 2, 3]"
[(value)]="colCount"
></dx-select-box>
</div>
<div class="option">
<span>Min column width:</span>
<dx-select-box
[items]="[150, 200, 300]"
[(value)]="minColWidth"
></dx-select-box>
</div>
<div class="option">
<span>Form width:</span>
<dx-number-box [max]="550" [(value)]="width"></dx-number-box>
</div>
<div class="option">
<dx-check-box text="readOnly" [(value)]="readOnly"></dx-check-box>
</div>
<div class="option">
<dx-check-box
text="showColonAfterLabel"
[(value)]="showColon"
></dx-check-box>
</div>
</div>
</div>
import { NgModule, Component, enableProdMode } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import {
DxCheckBoxModule,
DxSelectBoxModule,
DxNumberBoxModule,
DxFormModule,
} from 'devextreme-angular';
import { Company, 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 {
companies: Company[];
labelMode: string;
labelLocation: string;
readOnly: boolean;
showColon: boolean;
minColWidth: number;
colCount: number;
width: any;
constructor(service: Service) {
this.labelMode = 'floating';
this.labelLocation = 'left';
this.readOnly = false;
this.showColon = true;
this.minColWidth = 300;
this.colCount = 2;
this.companies = service.getCompanies();
}
getCompanySelectorLabelMode() {
return this.labelMode === 'outside'
? 'hidden'
: this.labelMode;
}
}
@NgModule({
imports: [
BrowserModule,
DxCheckBoxModule,
DxSelectBoxModule,
DxNumberBoxModule,
DxFormModule,
],
declarations: [AppComponent],
bootstrap: [AppComponent],
})
export class AppModule { }
platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep .widget-container {
margin-right: 320px;
padding: 20px;
max-width: 550px;
min-width: 300px;
}
::ng-deep #form {
margin-top: 25px;
}
::ng-deep .options {
padding: 20px;
position: absolute;
bottom: 0;
right: 0;
width: 260px;
top: 0;
background-color: rgba(191, 191, 191, 0.15);
}
::ng-deep .caption {
font-size: 18px;
font-weight: 500;
}
::ng-deep.option {
margin-top: 10px;
}
import { Injectable } from '@angular/core';
export class Company {
ID: number;
Name: string;
Address: string;
City: string;
State: string;
ZipCode: number;
Phone: string;
Fax: string;
Website: string;
Active: boolean;
}
const companies: Company[] = [{
ID: 1,
Name: 'Super Mart of the West',
Address: '702 SW 8th Street',
City: 'Bentonville',
State: 'Arkansas',
ZipCode: 72716,
Phone: '(800) 555-2797',
Fax: '(800) 555-2171',
Website: '',
Active: true,
}, {
ID: 2,
Name: 'Electronics Depot',
Address: '2455 Paces Ferry Road NW',
City: 'Atlanta',
State: 'Georgia',
ZipCode: 30339,
Phone: '(800) 595-3232',
Fax: '(800) 595-3231',
Website: '',
Active: true,
}, {
ID: 3,
Name: 'K&S Music',
Address: '1000 Nicllet Mall',
City: 'Minneapolis',
State: 'Minnesota',
ZipCode: 55403,
Phone: '(612) 304-6073',
Fax: '(612) 304-6074',
Website: '',
Active: true,
}, {
ID: 4,
Name: "Tom's Club",
Address: '999 Lake Drive',
City: 'Issaquah',
State: 'Washington',
ZipCode: 98027,
Phone: '(800) 955-2292',
Fax: '(800) 955-2293',
Website: '',
Active: true,
}];
@Injectable()
export class Service {
getCompanies() : Company[] {
return companies;
}
}
// 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.17',
'@angular/platform-browser': 'npm:@angular/platform-browser@12.2.17',
'@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.17',
'@angular/forms': 'npm:@angular/forms@12.2.17',
'@angular/common': 'npm:@angular/common@12.2.17',
'@angular/compiler': 'npm:@angular/compiler@12.2.17',
'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.5/cjs',
'devextreme/bundles/dx.all': 'npm:devextreme@22.2.5/bundles/dx.all.js',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.5.20/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.1.72',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.42',
'devextreme-angular': 'npm:devextreme-angular@22.2.5',
'@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11',
'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',
// Prettier
'prettier/standalone': 'npm:prettier@2.8.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/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.17/*/package.json',
'npm:rxjs@7.5.3/package.json',
'npm:rxjs@7.5.3/operators/package.json',
'npm:devextreme-angular@22.2.5/*/package.json',
'npm:devextreme-angular@22.2.5/ui/*/package.json',
'npm:devextreme-angular@22.2.5/package.json',
'npm:devexpress-diagram@2.1.72/package.json',
'npm:devexpress-gantt@4.1.42/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.5/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>