Element: ariaControlsElements-Eigenschaft

Baseline 2025
Newly available

Since April 2025, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Die ariaControlsElements-Eigenschaft der Element-Schnittstelle ist ein Array, das die Elemente enthält, die von dem Element, auf das sie angewendet wird, kontrolliert werden. Beispielsweise könnte dies bei einer Combobox gesetzt werden, um das Element anzugeben, das sie öffnet, oder auf einer Scrollbar, um die ID des kontrollierten Elements anzugeben.

Das Thema aria-controls enthält zusätzliche Informationen darüber, wie das Attribut und die Eigenschaft verwendet werden sollten.

Wert

Ein Array von Unterklassen von HTMLElement, das die Elemente darstellt, die von diesem Element kontrolliert werden.

Beim Lesen ist das zurückgegebene Array statisch und schreibgeschützt. Beim Schreiben wird das zugewiesene Array kopiert: Nachfolgende Änderungen am Array beeinflussen den Wert der Eigenschaft nicht.

Beschreibung

Die Eigenschaft ist eine flexible Alternative zur Verwendung des aria-controls-Attributs, um die kontrollierten Elemente festzulegen. Im Gegensatz zu aria-controls müssen die Elemente, die dieser Eigenschaft zugewiesen sind, kein id-Attribut haben.

Die Eigenschaft spiegelt das aria-controls-Attribut wider, wenn es definiert ist, jedoch nur für aufgelistete Referenz-id-Werte, die gültigen, im Geltungsbereich befindlichen Elementen entsprechen. Wenn die Eigenschaft gesetzt wird, wird das entsprechende Attribut gelöscht. Weitere Informationen zu reflektierten Elementreferenzen und Geltungsbereichen finden Sie unter Reflektierte Elementreferenzen im Reflexionsattribute-Leitfaden.

Beispiele

Die kontrollierten Elemente abrufen

Dieses Beispiel zeigt, wie ariaControlsElements verwendet werden kann, um die kontrollierten Elemente abzurufen, die mit aria-controls festgelegt wurden.

HTML

Das HTML definiert zuerst ein <button>-Element und zwei <div>-Elemente, panel1 und panel2, die es kontrolliert. Die Referenzen zu den kontrollierten Panels sind im aria-controls-Attribut des Buttons aufgelistet.

html
<button id="toggleButton" aria-controls="panel1 panel2" aria-expanded="false">
  Show Details
</button>

<div class="panel" id="panel1" aria-hidden="true">
  <p>Panel1 opened/closed by button.</p>
</div>

<div class="panel" id="panel2" aria-hidden="true">
  <p>Panel2 opened/closed by button.</p>
</div>
css
.panel {
  display: none; /* Initially hidden */
  border: 1px solid #ccc;
  padding: 5px;
  margin-top: 5px;
}

JavaScript

Der Code richtet zunächst die Panels so ein, dass sie basierend auf dem aria-expanded-Attribut des Buttons ein- oder ausgeblendet werden.

js
const toggleButton = document.querySelector("#toggleButton");
const panel1 = document.querySelector("#panel1");
const panel2 = document.querySelector("#panel2");

toggleButton.addEventListener("click", () => {
  const isExpanded = toggleButton.getAttribute("aria-expanded") === "true";

  toggleButton.setAttribute("aria-expanded", !isExpanded);
  panel1.style.display = isExpanded ? "none" : "block";
  panel1.setAttribute("aria-hidden", isExpanded); //true when hidden, false when shown.

  panel2.style.display = isExpanded ? "none" : "block";
  panel2.setAttribute("aria-hidden", isExpanded); //true when hidden, false when shown.
});

Als Nächstes holt das Beispiel den Wert des aria-controls-Attributs mit Element.getAttribute() (einem String, der die id-Werte der referenzierten Elemente auflistet). Dann wird geprüft, ob die ariaControlsElements-Eigenschaft unterstützt wird, und falls ja, wird deren Wert protokolliert. Schließlich wird der inhaltliche Text für jedes der kontrollierten Elemente zurückgegeben und protokolliert.

js
log(`aria-controls: ${toggleButton.getAttribute("aria-controls")}`);
// Feature test for ariaControlsElements
if ("ariaControlsElements" in Element.prototype) {
  // Get ariaControlsElements
  const controlledElements = toggleButton.ariaControlsElements;
  log(`ariaControlsElements: ${controlledElements}`);

  // List innerText for each of the ariaControlsElements
  controlledElements.forEach((controlled) => {
    log(` Controlled element text: ${controlled.textContent.trim()}`);
  });
} else {
  log("element.ariaControlsElements: not supported by browser");
}

Ergebnis

Klicken Sie unten auf die Schaltfläche, um die Panels anzuzeigen und auszublenden. Das Protokoll zeigt die ursprünglichen Elementreferenzen, die zugeordneten/zurückgegebenen Elemente und den inhaltlichen Text jedes Elements.

Spezifikationen

Specification
Accessible Rich Internet Applications (WAI-ARIA)
# dom-ariamixin-ariacontrolselements

Browser-Kompatibilität

Siehe auch