aria-description
Das globale aria-description
-Attribut definiert einen Zeichenfolgenwert, der das aktuelle Element beschreibt oder kommentiert.
Note:
aria-description
befindet sich noch im W3C Editor's Draft für ARIA 1.3. Verwenden Sie einstweilen weiterhinaria-describedby
, das seit ARIA 1.1 unterstützt wird.
Beschreibung
Das globale aria-description
-Attribut bietet Entwicklern eine Möglichkeit, das aktuelle Element zu beschreiben oder zu kommentieren und so den Nutzern von unterstützenden Technologien mehr Kontext zu geben.
<div
role="application"
aria-label="calendar"
aria-description="Game schedule for the Boston Red Sox 2021 Season">
<h1>Red Sox 2021</h1>
<div role="grid">…</div>
</div>
Das aria-description
-Attribut ähnelt aria-label
, da beide eine Textzeichenfolge zur Assoziation mit dem Element bereitstellen. Ein Label sollte jedoch kurz und prägnant sein, während die Beschreibung länger sein kann, da sie mehr Kontext und Informationen bieten soll.
Die Eigenschaften aria-description
und aria-describedby
haben denselben Zweck; beide bieten dem Benutzer zusätzlichen beschreibenden Text für das Objekt, auf dem sie gesetzt sind. Wenn beschreibender Text im DOM verfügbar ist, verwenden Sie stattdessen aria-describedby
.
Die aria-description
-Eigenschaft sollte nur verwendet werden, wenn eine sichtbare Beschreibung nicht das gewünschte Benutzererlebnis darstellt. Das aria-describedby
-Attribut nimmt als seinen Wert eine Liste von id
s von Elementen, die beschreibenden Text über das Objekt enthalten. aria-description
wird genutzt, wenn kein geeigneter beschreibender Text vorhanden ist, der über eine id
-Referenz mit dem Objekt verknüpft werden kann. Wenn beide Attribute vorhanden sind, hat aria-describedby
Vorrang bei der Definition der zugänglichen Beschreibung.
Der Inhalt der Beschreibung, ob gesetzt durch aria-description
oder aria-describedby
, sollte flacher Text sein. Wenn der Inhalt sehr lang ist, semantische Bedeutungen erfordert oder eine Navigationsstruktur hat, verwenden Sie stattdessen aria-details
.
Werte
<string>
-
Der Wert ist eine Zeichenfolge, ein unbeschränkter Wertetyp, der dem Benutzer von unterstützenden Technologien vermittelt werden soll.
Zugehörige Schnittstellen
Element.ariaDescription
-
Die
ariaDescription
-Eigenschaft, Teil derElement
-Schnittstelle, spiegelt den Wert desaria-description
-Attributs wider, der eine Zeichenfolge definiert, die das aktuelle Element beschreibt oder kommentiert.
Zugehörige Rollen
Verwendet in ALLEN Rollen.
Spezifikationen
Specification |
---|
Accessible Rich Internet Applications (WAI-ARIA) # aria-description |