Web Components
The setValidity() method of the ElementInternals interface sets the validity of the element.
Syntax
setValidity(flags)
setValidity(flags, message)
setValidity(flags, message, anchor)
Parameters
-
flags-
: A dictionary object containing one or more flags indicating the validity state of the element:
valueMissing- : A boolean value that is
trueif the element has arequiredattribute, but no value, orfalseotherwise. Iftrue, the element matches the :invalid CSS pseudo-class.
- : A boolean value that is
typeMismatch- : A boolean value that is
trueif the value is not in the required syntax (whentypeisemailorurl), orfalseif the syntax is correct. Iftrue, the element matches the :invalid CSS pseudo-class.
- : A boolean value that is
patternMismatch- : A boolean value that is
trueif the value does not match the specifiedpattern, andfalseif it does match. Iftrue, the element matches the :invalid CSS pseudo-class.
- : A boolean value that is
tooLong- : A boolean value that is
trueif the value exceeds the specifiedmaxlengthfor HTMLInputElement or HTMLTextAreaElement objects, orfalseif its length is less than or equal to the maximum length. Iftrue, the element matches the :invalid and :out-of-range CSS pseudo-classes.
- : A boolean value that is
tooShort- : A boolean value that is
trueif the value fails to meet the specifiedminlengthfor HTMLInputElement or HTMLTextAreaElement objects, orfalseif its length is greater than or equal to the minimum length. Iftrue, the element matches the :invalid and :out-of-range CSS pseudo-classes.
- : A boolean value that is
rangeUnderflow- : A boolean value that is
trueif the value is less than the minimum specified by theminattribute, orfalseif it is greater than or equal to the minimum. Iftrue, the element matches the :invalid and :out-of-range CSS pseudo-classes.
- : A boolean value that is
rangeOverflow- : A boolean value that is
trueif the value is greater than the maximum specified by themaxattribute, orfalseif it is less than or equal to the maximum. Iftrue, the element matches the :invalid and :out-of-range and CSS pseudo-classes.
- : A boolean value that is
stepMismatch- : A boolean value that is
trueif the value does not fit the rules determined by thestepattribute (that is, it's not evenly divisible by the step value), orfalseif it does fit the step rule. Iftrue, the element matches the :invalid and :out-of-range CSS pseudo-classes.
- : A boolean value that is
badInput- : A boolean value that is
trueif the user has provided input that the browser is unable to convert.
- : A boolean value that is
customError- : A boolean value indicating whether the element's custom validity message has been set to a non-empty string by calling the element's HTMLInputElement.setCustomValidity method.
[!NOTE] To set all flags to
false, indicating that this element passes all constraints validation, pass in an empty object{}. In this case, you do not need to also pass amessage.
-
-
message- : A string containing a message, which will be set if any
flagsaretrue. This parameter is only optional if allflagsarefalse.
- : A string containing a message, which will be set if any
-
anchor- : An HTMLElement which can be used by the user agent to report problems with this form submission.
Return value
None (undefined).
Exceptions
NotSupportedErrorDOMException- : Thrown if the element does not have its
formAssociatedproperty set totrue.
- : Thrown if the element does not have its
- TypeError
- : Thrown if one or more
flagsistrue.
- : Thrown if one or more
NotFoundErrorDOMException- : Thrown if
anchoris given, but the anchor is not a shadow-including descendant of the element.
- : Thrown if
Examples
In the following example setValidity is called with an empty flags parameter to indicate that the element meets constraint validation rules.
this.internals_.setValidity({});
In the following example setValidity is called with the flag valueMissing set to true. A message parameter must then also be passed containing a message.
this.internals_.setValidity({ valueMissing: true }, "my message");
Specifications
Browser compatibility
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
