Your search did not match any results.
Form

Validation

This demo shows how to validate Form editors. To apply validation rules to an editor, declare them in the validationRules[] array. Specify type and other properties for each rule.

The following validation rules are shown in this demo:

  • RequiredRule
    Requires that a validated editor has a value.

  • CompareRule
    Compares the editor's value to the specified expression.

  • PatternRule
    Checks whether an editor value matches a specified pattern.

  • RangeRule
    Checks whether an editor value is in a specified range.

  • StringLengthRule
    Requires that an editor value length is in a specified range.

  • EmailRule
    Requires that an editor value matches the Email pattern.

  • AsyncRule
    Allows you to add custom server-side validation logic. Rules of this type run last, only if all other rules passed. In this demo, an AsyncRule checks whether user input matches test@dx-email.com.

To submit form data, do the following:

  1. Wrap the Form component in the HTML <form> element.

  2. Use the Button Form Item to add a button to the form. This button submits the form data.

  3. Enable the button's useSubmitBehavior property.

When users click the button, the Form validates all editors that belong to the same validationGroup as this button. In this demo, all these editors belong to the customerData group. Form data can be submitted to a server only if input validation is successful. Enable the showValidationSummary property to display all validation errors at the bottom of the Form.

Copy to CodeSandBox
Apply
Reset
<template> <div id="form-demo"> <div class="widget-container"> <form action="your-action" @submit="handleSubmit" > <DxForm v-model:form-data="customer" :read-only="false" :show-colon-after-label="true" :show-validation-summary="true" validation-group="customerData" > <DxGroupItem caption="Credentials"> <DxSimpleItem data-field="Email"> <DxRequiredRule message="Email is required"/> <DxEmailRule message="Email is invalid"/> <DxAsyncRule :validation-callback="asyncValidation" message="Email is already registered" /> </DxSimpleItem> <DxSimpleItem :editor-options="passwordOptions" data-field="Password" > <DxRequiredRule message="Password is required"/> </DxSimpleItem> <DxSimpleItem :editor-options="passwordOptions" editor-type="dxTextBox" > <DxLabel text="Confirm Password"/> <DxRequiredRule message="Confirm Password is required"/> <DxCompareRule :comparison-target="passwordComparison" message="Password and Confirm Password do not match" /> </DxSimpleItem> </DxGroupItem> <DxGroupItem caption="Personal Data"> <DxSimpleItem data-field="Name"> <DxRequiredRule message="Name is required"/> <DxPatternRule :pattern="namePattern" message="Do not use digits in the Name" /> </DxSimpleItem> <DxSimpleItem :editor-options="dateBoxOptions" data-field="Date" editor-type="dxDateBox" > <DxLabel text="Date of birth"/> <DxRequiredRule message="Date of birth is required"/> <DxRangeRule :max="maxDate" message="You must be at least 21 years old" /> </DxSimpleItem> </DxGroupItem> <DxGroupItem caption="Billing address"> <DxSimpleItem :editor-options="countryEditorOptions" data-field="Country" editor-type="dxSelectBox" > <DxRequiredRule message="Country is required"/> </DxSimpleItem> <DxSimpleItem :editor-options="cityEditorOptions" data-field="City" editor-type="dxAutocomplete" > <DxPatternRule :pattern="cityPattern" message="Do not use digits in the City name" /> <DxStringLengthRule :min="2" message="City must have at least 2 symbols" /> <DxRequiredRule message="City is required"/> </DxSimpleItem> <DxSimpleItem data-field="Address"> <DxRequiredRule message="Address is required"/> </DxSimpleItem> <DxSimpleItem :editor-options="phoneEditorOptions" data-field="Phone" help-text="Enter the phone number in USA phone format" > <DxPatternRule :pattern="phonePattern" message="The phone must have a correct USA phone format" /> </DxSimpleItem> <DxSimpleItem :editor-options="checkBoxOptions" data-field="Accepted" editor-type="dxCheckBox" > <DxLabel :visible="false"/> <DxCompareRule :comparison-target="checkComparison" type="compare" message="You must agree to the Terms and Conditions" /> </DxSimpleItem> </DxGroupItem> <DxButtonItem :button-options="buttonOptions" horizontal-alignment="left" /> </DxForm> </form> </div> </div> </template> <script> import DxForm, { DxGroupItem, DxSimpleItem, DxButtonItem, DxLabel, DxRequiredRule, DxCompareRule, DxRangeRule, DxStringLengthRule, DxPatternRule, DxEmailRule, DxAsyncRule } from 'devextreme-vue/form'; import DxAutocomplete from 'devextreme-vue/autocomplete'; import notify from 'devextreme/ui/notify'; import service from './data.js'; const sendRequest = function(value) { const validEmail = 'test@dx-email.com'; return new Promise((resolve) => { setTimeout(function() { resolve(value === validEmail); }, 1000); }); }; export default { components: { DxGroupItem, DxSimpleItem, DxButtonItem, DxLabel, DxRequiredRule, DxCompareRule, DxPatternRule, DxRangeRule, DxEmailRule, DxStringLengthRule, DxForm, DxAutocomplete, DxAsyncRule, notify }, data() { return { customer: service.getCustomer(), buttonOptions: { text: 'Register', type: 'success', useSubmitBehavior: true }, passwordOptions: { mode: 'password' }, dateBoxOptions: { invalidDateMessage: 'The date must have the following format: MM/dd/yyyy' }, checkBoxOptions: { text: 'I agree to the Terms and Conditions', value: false }, phoneEditorOptions: { mask: '+1 (X00) 000-0000', maskRules: { X: /[02-9]/ }, useMaskedValue: true, maskInvalidMessage: 'The phone must have a correct USA phone format' }, cityEditorOptions:{ dataSource: service.getCities(), minSearchLength: 2 }, countryEditorOptions: { dataSource: service.getCountries() }, maxDate: new Date().setFullYear(new Date().getFullYear() - 21), namePattern: /^[^0-9]+$/, cityPattern: /^[^0-9]+$/, phonePattern: /^\+\s*1\s*\(\s*[02-9]\d{2}\)\s*\d{3}\s*-\s*\d{4}$/ }; }, methods: { passwordComparison() { return this.customer.Password; }, checkComparison() { return true; }, asyncValidation(params) { return sendRequest(params.value); }, handleSubmit(e) { notify({ message: 'You have submitted the form', position: { my: 'center top', at: 'center top' } }, 'success', 3000); e.preventDefault(); } } }; </script> <style scoped> form { margin: 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/20.2.7/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.2.7/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.4.1/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 customer = { 'Email': '', 'Password': '', 'Name': 'Peter', 'Date': null, 'Country': '', 'City': '', 'Address': '', 'Phone': '', 'Accepted': false }; const countries = [ 'Afghanistan', 'Albania', 'Algeria', 'Andorra', 'Angola', 'Antigua and Barbuda', 'Argentina', 'Armenia', 'Australia', 'Austria', 'Azerbaijan', 'The Bahamas', 'Bahrain', 'Bangladesh', 'Barbados', 'Belarus', 'Belgium', 'Belize', 'Benin', 'Bhutan', 'Bolivia', 'Bosnia and Herzegovina', 'Botswana', 'Brazil', 'Brunei', 'Bulgaria', 'Burkina Faso', 'Burma', 'Burundi', 'Cambodia', 'Cameroon', 'Canada', 'Cape Verde', 'Central African Republic', 'Chad', 'Chile', 'China', 'Colombia', 'Comoros', 'Democratic Republic of the Congo', 'Republic of the Congo', 'Costa Rica', 'Ivory Coast', 'Croatia', 'Cuba', 'Cyprus', 'Czech Republic', 'Denmark', 'Djibouti', 'Dominica', 'Dominican Republic', 'East Timor', 'Ecuador', 'Egypt', 'El Salvador', 'Equatorial Guinea', 'Eritrea', 'Estonia', 'Ethiopia', 'Fiji', 'Finland', 'France', 'Gabon', 'The Gambia', 'Georgia', 'Germany', 'Ghana', 'Greece', 'Grenada', 'Guatemala', 'Guinea', 'Guinea-Bissau', 'Guyana', 'Haiti', 'Honduras', 'Hungary', 'Iceland', 'India', 'Indonesia', 'Iran', 'Iraq', 'Republic of Ireland', 'Israel', 'Italy', 'Jamaica', 'Japan', 'Jordan', 'Kazakhstan', 'Kenya', 'Kiribati', 'North Korea', 'South Korea', 'Kuwait', 'Kyrgyzstan', 'Laos', 'Latvia', 'Lebanon', 'Lesotho', 'Liberia', 'Libya', 'Liechtenstein', 'Lithuania', 'Luxembourg', 'Republic of Macedonia', 'Madagascar', 'Malawi', 'Malaysia', 'Maldives', 'Mali', 'Malta', 'Marshall Islands', 'Mauritania', 'Mauritius', 'Mexico', 'Federated States of Micronesia', 'Moldova', 'Monaco', 'Mongolia', 'Montenegro', 'Morocco', 'Mozambique', 'Namibia', 'Nauru', 'Nepal', 'Kingdom of the Netherlands', 'New Zealand', 'Nicaragua', 'Niger', 'Nigeria', 'Norway', 'Oman', 'Pakistan', 'Palau', 'State of Palestine', 'Panama', 'Papua New Guinea', 'Paraguay', 'Peru', 'Philippines', 'Poland', 'Portugal', 'Qatar', 'Romania', 'Russia', 'Rwanda', 'Saint Kitts and Nevis', 'Saint Lucia', 'Saint Vincent and the Grenadines', 'Samoa', 'San Marino', 'São Tomé and Príncipe', 'Saudi Arabia', 'Senegal', 'Serbia', 'Seychelles', 'Sierra Leone', 'Singapore', 'Slovakia', 'Slovenia', 'Solomon Islands', 'Somalia', 'South Africa', 'South Sudan', 'Spain', 'Sri Lanka', 'Sudan', 'Suriname', 'Swaziland', 'Sweden', 'Switzerland', 'Syria', 'Tajikistan', 'Tanzania', 'Thailand', 'Togo', 'Tonga', 'Trinidad and Tobago', 'Tunisia', 'Turkey', 'Turkmenistan', 'Tuvalu', 'Uganda', 'Ukraine', 'United Arab Emirates', 'United Kingdom', 'United States', 'Uruguay', 'Uzbekistan', 'Vanuatu', 'Vatican City', 'Venezuela', 'Vietnam', 'Yemen', 'Zambia', 'Zimbabwe']; const cities = [ 'New York', 'Los Angeles', 'Chicago', 'Houston', 'Philadelphia', 'Phoenix', 'San Antonio', 'San Diego', 'Dallas', 'San Jose', 'Austin', 'Indianapolis', 'Jacksonville', 'San Francisco', 'Columbus', 'Charlotte', 'Fort Worth', 'Detroit', 'El Paso', 'Memphis', 'Seattle', 'Denver', 'Washington', 'Boston', 'Nashville', 'Baltimore', 'Oklahoma City', 'Louisville', 'Portland', 'Las Vegas', 'Milwaukee', 'Albuquerque', 'Tucson', 'Fresno', 'Sacramento', 'Long Beach', 'Kansas City', 'Mesa', 'Virginia Beach', 'Atlanta', 'Colorado Springs', 'Omaha', 'Raleigh', 'Miami', 'Oakland', 'Minneapolis', 'Tulsa', 'Cleveland', 'Wichita', 'Arlington', 'New Orleans', 'Bakersfield', 'Tampa', 'Honolulu', 'Aurora', 'Anaheim', 'Santa Ana', 'St. Louis', 'Riverside', 'Corpus Christi', 'Lexington', 'Pittsburgh', 'Anchorage', 'Stockton', 'Cincinnati', 'Saint Paul', 'Toledo', 'Greensboro', 'Newark', 'Plano', 'Henderson', 'Lincoln', 'Buffalo', 'Jersey City', 'Chula Vista', 'Fort Wayne', 'Orlando', 'St. Petersburg', 'Chandler', 'Laredo', 'Norfolk', 'Durham', 'Madison', 'Lubbock', 'Irvine', 'Winston–Salem', 'Glendale', 'Garland', 'Hialeah', 'Reno', 'Chesapeake', 'Gilbert', 'Baton Rouge', 'Irving', 'Scottsdale', 'North Las Vegas', 'Fremont', 'Boise', 'Richmond']; export default { getCustomer() { return customer; }, getCountries() { return countries; }, getCities() { return cities; } };
System.config({ transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader' }, 'devextreme/localization.js': { "esModule": true }, }, paths: { 'npm:': 'https://unpkg.com/' }, map: { 'vue': 'npm:vue@3.0.0/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.0.15/index.js', 'mitt': 'npm:mitt/dist/mitt.umd.js', 'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.26.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@20.2.7', 'devextreme-vue': 'npm:devextreme-vue@20.2.7', 'jszip': 'npm:jszip@3.6.0/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@0.10.3/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.0.23/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@2.0.29/dist/dx-gantt.js', 'preact': 'npm:preact@10.5.13/dist/preact.js', 'preact/hooks': 'npm:preact@10.5.13/hooks/dist/hooks.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' }, 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' } }, babelOptions: { sourceMaps: false, stage0: true } });