HTMLButtonElement: setCustomValidity() method

{{ APIRef("HTML DOM") }}

The setCustomValidity() method of the {{DOMxRef("HTMLButtonElement")}} interface sets the custom validity message for the {{htmlelement("button")}} element. Use the empty string to indicate that the element does not have a custom validity error.

Syntax

setCustomValidity(string)

Parameters

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

Return value

None ({{jsxref("undefined")}}).

Examples

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{HTMLelement("button")}}
• {{domxref("HTMLButtonElement")}}
• {{domxref("HTMLButtonElement.validity")}}
• {{domxref("HTMLButtonElement.checkValidity()")}}
• {{domxref("HTMLButtonElement.reportValidity()")}}
• Form validation.
• Learn: Client-side form validation
• Guide: Constraint validation
• CSS {{cssxref(":valid")}} and {{cssxref(":invalid")}} pseudo-classes