Vue Validator API

A widget that is used to validate the associated DevExtreme editors against the defined validation rules.

import DxValidator from "devextreme-vue/validator"

Type: DxValidatorTypes.default

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Validator widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function() {
    $("#textBox1").dxTextBox({ })
        .dxValidator({
            validationRules: [
                // ...
            ]
        });
});

<div id="textBox1"></div>

Angular

HTML

TypeScript

<dx-text-box>
    <dx-validator>
        <dxi-validation-rule type="required" message="Value is required"></dxi-validation-rule>
    </dx-validator>
</dx-text-box>

import { DxValidatorModule, DxTextBoxModule } from "devextreme-angular"
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxValidatorModule,
        DxTextBoxModule
    ],
    // ...
})

AngularJS

HTML

<div dx-text-box="{ }"
        dx-validator="{
            validationRules: [
            // ...
        ]
    }">
</div>

Knockout

HTML

<div data-bind="dxTextBox: { },
    dxValidator: {
        validationRules: [
            // ...
        ]
    }">  
</div>

Props

An object defining configuration options for the Validator widget.

Name	Description
adapter	An object that specifies what and when to validate, and how to apply the validation result.
elementAttr	Specifies the attributes to be attached to the widget's root element.
height	Specifies the widget's height.
name	Specifies the editor name to be used in the validation default messages.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onOptionChanged	A function that is executed after a widget option is changed.
onValidated	A function that is executed after a value is validated.
validationGroup	Specifies the validation group the editor will be related to.
validationRules	An array of validation rules to be checked for the editor with which the dxValidator object is associated.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
dispose()	Disposes of all the resources allocated to the Validator instance.
element()	Gets the root widget element.
focus()	Sets focus to the editor associated with the current Validator object.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
reset()	Resets the value and validation result of the editor associated with the current Validator object.
validate()	Validates the value of the editor that is controlled by the current Validator object against the list of the specified validation rules.

Events

This section describes events fired by this widget.

Name	Description
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
validated	Raised after a value is validated.