The setCustomValidity()
method of the HTMLObjectElement
interface sets a custom validity message for the element.
The setCustomValidity()
method of the HTMLObjectElement
interface sets a custom validity message for the element.
js
setCustomValidity(errorMessage)
errorMessage
The message to use for validity errors.
None (undefined
).
None.
In this example, we pass the ID of an input element, and set different error messages depending on whether the value is missing, too low or too high. Additionally you must call the reportValidity method on the same element or nothing will happen.
js
function validate(inputID) { const input = document.getElementById(inputID); const validityState = input.validity; if (validityState.valueMissing) { input.setCustomValidity("You gotta fill this out, yo!"); } else if (validityState.rangeUnderflow) { input.setCustomValidity("We need a higher number!"); } else if (validityState.rangeOverflow) { input.setCustomValidity("Thats too high!"); } else { input.setCustomValidity(""); } input.reportValidity(); }
It's vital to set the message to an empty string if there are no errors. As long as the error message is not empty, the form will not pass validation and will not be submitted.
Specification |
---|
HTML Standard # dom-cva-setcustomvalidity-dev |
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
setCustomValidity |
10 | 12 | 4 | 10 | ≤12.1 | 5.1 | ≤37 | 18 | 4 | ≤12.1 | 5 | 1.0 |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/setCustomValidity