一个屏幕阅读器 Storybook 插件

在 Github 上查看

Storybook 屏幕阅读器插件

Storybook Demo NPM Version Known Vulnerabilities Security Score Pipeline status Netlify Status

在 Storybook 的插件面板中显示自定义屏幕阅读器的插件。允许开发人员快速测试其可访问性,无需外部屏幕阅读器或复杂程序。

它允许为语音和文本提供单独的输出。

免责声明

这是一个起步项目,有很多需要改进的地方。

仅涵盖了屏幕阅读器和键盘导航的一些用例,并且不打算替代使用真实屏幕阅读器进行的完整测试。

这是一个个人项目,在我改进可访问性方面知识的同时,帮助我深入了解屏幕阅读器的运作方式,而没有比自己尝试构建一个更好的方法,对吧?

安装

就像任何普通的 NPM 包一样。

作为开发依赖项安装

npm install -d addon-screen-reader

yarn add -dev addon-screen-reader

将插件添加到您的插件文件中(通常为 .storybook/main.js

module.exports = {
  addons: ['addon-screen-reader'],
};

使用

  • 运行项目的 Storybook。
  • 导航到新的“屏幕阅读器”选项卡。
  • 启用语音/文本选项。
  • 使用 Alt + Tab 或 Option + Tab 浏览页面。

演示

此项目的 CI 集成在 Netlify 上部署了一个演示 Storybook,因此您可以自己查看。

演示

反馈

欢迎所有反馈!您可以在存储库中创建任何问题,我将尽快与您联系。

贡献

您想贡献?太棒了!

只需分叉此项目并打开一个 PR,我将在您需要时提供帮助。