Element: ariaPlaceholder property
{{APIRef("DOM")}}
The ariaPlaceholder
property of the {{domxref("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.
[!NOTE] Where possible use an HTML
{{htmlelement("input")}}
element withtype="text"
or a{{htmlelement("textarea")}}
as these have built in semantics and do not require ARIA attributes.
Value
A string.
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 zip code</div>
<div
role="textbox"
id="txtBoxInput"
contenteditable="true"
aria-placeholder="5-digit zip code"
aria-labelledby="txtboxLabel"></div>
let el = document.getElementById("txtBoxInput");
console.log(el.ariaPlaceholder); // "5-digit zip code"
el.ariaPlaceholder = "12345";
console.log(el.ariaPlaceholder); // "12345"
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}