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.
<template>
<div id="form-demo">
<div class="widget-container">
<div v-if="labelMode === 'outside'">Select company:</div>
<DxSelectBox
:data-source="companies"
:label-mode="companySelectorLabelMode"
:input-attr="{ 'aria-label': 'Company' }"
label="Select company"
v-model:value="company"
display-expr="Name"
/>
<DxForm
id="form"
:form-data="company"
:label-mode="labelMode"
:read-only="readOnly"
:show-colon-after-label="showColon"
:label-location="labelLocation"
:min-col-width="minColWidth"
:col-count="colCount"
:width="width"
/>
</div>
<div class="options">
<div class="caption">Options</div>
<div class="option">
<span>Label mode:</span>
<DxSelectBox
:items="labelModes"
:input-attr="{ 'aria-label': 'Label Mode' }"
v-model:value="labelMode"
/>
</div>
<div class="option">
<span>Label location:</span>
<DxSelectBox
:items="labelLocations"
:input-attr="{ 'aria-label': 'Label Location' }"
v-model:value="labelLocation"
/>
</div>
<div class="option">
<span>Columns count:</span>
<DxSelectBox
:items="columnsCounts"
:input-attr="{ 'aria-label': 'Column Count' }"
v-model:value="colCount"
/>
</div>
<div class="option">
<span>Min column width:</span>
<DxSelectBox
:items="minColumnWidths"
:input-attr="{ 'aria-label': 'Min Column Width' }"
v-model:value="minColWidth"
/>
</div>
<div class="option">
<span>Form width:</span>
<DxNumberBox
:max="550"
v-model:value="width"
:input-attr="{ 'aria-label': 'Form Width' }"
/>
</div>
<div class="option">
<DxCheckBox
v-model:value="readOnly"
text="readOnly"
/>
</div>
<div class="option">
<DxCheckBox
v-model:value="showColon"
text="showColonAfterLabel"
/>
</div>
</div>
</div>
</template>
<script>
import DxCheckBox from 'devextreme-vue/check-box';
import DxSelectBox from 'devextreme-vue/select-box';
import DxNumberBox from 'devextreme-vue/number-box';
import DxForm from 'devextreme-vue/form';
import service from './data.js';
const labelModes = ['outside', 'static', 'floating', 'hidden'];
const labelLocations = ['left', 'top'];
const columnsCounts = ['auto', 1, 2, 3];
const minColumnWidths = [150, 200, 300];
const companies = service.getCompanies();
export default {
components: {
DxCheckBox,
DxSelectBox,
DxNumberBox,
DxForm,
},
data() {
return {
labelMode: 'floating',
labelLocation: 'left',
readOnly: false,
showColon: true,
minColWidth: 300,
colCount: 2,
companies,
company: companies[0],
width: null,
labelModes,
labelLocations,
columnsCounts,
minColumnWidths,
};
},
computed: {
companySelectorLabelMode() {
if (this.labelMode === 'outside') {
return 'hidden';
}
return this.labelMode;
},
},
};
</script>
<style scoped>
.widget-container {
margin-right: 320px;
padding: 20px;
max-width: 550px;
min-width: 300px;
}
#form {
margin-top: 25px;
}
.options {
padding: 20px;
position: absolute;
bottom: 0;
right: 0;
width: 260px;
top: 0;
background-color: rgba(191, 191, 191, 0.15);
}
.caption {
font-size: 18px;
font-weight: 500;
}
.option {
margin-top: 10px;
}
</style>
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
<!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=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/23.1.5/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/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.js");
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"> </div>
</div>
</body>
</html>
const companies = [{
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,
}];
export default {
getCompanies() {
return companies;
},
};
window.config = {
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader',
},
'*.ts': {
loader: 'demo-ts-loader',
},
'*.svg': {
loader: 'svg-loader',
},
'devextreme/localization.js': {
'esModule': true,
},
},
paths: {
'root:': '../../../../../',
'npm:': 'https://unpkg.com/',
},
map: {
'vue': 'npm:vue@3.3.4/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@23.1.5/cjs',
'devextreme-vue': 'npm:devextreme-vue@23.1.5',
'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js',
'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js',
'devexpress-diagram': 'npm:devexpress-diagram@2.2.1/dist/dx-diagram.js',
'devexpress-gantt': 'npm:devexpress-gantt@4.1.48/dist/dx-gantt.js',
'@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',
'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.4/standalone.js',
'prettier/parser-html': 'npm:prettier@2.8.4/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.11/inferno/package.json',
],
babelOptions: {
sourceMaps: false,
stage0: true,
},
};
System.config(window.config);