HTMLInputElement: setCustomValidity() method - Web APIs | MDN (original) (raw)
Baseline
Widely available
The HTMLInputElement.setCustomValidity()
method sets a custom validity message for the element.
Syntax
setCustomValidity(message)
Parameters
The message to use for validity errors.
Return value
Exceptions
None.
Examples
In this example, we pass the ID of an input element and set different error messages depending on whether the value is missing, too low, or too high. Note that the message will not be displayed immediately. Attempting to submit the form will display the message, or you can call thereportValidity() method on the element.
function validate(inputID) {
const input = document.getElementById(inputID);
const validityState = input.validity;
if (validityState.valueMissing) {
input.setCustomValidity("You gotta fill this out, yo!");
} else if (validityState.rangeUnderflow) {
input.setCustomValidity("We need a higher number!");
} else if (validityState.rangeOverflow) {
input.setCustomValidity("That's too high!");
} else {
input.setCustomValidity("");
}
input.reportValidity();
}
It's vital to set the message to an empty string if there are no errors. As long as the error message is not empty, the form will not pass validation and will not be submitted.
Specifications
Specification |
---|
HTML # dom-cva-setcustomvalidity |