Vue ValidationGroup API

The ValidationGroup is a widget that allows you to validate several editors simultaneously.

import DxValidationGroup from "devextreme-vue/validation-group"

Type: DxValidationGroupTypes.default

You can use the DevExpress.validationEngine.validateGroup(group) method to validate a particular validation group by passing its instance as a parameter.

JavaScript

DevExpress.validationEngine.validateGroup($("#sampleGroup").dxValidationGroup("instance"));

In addition, you can access a validation group's configuration using the DevExpress.validationEngine.getGroupConfig(group) method. The returned configuration exposes the validators included to the group, the validate() method to validate the editors that are associated with the validators and the validated event that occurs after the group is validated.

NOTE

Nested validation groups are not supported.

Configuration

An object defining configuration options for the ValidationGroup widget.

Name	Description
elementAttr	Specifies the attributes to be attached to the widget's root element.
height	Specifies the widget's height.
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.
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 ValidationGroup instance.
element()	Gets the root widget element.
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 editors that are included to the current validation group.
validate()	Validates rules of the validators that belong to the current validation group.

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.

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.