Element.ariaMultiline

Note

The ariaMultiline property of the Element interface reflects the value of the aria-multiline attribute, which indicates whether a text box accepts multiple lines of input or only a single line.

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 ariaMultiline = element.ariaMultiline;
element.ariaMultiline = ariaMultiline

Value

A DOMString with one of the following values:

"true"
This is a multi-line text box.
"false"
This is a single-line text box.

Examples

In this example the aria-multiline attribute on the element with an ID of txtBoxInput is set to "true" indicating that this box allows for multiple lines of input. Using ariaPlaceholder we update the value to "false".

<div id="txtboxMultilineLabel">Enter the tags for the article</div>
<div role="textbox" id="txtBoxInput" contenteditable="true" aria-multiline="true"
  aria-labelledby="txtboxMultilineLabel" aria-required="true"></div>
let el = document.getElementById('txtBoxInput');
console.log(el.ariaMultiline); // "true"
el.ariaMultiline = "false"
console.log(el.ariaMultiline); // "false"

Specifications

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

Browser compatibility

No compatibility data found for api.Element.ariaMultiline.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

See also