ウェブ用Axe DevToolsのCypress APIリファレンス

Cypressのチェーン可能なコマンド（分析）

cy.axeAnalyze()

このチェーン可能なコマンドは、すべてのページとiframeにaxeを注入し、その後ページ上でaxeを実行します。

cy.isAxeClean()

このチェーン可能なコマンドは、ページにアクセシビリティの違反がないことを確認するためのアサーションです。

パラメータ：

Cypressのチェーン可能なコマンド（設定）

CypressとAxe DevTools for Webを統合し、カスタムのCypressのチェーン可能なコマンドを使用して分析結果を設定します。

cy.setAxeSource()

このチェーン可能なコマンドは、axe-coreのバージョンを設定します。

cy.setAxeCustom()

このチェイン可能なコマンドでは、カスタムのルールセットを使用できます。

• Axe DevTools for Web Cypressは、axe-ruleset.jsonがプロジェクトのルートレベルに配置された場合、暗黙的に読み取るか、AXE_RULESET_PATH環境変数が設定されている場合、カスタムルールセットファイルを利用します。

cy.setAxeRuleset()

このチェーン可能なコマンドを使用すると、axe.run()の設定に似た形でタグごとにルールを実行できます。

cy.setAxeReportName()

このチェイン可能なコマンドでは、レポートファイルの名前を設定できます。

cy.getAxeResults()

このチェーン可能なコマンドは、cy.axeAnalyze()を実行した後の結果を利用できるようにします。

getAxeResults()からの応答はデータ形状axe.AxeResultsを返します。

例：

after(() => {
  cy.axeAnalyze();
  cy.getAxeResults().then(data => {
    cy.writeFile('./results.json', data)
  })
})

cy.getUniversalResults()

このチェーン可能なコマンドは、Axe Universal Format内の最後にcy.axeAnalyze()コールの結果を返します。まだ分析が行われていない場合はnullを返します。

例：

after(() => {
  cy.axeAnalyze();
  cy.getUniversalResults().then(data => {
    cy.writeFile('./results-universal.json', data)
  })
})

使用サービス

使用サービスは、組織内でのAxe DevTools for Webの利用傾向を洞察することを可能にします。

環境変数

これらの環境変数を使用すると、使用サービスを構成し、報告されたイベントのプロパティを変更することができます。

cy.task('enableTracking', <boolean>)

このCypressタスクは、ユーザーが使用サービスにデータを送信することを選択することを可能にします。

cy.task('setTrackingUrl', <string>)

このCypressタスクは、使用状況メトリクスデータの送信先を変更することを可能にします。

cy.task('setDistinctId', <string>)

このCypressタスクは、保存または使用される固有のIDを変更することを可能にします。

次のステップ

Axe DevTools for Webのインストールに問題がある場合は、直接Deque担当者に連絡するか、サポートデスク経由で私たちにご質問ください、またはメールを送信。セットアップをお手伝いさせていただきます。