元素:ariaBrailleRoleDescription 属性

Baseline 2024
新推出

自 2024 年 9 月起,此功能已可在最新设备和浏览器版本上使用。此功能可能无法在旧设备或浏览器上使用。

Element 接口的 ariaBrailleRoleDescription 属性反映了 aria-brailleroledescription 属性的值,该属性定义了元素的 ARIA 盲文角色描述。

此属性可用于提供 aria-roledescription 值的缩写版本。仅当存在 aria-roledescription 且在极少数情况下其对于盲文来说过于冗长时才应使用它。aria-brailleroledescription 包含有关何时应设置该属性的附加信息。

<string>

该值是一个字符串,一种无约束的值类型,旨在转换为盲文。

示例

获取和设置 ariaBrailleRoleDescription

此示例展示了如何获取和设置 ariaBrailleRoleDescription 属性。

HTML

首先,我们定义一个 <article> 元素,该元素将用作幻灯片演示中的幻灯片。我们将 aria-roledescription 属性设置为“slide”,将其在 aria-brailleroledescription 中的盲文缩写设置为“sld”。

html
<article
  id="article"
  aria-roledescription="slide"
  aria-brailleroledescription="sld"
  aria-labelledby="slide1heading">
  <h1 id="slide1heading">Welcome to my talk</h1>
</article>

JavaScript

为了获取元素的角色描述,我们使用 ariaBrailleRoleDescription 属性。下面的代码首先获取然后记录该值。然后,它将盲文角色描述设置为“sd”,并再次记录该值(仅用于说明目的 — 在生产代码中,您不会设置此值)。

js
const article = document.getElementById("article");
log(article.ariaBrailleRoleDescription);
article.ariaBrailleRoleDescription = "sd";
log(article.ariaBrailleRoleDescription);

结果

规范

规范
无障碍富互联网应用程序 (WAI-ARIA)
# dom-ariamixin-ariabrailleroledescription

浏览器兼容性