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.
Syntax
setCustomValidity(string)
Note:
Visible constraint-validation feedback is only displayed when the button is of type submit.
Other button types (such as button and reset) still receive the validity state internally, and their status can be inspected programmatically using properties like validity and methods like checkValidity(), but browsers do not present any user-interface validation feedback for them.
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 |