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 December 2018.

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

js
setCustomValidity(string)

Parameters

string

The string containing the error message. The empty string removes any custom validity errors.

Return value

None (undefined).

Examples

js
const errorButton = document.getElementById("checkErrors");
const errors = issuesToReport();
if (errors) {
  errorButton.setCustomValidity("There is an error");
} else {
  errorButton.setCustomValidity("");
}

Specifications

Specification
HTML Standard
# dom-cva-setcustomvalidity-dev

Browser compatibility

BCD tables only load in the browser

See also