MDN self-hosted library · e01.org

HTMLButtonElement: setCustomValidity() method

HTML DOM

HTML DOM

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.

Some button elements are not candidates for constraint validation (see HTMLButtonElement.willValidate). For these buttons, the reportValidity() method will not cause the custom error message to be displayed to the user, but does set the customError property of the element's ValidityState object to true and the valid property to false. 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

Browser compatibility

See also