Axe DevTools for Web の WebdriverIO API リファレンス

コンストラクタ

標準設定では、WebdriverIO コンストラクタに必要な唯一の引数は WebdriverIO インスタンスです。元々含まれているものとは異なる axe-core バージョンやカスタムルールセットを使用したい場合、これらのオプションをコンストラクタに渡すことができます。

AxeDevToolsWebdriverIO(options: Options)

Optionsインターフェースは、以下のプロパティを含むオブジェクトです。

• client（必須）：WebdriverIOクライアント
• axeSource（オプション）：axe-coreソースコードの文字列
• rulesetID（オプション）：ルールセットID（'wcag2'、'wcag2.1'、'wcag2.2'、'wcag2aaa'、'wcag2.1aaa'、'wcag2.2aaa'、'508'、'en301549'、'rgaav4'、'ttv5'）

(<version> をバージョン番号に置き換えてください)。2.1.0 以降のすべての axe-core バージョンがサポートされています。

デフォルトでは、@axe-devtools/webdriverioは、利用可能な最新バージョンのaxe-coreを使用します。別のaxe-coreバージョンを設定するには、axeSourceオプションを渡します。すべてのaxe-coreバージョンは、npmまたはunpkgから取得できます。http://unpkg.com/axe-core@<version>/axe.jsを訪れてください（<version>をバージョン番号に置き換えてください）。axe-coreバージョン2.1.0以降がサポートされています。

指定されたクライアントでデフォルト設定を使用して分析を実行します。戻り値は、axe-core によって返された結果セットを含む約束です。

const axeSource = require('../axe-core-3.5.0').source;
const axeDevTools = new AxeDevToolsWebdriverIO({ client, axeSource });

カスタムルール

Axe DevTools でカスタムルールを使用する方法の詳細は、カスタムルールセットの生成および統合に関するガイドをお読みください

analyze(client: webdriverio.Client): Promise<axe.AxeResults>

指定されたクライアントでデフォルト設定を使用して分析を実行します。Promiseが返され、axe-coreから返された結果セットで解決します。

analyzeUniversal メソッド

Axe DevToolsでカスタムルールを使用する方法については、。既存のメソッドは変更されていません。にあるカスタムルールセットの生成と統合ガイドをお読みください。

Axe DevTools スキャンの範囲を設定するためのいくつかのオプションがあります。特定の CSS スコープを含めたり除外したり、if ムのフレームを無視したりすることができます。下記のコンストラクタのチェーンメソッドによって実現可能です。

分析を実行し、指定された CSS セレクタに一致するフレームに axe-core を注入しないようにします。このメソッドは何度でも呼び出すことができます。で結果を返します。既存のanalyze()メソッドは変更されません。

analyzeUniversal(): Promise<UniversalExport>

exclude

分析から除外するセレクタ。このメソッドは何度でも呼び出すことができます。

ルール設定

AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIO

これらのオプションは選択したルールセットのルール設定を変更します。これらのオプションは標準のルール設定を上書きし、結果を変更します。これらのメソッドでの追加の呼び出しは前回の呼び出しを上書きします。

withRules

AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO

指定したルールのみに分析を制限します。とは併用できません

。

AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIO

withTags

指定したタグのみに分析を制限します。とは併用できません

。

disableRules

AxeDevToolsWebdriverIO.withRules(rules: RuleID[]): AxeDevToolsWebdriverIO

分析を指定されたルールのみに制限します。AxeDevToolsWebdriverIO.withTags()と併用することはできません。

withTags

AxeDevToolsWebdriverIO.withTags(tags: axe.TagValue[]): AxeDevToolsWebdriverIO

分析を指定されたタグのみに制限します。AxeDevToolsWebdriverIO.withRules()と併用することはできません。

disableRules

AxeDevToolsWebdriverIO.disableRules(rules: RuleID[]): AxeDevToolsWebdriverIO

分析を実行する際にスキップするルールのリストを設定します。

axe-core オプション

これらのオプションは基礎となるaxe-coreの設定にアクセスします。これらのオプションについて詳しくは、axe-core ドキュメントをご覧ください。

設定

AxeDevToolsWebdriverIO.configure(config: axe.Spec): AxeDevToolsWebdriverIO

axe-coreの設定を行います。この値は直にaxe.configure()に渡されます。

オプション

AxeDevToolsWebdriverIO.options(runOptions: axe.RunOptions): AxeDevToolsWebdriverIO

runOptionsをaxe.run()に直接渡します。使用方法についてはaxe-core ドキュメントを参照してください。他の設定済みのオプション、AxeDevToolsWebdriverIO.withRules()およびAxeDevToolsWebdriverIO.withTags()への呼び出しを含め、すべて上書きされます。

使用状況サービス

使用状況サービスを利用すると、組織内での Axe DevTools の利用動向を把握できます。

デフォルトでは、使用サービスは無効になっており、デフォルトURLはhttps://usage.deque.comです。

環境変数

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

トラッキングの有効化

このメソッドにより、ユーザーは使用状況サービスへのデータ送信を選択できます

.enableTracking(state: boolean): AxeDevToolsWebdriverIO

トラッキング URL の設定

このメソッドにより、使用状況メトリクスデータの送信先を変更できます

.setTrackingUrl(url: string): AxeDevToolsWebdriverIO

固有 ID の設定

このメソッドにより、保存/使用されている固有 ID を変更できます

.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO