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

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

cy.axeAnalyze()

このチェーン可能なコマンドは、 axe をすべてのページとiframeに挿入し、 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()

このチェイン可能なコマンドは、最新の cy.axeAnalyze() 呼び出しの結果を Axe Universal Formatで返します。 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担当者に連絡するか、私たちの サポートデスクを通じて質問するか、 メールを送信してください。喜んでお手伝いいたします。