prgfx / neos-axecore
将axe-core无障碍性测试集成到Neos后端UI中
v0.8.1
2023-04-19 17:35 UTC
Requires
- ext-json: *
- neos/neos: ^5.0 || ^7.0 || ^8.0 || dev-master
- neos/neos-ui: ^5.0 || ^7.0 || ^8.0 || dev-master
README
Prgfx.Neos.AxeCore
本软件包将Deque的axe-core无障碍性分析工具集成到Neos检查器中,以便编辑人员快速确定文档中的无障碍性问题。
composer require prgfx/neos-axecore
本软件包的开发由mindscreen GmbH支持。
功能
- 运行当前文档的axe-core分析器,并在检查器中显示无障碍性错误
- 突出显示受影响的DOM节点,如果可用则选择内容元素
- 弹出结果到单独的窗口,以便在修复错误的同时保持错误打开
- 根据用户偏好和axe-core项目提供的翻译进行本地化结果
- 导出结果供开发人员/集成人员使用
配置
axe.run选项
您可以通过设置指定传递给axe.run
的选项
Neos: Neos: Ui: frontendConfiguration: Prgfx.Neos.AxeCore:runOptions: runOnly: type: 'rule' values: ['ruleId1', 'ruleId2', 'ruleId3']
覆盖使用的资源
如果您想使用axe-core库的特定(兼容)版本,您可以覆盖
Prgfx: Neos: AxeCore: script: 'resource://My.Package/Public/Path/To/axe.js' translations: 'resource://My.Package/Private/Path/To/locales/{language}.json'
通过指定不包含{language}
占位符的json,您可以禁用结果的本地化。
功能标志
一些功能可能仍然是实验性的或可能不适用于所有用户。
配置功能标志
功能标志可以根据条件启用、禁用或配置。
Neos: Neos: Ui: frontendConfigurations: Prgfx.Neos.AxeCore:features: feature1: true feature2: false feature3: ${Security.hasRole('Neos.Neos:Administrator')}
可用的功能标志
开发
更新axe-core
在更新axe-core时,请确保更新与该版本一起分发的翻译和分布js。包文件包含两个辅助程序,用于将这些文件复制到相应的目标位置。
cd Resources/Private/JavaScript/AxeCoreView &&\ yarn upgrade axe-core &&\ yarn run export-translations &&\ yarn run export-axejs
注意
为了即插即用,本软件包包含axe-core的构建版本和随它一起分发的区域设置。源代码在GitHub上提供,并采用MPL-2.0许可证。