ElementInternals: ariaChecked property

Baseline 2023

Newly available

Since October 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

The ariaChecked property of the 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".

js
this.internals_.ariaChecked = "true";

Specifications

Specification
Accessible Rich Internet Applications (WAI-ARIA)
# dom-ariamixin-ariachecked

Browser compatibility

BCD tables only load in the browser

See also