aria-labelledby

Das aria-labelledby Attribut identifiziert das Element (oder die Elemente), die das Element beschriften, auf das es angewendet wird.

Beschreibung

Die aria-labelledby Eigenschaft ermöglicht es Autoren, sich auf andere Elemente auf der Seite zu beziehen, um einen zugänglichen Namen zu definieren. Dies ist nützlich beim Verwenden von Elementen, die keine native Unterstützung bieten, um Elemente zu verbinden und einen zugänglichen Namen bereitzustellen.

Einige Elemente erhalten ihren zugänglichen Namen aus ihrem Inhalt. Beispielsweise kommt der zugängliche Name für ein <button>, <a> oder <td> aus dem Text zwischen den öffnenden und schließenden Tags. Andere Elemente, wie das Formular <textarea>, <fieldset> und <table> erhalten ihren zugänglichen Namen aus dem Inhalt der verbundenen Elemente; für diese Elemente kommt der zugängliche Name vom <label> mit einem for Attribut, <legend>, und <caption>.

Alle interaktiven Elemente müssen einen zugänglichen Namen haben. aria-labelledby kann verwendet werden, um sich auf ein anderes Element zu beziehen, um seinen zugänglichen Namen zu definieren, wenn der zugängliche Name eines Elements Inhalt aus einem anderen Teil des DOMs verwenden muss.

Wenn es keinen Inhalt gibt, auf den verwiesen werden kann, um einen zugänglichen Namen zu erstellen, sollte stattdessen das aria-label Attribut verwendet werden.

Der Zweck von aria-labelledby ist derselbe wie der von aria-label. Es bietet dem Benutzer einen erkennbaren und zugänglichen Namen für ein interaktives Element. Wenn ein Element beide Attribute gesetzt hat, wird aria-labelledby verwendet. aria-labelledby hat Vorrang vor allen anderen Methoden zur Bereitstellung eines zugänglichen Namens, einschließlich aria-label, <label> und dem inneren Text des Elements.

Die aria-labelledby und aria-describedby Attribute beziehen sich beide auf andere Elemente, um alternative Textdarstellungen zu berechnen. aria-labelledby sollte sich auf kurzen Text beziehen, der dem Element einen zugänglichen Namen gibt. aria-describedby wird verwendet, um längere Inhalte zu referenzieren, die eine Beschreibung liefern. Wenn es kein Element im DOM gibt, das ein passendes, kurzes Label für einen zugänglichen Namen eines interaktiven Elements bereitstellt, verwenden Sie aria-label, um den zugänglichen Namen für ein interaktives Element zu definieren.

Hinweis: Während in amerikanischem Englisch "labeled" mit einem "l" geschrieben wird, hat sich die Schreibweise "labelledby" etabliert und wird in Barrierefreiheits-APIs verwendet.

Das folgende Beispiel verwendet aria-labelledby, um einen zugänglichen Namen für ein Kontrollkästchen-Eingabeelement bereitzustellen, indem der Textinhalt eines Nachbarelements verwendet wird:

html
<span
  role="checkbox"
  aria-checked="false"
  tabindex="0"
  aria-labelledby="tac"></span>
<span id="tac">I agree to the Terms and Conditions.</span>

Beachten Sie, dass die Verwendung von aria-labelledby in dieser Situation der Verwendung eines HTML <label> Elements mit dem for Attribut ähnlich ist, es jedoch einige sehr wichtige Unterschiede gibt. Das aria-labelledby Attribut definiert nur den zugänglichen Namen. Es bietet keine der anderen Funktionen von <label>, wie etwa das Aktivieren des zugeordneten Eingabeelements beim Klicken auf das Beschriftungselement. Dies muss mit JavaScript hinzugefügt werden.

Glücklicherweise funktioniert das HTML <input> mit type="checkbox" mit dem nativen <label>. Wenn möglich, verwenden Sie Folgendes:

html
<label for="tac">
  <input id="tac" type="checkbox" name="terms-and-conditions" />
  I agree to the Terms and Conditions.
</label>
<p><a href="tac.html">Read our Terms and Conditions</a>.</p>

Vorteile (und Nachteile)

  1. Die aria-labelledby Eigenschaft hat die höchste Priorität, wenn Browser zugängliche Namen berechnen. Seien Sie sich bewusst, dass sie andere Methoden zur Benennung des Elements überschreibt, einschließlich aria-label, anderer Benennungsattribute und sogar den Inhalt des Elements.

    html
    <button aria-label="Blue" aria-labelledby="color">Red</button>
    <span id="color">Yellow</span>
    

    In diesem Beispiel ist der zugängliche Name "Yellow".

  2. Die aria-labelledby Eigenschaft nimmt als Wert eine durch Leerzeichen getrennte Liste von ID-Referenzen an, was bedeutet, dass Sie mehr als ein Element zu einem einzigen zugänglichen Namen kombinieren können. Sie können die id des Elements selbst einschließen, um auf seinen eigenen Inhalt zu verweisen.

    html
    <h2 id="attr" class="article-title">13 ARIA attributes you need to know</h2>
    <p>
      There are over 50 ARIA states and properties, but 13 of them stand out…
      <a href="13.html" id="rm13" aria-labelledby="rm13 attr">read more</a>
    </p>
    

    In diesem Beispiel lautet der zugängliche Name "read more 13 ARIA attributes you need to know".

  3. Die Reihenfolge der Werte der aria-labelledby Eigenschaft ist wichtig. Wenn mehr als ein Element durch aria-labelledby referenziert wird, wird der Inhalt von jedem referenzierten Element in der Reihenfolge kombiniert, in der sie im aria-labelledby Wert referenziert werden. Hätten wir aria-labelledby="attr rm13"> geschrieben, wäre der zugängliche Name "13 ARIA attributes you need to know read more".

  4. Die aria-labelledby Eigenschaft ignoriert wiederholte ids in ihrem Wert. Wenn ein Element mehr als einmal referenziert wird, wird nur die erste Referenz verarbeitet. aria-labelledby="attr attr rm13 rm13"> wird als aria-labelledby="attr rm13"> behandelt.

  5. Die aria-labelledby Eigenschaftswert kann Inhalte aus Elementen enthalten, die nicht einmal sichtbar sind. Während Sie Benutzern von unterstützender Technologie den gleichen Inhalt wie allen anderen Benutzern bieten sollten, können Sie Inhalt aus Elementen mit dem HTML hidden Attribut, CSS display: none und CSS visibility: hidden in der berechneten Namen Zeichenfolge einschließen.

  6. Die aria-labelledby Eigenschaft bezieht den Wert von Eingabeelementen ein. Wenn der Wert eine <input> referenziert, wird der aktuelle Wert des Formularsteuerelements in die berechnete Namen Zeichenfolge einbezogen und ändert sich, wenn der Wert aktualisiert wird.

  7. Die aria-labelledby Eigenschaft kann nicht verkettet werden. Wenn ein Element mit aria-labelledby ein anderes Element referenziert, das ebenfalls aria-labelledby besitzt, wird das aria-labelledby Attribut des referenzierten Elements ignoriert.

Warnung: Da die Berechnung des Namens eines Elements mit aria-labelledby komplex sein kann und sich auf versteckte Inhalte beziehen kann, ist das Testen mit unterstützender Technologie sehr wichtig, um sicherzustellen, dass der erwartete Name den Benutzern präsentiert wird.

Werte

ID-Referenzliste

Durch Leerzeichen getrennte Liste von einem oder mehreren ID-Werten, die auf die Elemente verweisen, die das aktuelle Element beschriften.

Zugehörige Rollen

Verwendet in fast allen Rollen außer in Rollen, denen der Autor keinen zugänglichen Namen zuweisen kann.

Das aria-labelledby Attribut wird NICHT unterstützt in:

Spezifikationen

Specification
Accessible Rich Internet Applications (WAI-ARIA)
# aria-labelledby

Siehe auch