npm 包 @theintern/a11y 使用教程

阅读时长 4 分钟读完

前言

随着互联网的不断发展,许多用户可能需要使用辅助技术才能访问您的网站或应用程序。为了确保所有用户都能正常地访问您的 Web 应用程序,必须进行一些无障碍性测试。@theintern/a11y 是一个Node.js包,它对Web应用程序进行无障碍性测试。

使用介绍

安装

你可以通过 npm 来安装 @theintern/a11y:

使用

让我们看看如何使用这个包来测试你的应用。以下是一个简单的测试:

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

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

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

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

这是一个基本实现,但是这段代码会直接输出测试结果的原始格式,非常难阅读。因此,您可以通过安装任何可用的引擎(如jsonlint,axe等)来过滤结果。

参数

这个 npm 包可以接受多个参数,来满足不同的测试需求。以下是相关参数的介绍:

url

这个参数指定了需要测试的网站URL地址。该参数是必须的。

axe

这个参数用于指定测试类型。如果指定,则会使用axe引擎执行测试,否则将使用默认的tae引擎。

html

这个参数使用HTML格式来输出测试结果,在部署时通常需要。

reporter

这个参数用于输出不同的测试报告。该参数有多种可选的值,包括Json、Text、Xunit和html。

示例

回到我们的测试代码,现在我们来尝试一个简单例子:

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

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

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

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

运行测试后,我们会得到一个a11y.json文件,其中包含所有的测试结果的摘要。

总结

现在您已经了解了如何使用@theintern/a11y 来测试您的网站或应用程序的无障碍性。希望这篇文章对您有所帮助,并能够提高您的无障碍性测试工作的效率。如果您有任何问题或疑问,请随时向我或我们的社群提问。

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

纠错
反馈