Class: Validator

Returns

any

string()

string: (param, element) => boolean

Parameters

param

any

element

Returns

boolean

lastActive

lastActive: ValidatableElement

Defined in: src/base/validator.tsx:642

Last element that received focus, used by Validator.focusInvalid.

settings

readonly settings: ValidatorOptions

Defined in: src/base/validator.tsx:640

Effective settings for this validator instance (merged defaults + constructor options).

autoCreateRanges

static autoCreateRanges: boolean = false

Defined in: src/base/validator.tsx:349

When true automatically combines min+max into range and minlength+maxlength into rangelength during rule normalization.

classRuleSettings

static classRuleSettings: Record<string, ValidationRules>

Defined in: src/base/validator.tsx:1795

CSS-class to rule mapping (e.g. "required" → { required: true }).

defaults

static defaults: ValidatorOptions

Defined in: src/base/validator.tsx:352

Default options applied to every new validator instance.

excludedModifierKeys

readonly static excludedModifierKeys: Set<string>

Defined in: src/base/validator.tsx:2121

Modifier / navigation keys that should not trigger onkeyup re-validation.

messages

readonly static messages: Record<string, string | Function>

Defined in: src/base/validator.tsx:445

Default messages keyed by validation method name. Values may be translation keys or functions.

methods

readonly static methods: Record<string, ValidationProvider>

Defined in: src/base/validator.tsx:469

Built-in validation methods keyed by rule name. Extend via Validator.addMethod.

Methods

abortRequest()

abortRequest(element): void

Defined in: src/base/validator.tsx:1752

Aborts a pending async request for an element, if any.

Parameters

element

Element whose pending request should be aborted.

Returns

void

check()

check(element): boolean

Defined in: src/base/validator.tsx:1335

Runs all applicable validation rules for an element.

Parameters

element

Element to check.

Returns

boolean

true if valid, false if invalid, or undefined for dependency mismatch.

checkForm()

checkForm(): boolean

Defined in: src/base/validator.tsx:1047

Validates all elements in the form without updating the display.

Returns

boolean

true if all elements are valid.

customDataMessage()

customDataMessage(element, method): string

Defined in: src/base/validator.tsx:1422

Gets a custom message from HTML5 data-msg* attributes for an element/method.

Parameters

element

Source element.

method

string

Validation method name.

Returns

string

The data message, if present.

customMessage()

customMessage(name, method): any

Defined in: src/base/validator.tsx:1433

Gets a custom message from settings.messages for a field/method.

Parameters

name

string

Field name.

method

string

Validation method name.

Returns

any

The configured message, if present.

defaultMessage()

defaultMessage(element, rule): any

Defined in: src/base/validator.tsx:1459

Resolves the default error message for a rule, checking custom messages, data attributes, and Validator.messages.

Parameters

element

Target element.

rule

Rule descriptor with method and parameters.

method

string

parameters?

any

Returns

any

The resolved message string.

defaultShowErrors()

defaultShowErrors(): void

Defined in: src/base/validator.tsx:1500

Default error display: highlights invalid elements, shows labels, and hides stale errors.

Returns

void

depend()

depend(param, element): any

Defined in: src/base/validator.tsx:1703

Evaluates whether a dependency condition is met.

Parameters

param

any

Boolean, selector string, or function.

element

Context element.

Returns

any

true if the dependency is satisfied.

destroy()

destroy(): void

Defined in: src/base/validator.tsx:1787

Cleans up event handlers and removes the validator instance from the form.

Returns

void

element()

element(element): boolean

Defined in: src/base/validator.tsx:1060

Validates a single element and updates error display.

Parameters

element

Element to validate.

Returns

boolean

true if the element is valid.

elements()

elements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1241

Gets all validatable elements in the form that have rules and are not ignored.

Returns

Array of elements to validate.

errors()

errors(): HTMLElement[]

Defined in: src/base/validator.tsx:1290

Gets existing error label elements in the form.

Returns

HTMLElement[]

Array of error label elements.

errorsFor()

errorsFor(element): HTMLElement[]

Defined in: src/base/validator.tsx:1633

Gets error labels associated with an element via for attribute or aria-describedby.

Parameters

element

Target element.

Returns

HTMLElement[]

Matching error label elements.

findByName()

findByName(name): ValidatableElement[]

Defined in: src/base/validator.tsx:1680

Finds all elements in the form with the given name.

Parameters

name

string

Field name to search for.

Returns

Matching elements.

findDefined()

findDefined(...args): any

Defined in: src/base/validator.tsx:1444

Returns the first defined argument, allowing empty strings.

Parameters

args

...any[]

Values to test in order.

Returns

any

The first non-undefined value.

findLastActive()

findLastActive(): ValidatableElement

Defined in: src/base/validator.tsx:1232

Finds the last active element among current errors, if it is still invalid.

Returns

The last active invalid element, or falsy if none.

focusInvalid()

focusInvalid(): void

Defined in: src/base/validator.tsx:1210

Focuses the last active invalid element or the first invalid element. Honors abortHandler and focusInvalid settings.

Returns

void

form()

form(): boolean

Defined in: src/base/validator.tsx:1032

Validates the entire form, updates error state, and shows errors.

Returns

boolean

true if the form is valid.

formatAndAdd()

formatAndAdd(element, rule): void

Defined in: src/base/validator.tsx:1486

Formats the error message for a failed rule and records it in the error map/list.

Parameters

element

Element that failed.

rule

Rule that failed.

method

string

parameters

any

Returns

void

hideErrors()

hideErrors(): void

Defined in: src/base/validator.tsx:1175

Hides currently tracked error labels.

Returns

void

hideThese()

hideThese(errors): void

Defined in: src/base/validator.tsx:1183

Hides a set of error labels.

Parameters

errors

HTMLElement[]

Error label elements to hide.

Returns

void

idOrName()

idOrName(element): string

Defined in: src/base/validator.tsx:1654

Gets the identifier used for error label association (name for radio/checkbox, otherwise id or name).

Parameters

element

Target element.

Returns

string

The identifier string.

invalidElements()

invalidElements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1542

Gets elements that are currently invalid.

Returns

Invalid elements.

numberOfInvalids()

numberOfInvalids(): number

Defined in: src/base/validator.tsx:1156

Gets the count of currently invalid fields.

Returns

number

Number of invalid entries.

prepareElement()

prepareElement(element): void

Defined in: src/base/validator.tsx:1325

Prepares state for validating a single element.

Parameters

element

Element to prepare for.

Returns

void

prepareForm()

prepareForm(): void

Defined in: src/base/validator.tsx:1316

Prepares state for a full form validation pass.

Returns

void

previousValue()

previousValue(element, method): any

Defined in: src/base/validator.tsx:1773

Gets or creates the cached previous value for a remote validation method.

Parameters

element

Target element.

method

string

Validation method name (defaults to "remote").

Returns

any

The cached previous value object.

reset()

reset(): void

Defined in: src/base/validator.tsx:1305

Resets internal state and clears the current element list.

Returns

void

resetAll()

resetAll(): void

Defined in: src/base/validator.tsx:1311

Resets all validation state including displayed errors.

Returns

void

resetElements()

resetElements(elements): void

Defined in: src/base/validator.tsx:1136

Resets visual validation state for a set of elements.

Parameters

elements

Elements to reset.

Returns

void

resetForm()

resetForm(): void

Defined in: src/base/validator.tsx:1118

Resets form validation state, hides errors, and clears aria-invalid attributes.

Returns

void

resetInternals()

resetInternals(): void

Defined in: src/base/validator.tsx:1296

Resets internal error tracking without touching the DOM.

Returns

void

showErrors()

showErrors(errors?): void

Defined in: src/base/validator.tsx:1094

Displays validation errors, merging optional additional errors into the current state.

Parameters

errors?

ValidationErrorMap

Optional additional error map to merge before display.

Returns

void

showLabel()

showLabel(element, message?): void

Defined in: src/base/validator.tsx:1551

Creates or updates the error label for an element.

Parameters

element

Target element.

message?

string

Error message; when omitted shows the success state if configured.

Returns

void

size()

size(): number

Defined in: src/base/validator.tsx:1202

Gets the number of current validation errors.

Returns

number

Error count.

startRequest()

startRequest(element): void

Defined in: src/base/validator.tsx:1711

Marks an async validation request as pending for an element.

Parameters

element

Element with a pending remote check.

Returns

void

stopRequest()

stopRequest(element, valid): void

Defined in: src/base/validator.tsx:1724

Clears a pending async request and triggers form submit / invalid-form handling as needed.

Parameters

element

Element whose request completed.

valid

boolean

Whether the async result was valid.

Returns

void

valid()

valid(): boolean

Defined in: src/base/validator.tsx:1194

Whether there are currently no validation errors.

Returns

boolean

true if valid.

validationTargetFor()

validationTargetFor(element): ValidatableElement

Defined in: src/base/validator.tsx:1663

Resolves the actual element to validate (first member of a radio/checkbox group, filtered by ignore).

Parameters

element

Source element.

Returns

The validation target, or undefined if filtered out.

validElements()

validElements(): ValidatableElement[]

Defined in: src/base/validator.tsx:1533

Gets elements among Validator.currentElements that are currently valid.

Returns

Valid elements.

addClassRules()

static addClassRules(className, rules): void

Defined in: src/base/validator.tsx:1812

Adds validation rules associated with a CSS class.

Parameters

className

any

Class name or map of class names to rules.

rules

Rules to associate when className is a string.

Returns

void

addCustomRule()

static addCustomRule(element, rule, uniqueName?): void

Defined in: src/base/validator.tsx:2079

Adds a custom validation callback for an element. Multiple callbacks can be registered under distinct uniqueName keys.

Parameters

element

Target element or array-like collection (first element is used).

HTMLElement | ArrayLike<HTMLElement>

rule

(input) => string

Callback returning an error message string when invalid, or null/undefined when valid.

uniqueName?

string

Optional key to allow independent removal; defaults to "".

Returns

void

addMethod()

static addMethod(name, method, message?): void

Defined in: src/base/validator.tsx:2049

Registers a new validation method.

Parameters

name

string

Method / rule name.

method

ValidationProvider

Validation function.

message?

string

Optional default error message for the method.

Returns

void

attributeRules()

static attributeRules(element): ValidationRules

Defined in: src/base/validator.tsx:1888

Gets rules derived from HTML attributes (e.g. required, minlength, type).

Parameters

element

Target element.

Returns

Attribute-derived rules.

classRules()

static classRules(element): ValidationRules

Defined in: src/base/validator.tsx:1825

Gets rules derived from the element's CSS classes.

Parameters

element

Target element.

Returns

Rules inferred from classes.

compareBound()

static compareBound(value, param): number

Defined in: src/base/validator.tsx:329

Compares a form value against a min/max/range bound. When the bound is a bigint (used for 64-bit integer bounds beyond the safe integer range), the value is compared exactly as a bigint instead of losing precision through Number coercion.

Parameters

value

any

The value to compare.

param

any

The bound (number, string or bigint).

Returns

number

Negative if value < bound, positive if value > bound, 0 if equal, or NaN when not comparable.

dataRules()

static dataRules(element): any

Defined in: src/base/validator.tsx:1930

Gets rules derived from data-rule-* attributes.

Parameters

element

Target element.

Returns

any

Data-attribute rules.

elementValue()

static elementValue(element): any

Defined in: src/base/validator.tsx:858

Extracts the current value from a form element, normalizing special cases (radio / checkbox groups, number inputs, file inputs, contenteditable).

Parameters

element

HTMLElement

Source element.

Returns

any

The extracted value (string, number, string[], or null).

getHighlightTarget()

static getHighlightTarget(el): HTMLElement

Defined in: src/base/validator.tsx:2063

Gets the element that should be highlighted for validation feedback. Checks data-vx-highlight, hidden textarea editors, and select2-offscreen.

Parameters

el

HTMLElement

Source form element.

Returns

HTMLElement

The highlight target element, or undefined if none.

getInstance()

static getInstance(element): Validator

Defined in: src/base/validator.tsx:765

Gets the validator instance associated with a form or an element inside a form.

Parameters

element

Form element, form-associated element, or array-like collection.

Node | HTMLFormElement | ArrayLike<HTMLElement>

Returns

Validator

The validator instance, or null if not found.

getLength()

static getLength(value, element): number

Defined in: src/base/validator.tsx:829

Gets the logical length of a value for minlength / maxlength checks. Handles selects, checkbox groups, and plain strings.

Parameters

value

ValidationValue

Raw field value.

element

HTMLElement

Source element (used for select / checkbox groups).

Returns

number

Length of the value.

isCheckOrRadio()

static isCheckOrRadio(element): element is HTMLInputElement

Defined in: src/base/validator.tsx:818

Whether the element is a checkbox or radio input.

Parameters

element

Node

Element to test.

Returns

element is HTMLInputElement

true if checkbox or radio.

isContentEditable()

static isContentEditable(element): boolean

Defined in: src/base/validator.tsx:847

Whether the element is content-editable.

Parameters

element

HTMLElement

Element to test.

Returns

boolean

true if contenteditable is set and not "false".

isValidatableElement()

static isValidatableElement(element): element is ValidatableElement

Defined in: src/base/validator.tsx:809

Checks if element is validatable (input, select, textarea).

Parameters

element

EventTarget

The element to check.

Returns

element is ValidatableElement

true if validatable, otherwise false.

normalizeAttributeRule()

static normalizeAttributeRule(rules, type, method, value): void

Defined in: src/base/validator.tsx:1846

Normalizes a single attribute rule value (e.g. coercing min/max/step to numbers).

Parameters

rules

Rules object to mutate.

type

string

Element type attribute.

method

string

Rule method name.

value

Raw attribute value.

bigint | ValidationValue

Returns

void

normalizeRules()

static normalizeRules(rules, element): ValidationRules

Defined in: src/base/validator.tsx:1970

Normalizes a merged rules object: handles depends, coerces numeric params, and optionally auto-creates ranges.

Parameters

rules

Raw merged rules.

element

Target element.

Returns

Normalized rules.

optional()

static optional(element, value?): "" | "dependency-mismatch"

Defined in: src/base/validator.tsx:315

Checks whether a field is optional (not required and empty).

Parameters

element

Element to test.

value?

ValidationValue

Optional explicit value; when omitted the element's current value is used.

Returns

"" | "dependency-mismatch"

Truthy optional marker or falsy when required / non-empty; "dependency-mismatch" when the required rule is absent and value is empty.

removeCustomRule()

static removeCustomRule(element, uniqueName): void

Defined in: src/base/validator.tsx:2104

Removes a custom validation callback previously added with Validator.addCustomRule.

Parameters

element

Target element or array-like collection.

HTMLElement | ArrayLike<HTMLElement>

uniqueName

string

Key under which the rule was registered.

Returns

void

rules()

static rules(element, command?, argument?): ValidationRules

Defined in: src/base/validator.tsx:952

Gets or mutates the validation rules for an element.

Parameters

element

Target element.

command?

"add" to add rules, "remove" to remove rules, or omitted to read.

"remove" | "add"

argument?

any

Rules to add or space-separated method names to remove.

Returns

The aggregated rules (or removed rules when command is "remove").

staticRules()

static staticRules(element): ValidationRules

Defined in: src/base/validator.tsx:1953

Gets rules from the validator's static settings.rules for the element's name.

Parameters

element

Target element.

Returns