ElementInternals: ariaRequired 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.

TheariaRequired property of theElementInternals interface reflects the value of thearia-required attribute, which indicates that user input is required on the element before a form may be submitted.

Note:Setting aria attributes onElementInternals 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 theAccessibility Object Model explainer.

Value

A string with one of the following values:

"true": Users need to provide input on an element before a form is submitted.
"false": User input is not necessary to submit the form.

Examples

In this example the value ofariaRequired is set to "true".

class CustomControl extends HTMLElement {  constructor() {    super();    this.internals_ = this.attachInternals();    this.internals_.ariaRequired = "true";  }  // …}