Element.ariaPlaceholder

Note

The ariaPlaceholder property of the Element interface reflects the value of the aria-placeholder attribute, which defines a short hint intended to aid the user with data entry when the control has no value.

Where possible use an HTML <input> element with type="text" or a <textarea> as these have built in semantics and do not require ARIA attributes.

Syntax

var ariaPlaceholder = element.ariaPlaceholder;
element.ariaPlaceholder = ariaPlaceholder

Value

A DOMString.

Examples

In this example the aria-placeholder attribute on the element with an ID of txtBoxInput has been set to a string. Using ariaPlaceholder we update the string to another value.

<div id="txtboxLabel">Enter your five-digit zipcode</div>
<div role="textbox" id="txtBoxInput" contenteditable="true" aria-placeholder="5-digit zipcode" aria-labelledby="txtboxLabel"></div>
let el = document.getElementById('txtBoxInput');
console.log(el.ariaPlaceholder); // "5-digit zipcode"
el.ariaPlaceholder = "12345"
console.log(el.ariaPlaceholder); // "12345"

Specifications

Specification Status Comment
Accessible Rich Internet Applications (WAI-ARIA) 1.2
The definition of 'ariaPlaceholder' in that specification.
Working Draft Initial definition.

Browser compatibility

BCD tables only load in the browser

See also