In JavaScript, ariaMultiLine reflects the aria-multiline attribute: a string ("true" / "false") that tells assistive technology whether a text box accepts multiple lines or only one (MDN).
Read the notes below before you get or set this property. Prefer feature detection when support is limited.
Use el.ariaMultiLine. Start with this line.
element.ariaMultiLine| Call | What it does |
|---|---|
element.ariaMultiLine | Primary signature. |
Built into the browser. Read or assign el.ariaMultiLine — no import required.
element.ariaMultiLine| Parameter | Description |
|---|---|
| Value | Optional. "true" or "false" |
| Enter key handling | Required. Must match the announced mode |
| Custom elements | Optional. ElementInternals.ariaMultiLine |
| Return Value | Description |
|---|---|
| * | The current value of el.ariaMultiLine. |
Read the current mode, then switch the textbox to single-line.
let el = document.getElementById("txtBoxInput");
console.log(el.ariaMultiLine); // "true"
el.ariaMultiLine = "false";
console.log(el.ariaMultiLine); // "false"aria-multiline="true".ariaMultiLine. Returns the string "true"."false". Updates the reflected attribute.role="textbox"Declare a contenteditable textbox and mark it multi-line.
const box = document.getElementById("editor");
box.setAttribute("role", "textbox");
box.ariaMultiLine = "true";
box.setAttribute("aria-labelledby", "editor-label");
console.log(box.role, box.ariaMultiLine);textbox identifies an editable field.ariaMultiLine. Tells AT that Enter should insert a line break.aria-labelledby (or a visible label).Show that ariaMultiLine and aria-multiline stay in sync.
const el = document.getElementById("txtBoxInput");
el.ariaMultiLine = "false";
console.log(el.getAttribute("aria-multiline")); // "false"
el.setAttribute("aria-multiline", "true");
console.log(el.ariaMultiLine); // "true"getAttribute. Same value as ariaMultiLine."true" and "false".Element.ariaMultiLine is marked Baseline Widely available on MDN (since October 2023). Logos use the shared browser-image-sprite.png sprite from this project.
Reflects aria-multiline — whether a textbox accepts multiple lines.
Bottom line: Safe in modern browsers. Prefer textarea/input when you can; use ariaMultiLine on custom role=textbox widgets. See the MDN Element.ariaMultiLine reference.
Learn how multi-select widgets expose selection semantics to assistive technology.
11 people found this page helpful