@文字新闻/a11y

WordPress的辅助工具。

安装

安装模块

npm install@wordpress/a11y--保存

此包假定您的代码将在2015年欧洲标准+环境。如果您使用的环境对此类语言功能和API的支持有限或不支持,您应该包括polyfill发货@wordpress/babel预设在代码中。

美国石油学会

设置

创建活动区域。

说话

允许您使用ARIA活动区域轻松向屏幕阅读器宣布动态界面更新。本模块的灵感来自说话中的函数wp-a11y.js文件.

用法

从“@wordpress/a11y”导入{speak};//对于不应打断屏幕阅读器当前发布内容的礼貌消息。说话(“您想要发送到ARIA实时区域的消息”);//对于应该中断屏幕阅读器当前发布内容的断言消息。说话(“您想要发送到ARIA活动区域的消息”,“果断”);

参数

  • 消息 一串:将由辅助技术发布的消息。
  • ariaLive公司 ['polite'|'assertive']:咏叹调的礼貌水平;默认值:“polite”。

背景

我引用上下文WordPress.org上的这篇文章通过@乔多尔森:

为什么?

在现代web开发中,使用JavaScript更新屏幕的离散区域很常见。AJAX响应在现代基于JavaScript的用户界面中的使用允许web开发人员创建类似于桌面应用程序的漂亮界面,这些界面不需要重新加载或刷新页面。

JavaScript可以为大多数用户带来巨大的可用性改进,但当内容动态更新时,它可能会带来可访问性问题。这是您可以采取的处理该问题的步骤之一。

什么。

当用JavaScript更新页面的一部分时,更新通常用动画和明亮的颜色突出显示,并且很容易看到。但如果你无法看到屏幕,你就不知道发生了什么,除非更新后的区域被标记为ARIA实时区域。

如果没有标记,则不会通知屏幕阅读器。但是,如果ARIA活动区域太大,也有可能在更新后公布所有区域内容。您只想为用户提供一条简单、简洁的消息。

怎样。

就是这样wp.a11y.speak()是为了。这是一个简单的工具,可以创建ARIA实时通知区域,并将其附加到开发人员可以发送文本消息的元素中。辅助技术将自动宣布此区域中的任何文本更改。这个ARIA活动区域具有ARIA的“地位”角色,因此它具有礼貌的隐变量值和true的隐变量原子值。

这意味着辅助技术将通知用户更新,但通常不会中断当前任务,并且更新优先级较低。如果您正在创建具有更高优先级更新的应用程序(例如,通知他们的当前会话即将到期),那么您将需要创建一个aria-live值为assertive的方法。

浏览器支持

请参见https://make.wordpress.org/core/handbook/best-practices/browser-support/

参与此包

这是古腾堡项目的一部分。该项目组织为单回购。它由多个独立的软件包组成,每个包都有特定的用途。此monorepo中的包发布到净现值法并由使用WordPress(文字出版社)以及其他软件项目。

要了解更多关于对这个包或古腾堡整体贡献的信息,请阅读该项目的主要内容贡献者指南.