npm 包 jest-axe 使用教程

阅读时长 3 分钟读完

jest-axe 是一个针对 React 应用程序的无障碍测试工具,它使用了 axe-core 库来提供有关应用程序中元素是否符合无障碍标准的报告。在这篇文章中,我们将介绍如何在你的 React 应用程序中使用 jest-axe 进行有效的无障碍测试。

安装 jest-axe

首先,我们需要安装 jest-axe 包。如果你已经使用了 npm,则可以通过以下命令来安装:

npm install --save-dev jest-axe

如果你正在使用 Yarn,则可以使用以下命令进行安装:

yarn add --dev jest-axe

编写测试用例

在你的测试中,你需要导入 jest-axe 包并将其与 jest 包一起使用,以执行无障碍测试。你的测试代码应该遵循 Jest 的常规格式。让我们看一个例子:

-- -------------------- ---- -------
------ ----- ---- --------
------ -------- ---- -------------------------
------ ----- ------------------- ---- -----------
------ ----------- ---- ----------------

----------------------------------

------------ ---------- ----------- -- -- -
  ------------- ---- -- ------------- -------- ----- -- -- -
    ----- ----------- - ------------------- ----
    ----- ------- - ----- ---------------
    -------------------------------------
  ---
---
展开代码

在上面的例子中,我们首先导入了必要的依赖项,然后编写了一个测试代码块。我们使用 render 函数渲染了 MyComponent,并使用了 axe 函数来对其进行测试。此时的 results 对象包含有关组件是否符合无障碍标准的报告。最后,我们使用 Jest 的 expect 函数来检查报告是否没有任何违规之处。

你可以在你的测试中编写任意数量的测试块,以测试你的应用程序的多个部分。

忽略规则和选项

有时,你可能需要在测试中忽略一些特定的无障碍要求。在这种情况下,你可以使用 axe 的配置对象来初始化测试,以包含要忽略的任何特定规则和选项。例如,假设你需要忽略 tabindex-no-positive 规则,则可以执行以下操作:

-- -------------------- ---- -------
----- ------- - -
  ------ -
    ----------------------- - -------- ----- --
  --
--

------------- ---- -- ------------- -------- ----- -- -- -
  ----- ----------- - ------------------- ----
  ----- ------- - ----- -------------- ---------
  -------------------------------------
---
展开代码

结论

无障碍测试对于许多应用程序开发人员来说可能是一个新颖的概念,但它是一个很有价值的实践。使用 jest-axe,我们可以轻松地编写、运行和共享无障碍测试,以确保我们的 React 应用程序符合最佳无障碍原则。这篇文章中的示例代码应该能够让你开始无障碍测试并为你的 React 应用程序添加无障碍支持。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/jest-axe