@serenity-is/corelib / Validator

Class: Validator

Constructors

new Validator()

new Validator(form, options): Validator

Parameters

form

HTMLFormElement

options

ValidatorOptions

Returns

Validator

Defined in

src/base/validator.tsx:528

Properties

dependTypes

dependTypes: object

boolean()

boolean: (param) => any

Parameters

param

any

Returns

any

function()

function: (param, element) => any

Parameters

param

any

element

ValidatableElement

Returns

any

string()

string: (param, element) => boolean

Parameters

param

any

element

ValidatableElement

Returns

boolean

Defined in

src/base/validator.tsx:1373

---

lastActive

lastActive: ValidatableElement

Defined in

src/base/validator.tsx:512

---

settings

readonly settings: ValidatorOptions

Defined in

src/base/validator.tsx:511

---

autoCreateRanges

static autoCreateRanges: boolean = false

Defined in

src/base/validator.tsx:259

---

classRuleSettings

static classRuleSettings: Record<string, ValidationRules>

Defined in

src/base/validator.tsx:1454

---

defaults

static defaults: ValidatorOptions

Defined in

src/base/validator.tsx:261

---

messages

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

Defined in

src/base/validator.tsx:341

---

methods

readonly static methods: Record<string, ValidationProvider>

Defined in

src/base/validator.tsx:363

Methods

abortRequest()

abortRequest(element): void

Parameters

element

ValidatableElement

Returns

void

Defined in

src/base/validator.tsx:1421

---

check()

check(element): boolean

Parameters

element

ValidatableElement

Returns

boolean

Defined in

src/base/validator.tsx:1090

---

checkForm()

checkForm(): boolean

Returns

boolean

Defined in

src/base/validator.tsx:862

---

customDataMessage()

customDataMessage(element, method): string

Parameters

element

ValidatableElement

method

string

Returns

string

Defined in

src/base/validator.tsx:1171

---

customMessage()

customMessage(name, method): any

Parameters

name

string

method

string

Returns

any

Defined in

src/base/validator.tsx:1176

---

defaultMessage()

defaultMessage(element, rule): any

Parameters

element

ValidatableElement

rule

rule.method

string

rule.parameters

any

Returns

any

Defined in

src/base/validator.tsx:1191

---

defaultShowErrors()

defaultShowErrors(): void

Returns

void

Defined in

src/base/validator.tsx:1226

---

depend()

depend(param, element): any

Parameters

param

any

element

ValidatableElement

Returns

any

Defined in

src/base/validator.tsx:1385

---

destroy()

destroy(): void

Returns

void

Defined in

src/base/validator.tsx:1447

---

element()

element(element): boolean

Parameters

element

ValidatableElement

Returns

boolean

Defined in

src/base/validator.tsx:870

---

elements()

elements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.tsx:1013

---

errors()

errors(): HTMLElement[]

Returns

HTMLElement[]

Defined in

src/base/validator.tsx:1058

---

errorsFor()

errorsFor(element): HTMLElement[]

Parameters

element

ValidatableElement

Returns

HTMLElement[]

Defined in

src/base/validator.tsx:1338

---

findByName()

findByName(name): ValidatableElement[]

Parameters

name

string

Returns

ValidatableElement[]

Defined in

src/base/validator.tsx:1369

---

findDefined()

findDefined(...args): any

Parameters

args

...any[]

Returns

any

Defined in

src/base/validator.tsx:1182

---

findLastActive()

findLastActive(): ValidatableElement

Returns

ValidatableElement

Defined in

src/base/validator.tsx:1008

---

focusInvalid()

focusInvalid(): void

Returns

void

Defined in

src/base/validator.tsx:990

---

form()

form(): boolean

Returns

boolean

Defined in

src/base/validator.tsx:851

---

formatAndAdd()

formatAndAdd(element, rule): void

Parameters

element

ValidatableElement

rule

rule.method

string

rule.parameters

any

Returns

void

Defined in

src/base/validator.tsx:1213

---

hideErrors()

hideErrors(): void

Returns

void

Defined in

src/base/validator.tsx:971

---

hideThese()

hideThese(errors): void

Parameters

errors

HTMLElement[]

Returns

void

Defined in

src/base/validator.tsx:975

---

idOrName()

idOrName(element): string

Parameters

element

ValidatableElement

Returns

string

Defined in

src/base/validator.tsx:1353

---

invalidElements()

invalidElements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.tsx:1258

---

numberOfInvalids()

numberOfInvalids(): number

Returns

number

Defined in

src/base/validator.tsx:952

---

prepareElement()

prepareElement(element): void

Parameters

element

ValidatableElement

Returns

void

Defined in

src/base/validator.tsx:1085

---

prepareForm()

prepareForm(): void

Returns

void

Defined in

src/base/validator.tsx:1080

---

previousValue()

previousValue(element, method): any

Parameters

element

ValidatableElement

method

string

Returns

any

Defined in

src/base/validator.tsx:1436

---

reset()

reset(): void

Returns

void

Defined in

src/base/validator.tsx:1071

---

resetAll()

resetAll(): void

Returns

void

Defined in

src/base/validator.tsx:1076

---

resetElements()

resetElements(elements): void

Parameters

elements

ValidatableElement[]

Returns

void

Defined in

src/base/validator.tsx:936

---

resetForm()

resetForm(): void

Returns

void

Defined in

src/base/validator.tsx:922

---

resetInternals()

resetInternals(): void

Returns

void

Defined in

src/base/validator.tsx:1063

---

showErrors()

showErrors(errors?): void

Parameters

errors?

ValidationErrorMap

Returns

void

Defined in

src/base/validator.tsx:901

---

showLabel()

showLabel(element, message?): void

Parameters

element

ValidatableElement

message?

string

Returns

void

Defined in

src/base/validator.tsx:1262

---

size()

size(): number

Returns

number

Defined in

src/base/validator.tsx:986

---

startRequest()

startRequest(element): void

Parameters

element

ValidatableElement

Returns

void

Defined in

src/base/validator.tsx:1389

---

stopRequest()

stopRequest(element, valid): void

Parameters

element

ValidatableElement

valid

boolean

Returns

void

Defined in

src/base/validator.tsx:1397

---

valid()

valid(): boolean

Returns

boolean

Defined in

src/base/validator.tsx:982

---

validationTargetFor()

validationTargetFor(element): ValidatableElement

Parameters

element

ValidatableElement

Returns

ValidatableElement

Defined in

src/base/validator.tsx:1357

---

validElements()

validElements(): ValidatableElement[]

Returns

ValidatableElement[]

Defined in

src/base/validator.tsx:1253

---

addClassRules()

static addClassRules(className, rules): void

Parameters

className

any

rules

ValidationRules

Returns

void

Defined in

src/base/validator.tsx:1466

---

addMethod()

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

Parameters

name

string

method

ValidationProvider

message?

string

Returns

void

Defined in

src/base/validator.tsx:1649

---

attributeRules()

static attributeRules(element): ValidationRules

Parameters

element

ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.tsx:1511

---

classRules()

static classRules(element): ValidationRules

Parameters

element

ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.tsx:1474

---

dataRules()

static dataRules(element): object

Parameters

element

ValidatableElement

Returns

object

Defined in

src/base/validator.tsx:1547

---

elementValue()

static elementValue(element): string | number | string[]

Parameters

element

HTMLElement

Returns

string | number | string[]

Defined in

src/base/validator.tsx:695

---

getHighlightTarget()

static getHighlightTarget(el): HTMLElement

Parameters

el

HTMLElement

Returns

HTMLElement

Defined in

src/base/validator.tsx:1657

---

getInstance()

static getInstance(element): Validator

Parameters

element

Node | HTMLFormElement | ArrayLike<HTMLElement>

Returns

Validator

Defined in

src/base/validator.tsx:625

---

getLength()

static getLength(value, element): number

Parameters

value

ValidationValue

element

HTMLElement

Returns

number

Defined in

src/base/validator.tsx:677

---

isCheckOrRadio()

static isCheckOrRadio(element): element is HTMLInputElement

Parameters

element

Node

Returns

element is HTMLInputElement

Defined in

src/base/validator.tsx:673

---

isContentEditable()

static isContentEditable(element): boolean

Parameters

element

HTMLElement

Returns

boolean

Defined in

src/base/validator.tsx:690

---

isValidatableElement()

static isValidatableElement(element): element is ValidatableElement

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

Parameters

element

EventTarget

The element to check.

Returns

element is ValidatableElement

true if validatable, otherwise false.

Defined in

src/base/validator.tsx:669

---

normalizeAttributeRule()

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

Parameters

rules

ValidationRules

type

string

method

string

value

ValidationValue

Returns

void

Defined in

src/base/validator.tsx:1488

---

normalizeRules()

static normalizeRules(rules, element): ValidationRules

Parameters

rules

ValidationRules

element

ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.tsx:1576

---

optional()

static optional(element): "" | "dependency-mismatch"

Parameters

element

ValidatableElement

Returns

"" | "dependency-mismatch"

Defined in

src/base/validator.tsx:254

---

rules()

static rules(element, command?, argument?): Record<string, any>

Parameters

element

ValidatableElement

command?

"remove" | "add"

argument?

any

Returns

Record<string, any>

Defined in

src/base/validator.tsx:776

---

staticRules()

static staticRules(element): ValidationRules

Parameters

element

ValidatableElement

Returns

ValidationRules

Defined in

src/base/validator.tsx:1565

---

valid()

static valid(element): boolean

Parameters

element

HTMLFormElement | ValidatableElement | ArrayLike<ValidatableElement>

Returns

boolean

Defined in

src/base/validator.tsx:761