aria-roledescription

aria-roledescription 屬性定義了元素角色的人類可讀、作者本地化的描述。

描述

一些輔助技術 (AT),如螢幕閱讀器,會在使用者體驗中呈現元素的角色。aria-roledescription 屬性提供了一種方法來定義一個不同的、人類可讀的名稱,以供 AT 作為元素的角色呈現。

注意:僅使用 aria-roledescription 來澄清非互動式容器角色的用途,併為小部件提供更具體的描述。

使用者依賴於已知角色名稱的呈現來理解元素的用途,以及如果是小部件,如何與之互動。因此,僅使用 aria-roledescription 來澄清非互動式容器角色(如 groupregion)的用途,併為小部件提供更具體的描述。

aria-roledescription 屬性會覆蓋 AT 如何本地化和表達角色名稱的方式。當您覆蓋使用者理解的角色名稱時,可能會對使用者理解和互動元素的能力產生負面影響。

避免使用 aria-roledescription 屬性。當某個用例顯得特殊,值得使用唯一的 roledescription 時,互動通常可以分解成更小的部分,這些部分具有相關的角色。

當沒有語義或 ARIA 小部件角色對應於您的 Widget 的互動模型時,使用 role="application",使用人類可讀、作者本地化的定製角色名稱提供 aria-roledescription,並使用 aria-describedby 提供使用者說明。

AT 可能會定製和本地化 ARIA 角色的名稱。如果您使用 aria-roledescription 來更改角色名稱呈現給使用者的方式,請記住處理本地化。當頁面被本地化時,值應該被翻譯。

更改角色呈現給使用者的方式不會影響元素的功能。例如,如果元素的角色是 regionbutton,當 AT 提供用於導航到下一個區域或按鈕的功能時,如果您將 aria-roledescription 設定為 continentescape,AT 仍然會允許這些功能導航到區域和按鈕。

再次強調,避免使用 aria-roledescription。在這個例子中,escape 對使用者沒有相關意義,但帶有“escape”標籤的 button 有意義。

使用 aria-roledescription 時,還要確保應用它的元素具有有效的 ARIA role 或具有隱式角色語義,並且值本身不為空且包含的字元不止是空格字元。

使用 aria-brailleroledescription 時,需要 aria-roledescription。請注意,通常,aria-brailleroledescription 僅在 aria-roledescription 在盲文呈現時過於冗長的情況下使用。

示例

以下示例展示了使用 aria-roledescription 來指示非互動式容器是基於 Web 的演示應用程式中的“幻燈片”。

html
<div
  role="article"
  aria-roledescription="slide"
  id="slide"
  aria-labelledby="slideheading">
  <h1 id="slideheading">Quarterly Report</h1>
  <!-- remaining slide contents -->
</div>

在前面的示例中,螢幕閱讀器使用者可能會聽到“季度報告,幻燈片”,而不是不太精確的“季度報告,文章”。

<string>

一個非空字串,一個不受限制的值型別,包含的字元不止是空格。

關聯介面

Element.ariaRoleDescription

ariaRoleDescription 屬性是 Element 介面的一部分,它反映了 aria-roledescription 屬性的值。

ElementInternals.ariaRoleDescription

ariaRoleDescription 屬性是 ElementInternals 介面的一部分,它反映了 aria-roledescription 屬性的值。

關聯角色

所有角色和所有基本標記元素都支援,除了 role="generic"

規範

規範
可訪問的富網際網路應用程式 (WAI-ARIA)
# aria-roledescription

另請參閱