ElementInternals: ariaChecked property

{{APIRef("Web Components")}} 

The ariaChecked property of the {{domxref("ElementInternals")}}  interface reflects the value of the aria-checked attribute, which indicates the current “checked” state of checkboxes, radio buttons, and other widgets that have a checked state.

[!NOTE] Setting aria attributes on ElementInternals allows default semantics to be defined on a custom element. These may be overwritten by author-defined attributes, but ensure that default semantics are retained should the author delete those attributes, or fail to add them at all. For more information see the Accessibility Object Model explainer.

Value

A string with one of the following values:

• "true"
  • : The element is checked.
• "mixed"
  • : Indicates a mixed mode value for a tri-state checkbox or menuitemcheckbox.
• "false"
  • : The element supports being checked but is not currently checked.
• "undefined"
  • : The element does not support being checked.

Examples

In this example the value of ariaChecked is set to “true”.

this.internals_.ariaChecked = "true";

Specifications

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

• ARIA: checkbox role