Vue Validator API

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

import DxValidator from "devextreme-vue/validator"
Selector: DxValidator

Configuration

An object defining configuration properties for the Validator UI component.

Name Description
adapter

An object that specifies what and when to validate, and how to apply the validation result.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

height

Specifies the UI component's height.

name

Specifies the editor name to be used in the validation default messages.

onDisposing

A function that is executed before the UI component is disposed of.

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

onOptionChanged

A function that is executed after a UI component property 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 UI component's width.

Methods

This section describes members used to manipulate the UI component.

Name Description
dispose()

Disposes of all the resources allocated to the Validator instance.

element()

Gets the root UI component element.

focus()

Sets focus to the editor associated with the current Validator object.

getInstance(element)

Gets the instance of a UI component found using its DOM node.

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

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 UI component properties.

option(optionName)

Gets the value of a single property.

option(optionName, optionValue)

Updates the value of a single property.

option(options)

Updates the values of several properties.

reset()

Resets the value and validation result of the editor associated with the current Validator object.

resetOption(optionName)

Resets a property to its default value.

validate()

Validates the value of the editor that is controlled by the current Validator object against the list of the specified validation rules.

See Also

Events

This section describes events fired by this UI component.

Name Description
disposing

Raised before the UI component is disposed of.

initialized

Raised only once, after the UI component is initialized.

optionChanged

Raised after a UI component property is changed.

validated

Raised after a value is validated.

See Also

Validation Rules

This section lists validation rules that can be used within the dxValidator.

Validation Result

A validation result.

import { DxValidatorTypes } from "devextreme-vue/validator"
Type: DxValidatorTypes.dxValidatorResult