@serenity-is/corelib / ValidatorOptions

Interface: ValidatorOptions

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

Properties

debug?

optional debug: boolean

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

True for logging debug info

errorClass?

optional errorClass: string

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

Use this class to create error labels, to look for existing error labels and to add it to invalid elements.

default: "error"

errorElement?

optional errorElement: string

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

Use this element type to create error messages and to look for existing error messages. The default, "label", has the advantage of creating a meaningful link between error message and invalid field using the for attribute (which is always used, regardless of element type).

default: "label"

focusInvalid?

optional focusInvalid: boolean

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

Focus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one that had focus when the form was submitted, avoiding stealing its focus. If there was no element focused, the first one in the form gets it, unless this option is turned off.

default: true

ignore?

optional ignore: string

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

Elements to ignore when validating, simply filtering them out. CSS not-method is used, therefore everything that is accepted by not() can be passed as this option. Inputs of type submit and reset are always ignored, so are disabled elements.

messages?

optional messages: Record<string, string | Record<string, string>>

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

Key/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead of a plain message, another map with specific messages for each rule can be used. Overrides the title attribute of an element or the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope of the validator, with the rule's parameters as the first argument and the element as the second, and must return a String to display as the message.

default: the default message for the method used

normalizer()?

optional normalizer: (val, element) => string

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

Parameters

val

ValidationValue

element

ValidatableElement

Returns

string

onclick?

optional onclick: boolean | ValidateEventDelegate

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

Boolean or Function. Validate checkboxes and radio buttons on click. Set to false to disable.

Set to a Function to decide for yourself when to run validation. A boolean true is not a valid value.

onfocusin?

optional onfocusin: ValidateEventDelegate

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

Function. Validate elements when user focuses in. If omitted hides all other fields marked as invalid.

Set to a custom Function to decide for yourself when to run validation.

onfocusout?

optional onfocusout: ValidateEventDelegate

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

Boolean or Function. Validate elements (except checkboxes/radio buttons) on blur. If nothing is entered, all rules are skipped, except when the field was already marked as invalid.

Set to a Function to decide for yourself when to run validation. A boolean true is not a valid value.

onkeyup?

optional onkeyup: ValidateEventDelegate

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

Boolean or Function. Validate elements on keyup. As long as the field is not marked as invalid, nothing happens. Otherwise, all rules are checked on each key up event. Set to false to disable.

Set to a Function to decide for yourself when to run validation. A boolean true is not a valid value.

onsubmit?

optional onsubmit: boolean

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

Validate the form on submit. Set to false to use only other events for validation. Set to a Function to decide for yourself when to run validation. A boolean true is not a valid value.

default: true

pendingClass?

optional pendingClass: string

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

Pending class default: "pending"

rules?

optional rules: ValidationRulesMap

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

A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, called in the context of the validator object. The arguments contain only those elements currently validated, which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default behaviour by calling this.defaultShowErrors().

success?

optional success: string | (label, validatedInput) => void

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

String or Function. If specified, the error label is displayed to show a valid element. If a String is given, it is added as a class to the label. If a Function is given, it is called with the label and the validated input (as a DOM element). The label can be used to add a text like "ok!".

validClass?

optional validClass: string

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

This class is added to an element after it was validated and considered valid.

default: "valid"

Methods

abortHandler()?

optional abortHandler(validator): void

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

Parameters

validator

Validator

Returns

void

errorPlacement()?

optional errorPlacement(error, element, validator): void

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

Customize placement of created error labels. First argument: The created error label. Second argument: The invalid element.

default: Places the error label after the invalid element

Parameters

error

HTMLElement

element

ValidatableElement

validator

Validator

Returns

void

highlight()?

optional highlight(element, errorClass, validClass): void

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

How to highlight invalid fields. Override to decide which fields and how to highlight.

default: Adds errorClass (see the option) to the element

Parameters

element

ValidatableElement

errorClass

string

validClass

string

Returns

void

invalidHandler()?

optional invalidHandler(event, validator): void

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

Callback for custom code when an invalid form is submitted. Called with an event object as the first argument, and the validator as in the second.

Parameters

event

Event

validator

Validator

Returns

void

showErrors()?

optional showErrors(errorMap, errorList, validator): void

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

Parameters

Returns

void

submitHandler()?

optional submitHandler(form, event, validator): boolean | void

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

Callback for handling the actual submit when the form is valid. Gets the form and the event object. Replaces the default submit. The right place to submit a form via Ajax after it is validated.

Parameters

form

HTMLFormElement

event

Event

validator

Validator

Returns

boolean | void

unhighlight()?

optional unhighlight(element, errorClass, validClass, validator): void

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

Called to revert changes made by option highlight, same arguments as highlight.

default: Removes the errorClass

Parameters

element

ValidatableElement

errorClass

string

validClass

string

validator

Validator

Returns

void