ElementInternals: checkValidity() method
The checkValidity()
method of the ElementInternals
interface checks if the element meets any constraint validation rules applied to it.
If checkValidity
returns false
then a cancelable invalid event is fired on the element.
Syntax
js
checkValidity()
Parameters
None.
Return value
A boolean value, true
if the element meets all validation constraints.
Exceptions
NotSupportedError
DOMException
-
Thrown if the element does not have its
formAssociated
property set totrue
.
Examples
In the following example ElementInternals.setValidity()
is used to indicate that the element does not meet validation rules. Calling checkValidity()
returns false
. After calling setValidity
again, this time indicating that all rules are marked false, checkValidity()
returns true
.
js
let element = document.getElementById("join-checkbox");
element.internals_.setValidity({ valueMissing: true }, "my message");
console.log(element.internals_.checkValidity()); // false
element.internals_.setValidity({});
console.log(element.internals_.checkValidity()); // true
Specifications
Specification |
---|
HTML Standard # dom-elementinternals-checkvalidity |
Browser compatibility
BCD tables only load in the browser