HTMLButtonElement: setCustomValidity() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
The setCustomValidity() method of the HTMLButtonElement interface sets the custom validity message for the <button> element. Use the empty string to indicate that the element does not have a custom validity error.
Note:
This method only affects the validation UI for buttons with type="submit" (the default).
Buttons with type="reset" or type="button" are
barred from constraint validation,
so calling setCustomValidity() on them sets the internal validity state but the error message
is never shown to the user and form submission is never blocked.
Use HTMLButtonElement.willValidate to check whether a button participates in constraint validation.
Syntax
setCustomValidity(string)
Parameters
string-
The string containing the error message. The empty string removes any custom validity errors.
Return value
None (undefined).
Examples
const errorButton = document.getElementById("checkErrors");
const errors = issuesToReport();
if (errors) {
errorButton.setCustomValidity("There is an error");
} else {
errorButton.setCustomValidity("");
}
Specifications
| Specification |
|---|
| HTML # dom-cva-setcustomvalidity-dev |