@serenity-is/corelib / ValidatorOptions
optionaldebug:boolean
True for logging debug info
optionalerrorClass:string
Use this class to create error labels, to look for existing error labels and to add it to invalid elements.
default: "error"
optionalerrorElement:string
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"
optionalfocusInvalid:boolean
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
optionalignore:string
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.
optionalmessages:Record<string,string>
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
optionalnormalizer: (val,element) =>string
string
optionalonclick:boolean|ValidateEventDelegate
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.
optionalonfocusin:ValidateEventDelegate
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.
optionalonfocusout:ValidateEventDelegate
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.
optionalonkeyup:ValidateEventDelegate
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.
optionalonsubmit:boolean
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
optionalpendingClass:string
Pending class default: "pending"
optionalrules:ValidationRulesMap
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().
optionalsuccess:string| (label,validatedInput) =>void
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!".
optionalvalidClass:string
This class is added to an element after it was validated and considered valid.
default: "valid"
optionalabortHandler(validator):void
void
optionalerrorPlacement(error,element,validator):void
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
HTMLElement
void
optionalhighlight(element,errorClass,validClass):void
How to highlight invalid fields. Override to decide which fields and how to highlight.
default: Adds errorClass (see the option) to the element
string
string
void
optionalinvalidHandler(event,validator):void
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.
Event
void
optionalshowErrors(errorMap,errorList,validator):void
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().
void
optionalsubmitHandler(form,event,validator):boolean|void
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.
HTMLFormElement
Event
boolean | void
optionalunhighlight(element,errorClass,validClass,validator):void
Called to revert changes made by option highlight, same arguments as highlight.
default: Removes the errorClass
string
string
void