Axe DevTools for Web の WebdriverIO API リファレンス
@axe-devtools/webdriverio パッケージの API リファレンス
コンストラクタ
標準設定では、WebdriverIO コンストラクタに必要な唯一の引数は WebdriverIO インスタンスです。元々含まれているものとは異なる axe-core バージョンやカスタムルールセットを使用したい場合、これらのオプションをコンストラクタに渡すことができます。
非標準の axe-core バージョンを選択することはできません および カスタムルールセット。
AxeDevToolsWebdriverIO(options: Options)インターフェースは以下のプロパティを含むオブジェクトです: Options （必須）：WebdriverIO クライアント
client（オプション）：axe-core のソースコードの文字列axeSource（オプション）：ルールセット ID ('wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa', '508', 'en301549', 'rgaav4', 'ttv5')rulesetID両方を提供することはできません
。この二つは互いに排他的です。 axeSource axe-core バージョンの定義 rulesetIDデフォルトでは、@axe-devtools/webdriverio は利用可能な最新の axe-core バージョンを使用します。異なるバージョンを設定するには、オプションを指定してください。すべての axe-core バージョンは npm から、または unpkg を訪問することで取得できます
(<version> をバージョン番号に置き換えてください)。2.1.0 以降のすべての axe-core バージョンがサポートされています。
テストファイルの親ディレクトリにあるファイルから axe-core 2.3.0 で Axe DevTools WebdriverIO を初期化する例です。 axeSource analyze メソッド http://unpkg.com/axe-core@<version>/axe.js このメソッドは分析を実行し、最終的にアクセシビリティスキャンの結果を返します。
指定されたクライアントでデフォルト設定を使用して分析を実行します。戻り値は、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>CLI ガイド Promise 。
analyzeUniversal メソッド
分析を行い、Axe Universal Format で結果を返します 。既存のメソッドは変更されていません。オプションをチェーンする
Axe DevTools スキャンの範囲を設定するためのいくつかのオプションがあります。特定の CSS スコープを含めたり除外したり、if ムのフレームを無視したりすることができます。下記のコンストラクタのチェーンメソッドによって実現可能です。
disableFrame 指定された CSS セレクタに一致するフレームに axe-core を注入しないようにします。このメソッドは何度でも呼び出すことができます。include analyze() 分析に含めるセレクタ。このメソッドは何度でも呼び出すことができます。
analyzeUniversal(): Promise<UniversalExport>exclude
分析から除外するセレクタ。このメソッドは何度でも呼び出すことができます。
ルール設定
AxeDevToolsWebdriverIO.disableFrame(selector: string): AxeDevToolsWebdriverIOこれらのオプションは選択したルールセットのルール設定を変更します。これらのオプションは標準のルール設定を上書きし、結果を変更します。これらのメソッドでの追加の呼び出しは前回の呼び出しを上書きします。
withRules
AxeDevToolsWebdriverIO.include(selector: string): AxeDevToolsWebdriverIO指定したルールのみに分析を制限します。とは併用できません
。
AxeDevToolsWebdriverIO.exclude(selector: string): AxeDevToolsWebdriverIOwithTags
指定したタグのみに分析を制限します。とは併用できません
。
disableRules
AxeDevToolsWebdriverIO.withRules(rules: RuleID[]): AxeDevToolsWebdriverIOLimit analysis to only the specified rules. Cannot be used with AxeDevToolsWebdriverIO.withTags().
withTags
AxeDevToolsWebdriverIO.withTags(tags: axe.TagValue[]): AxeDevToolsWebdriverIOLimit analysis to only the specified tags. Cannot be used with AxeDevToolsWebdriverIO.withRules().
disableRules
AxeDevToolsWebdriverIO.disableRules(rules: RuleID[]): AxeDevToolsWebdriverIO分析を実行する際にスキップするルールのリストを設定します。
axe-core オプション
これらのオプションは、基盤となる axe-core の設定にアクセスします。これらのオプションの詳細については、 axe-core ドキュメントを参照してください。
設定
AxeDevToolsWebdriverIO.configure(config: axe.Spec): AxeDevToolsWebdriverIOaxe-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です。
環境変数
これらの環境変数を使用すると、使用状況サービスを設定し、報告されるイベントのプロパティを変更できます。
| 名前 | タイプ | 上書き可能 | 説明 |
|---|---|---|---|
AXE_DISTINCT_ID |
文字列 | — | ログイン中のユーザーに対して同一であるUUID識別子（再生成されない限り） |
AXE_METRICS_URL |
文字列 | — | REST使用エンドポイントのURL |
AXE_TRACK_USAGE |
ブール値 | — | 使用サービスレポートを有効にします（デフォルトは false） |
AXE_APPLICATION |
文字列 | false | アクセシビリティエラーのチェックに使用されたアプリケーション |
AXE_DEV_INSTANCE |
ブール値 | true | このイベントがソフトウェア開発者の行動によるものかを示します。開発またはテスト中に記録されたイベントをマークし、後で削除するのに便利です。 |
AXE_DEPARTMENT |
文字列 | true | 組織内でのユーザーの部署 |
AXE_KEYCLOAK_ID |
文字列 | false | ユーザーのKeycloak ID |
AXE_LOGGED_IN |
ブール値 | false | テスト対象アプリケーションにユーザーがログインしているかどうかを記録します |
AXE_ORGANIZATION |
文字列 | true | ユーザーの組織 |
AXE_SESSION_ID |
文字列 | false | ユーザーのセッションを識別するUUID |
AXE_USER_ID |
文字列 | false | 特定のユーザーの名前やログインIDなどのアイデンティティ |
AXE_USER_JOB_ROLE |
文字列 | false | ユーザーの役割 |
AXE_USER_STATUS |
文字列 | false | ユーザーに紐づけたいステータス情報 |
トラッキングの有効化
このメソッドにより、ユーザーは使用状況サービスへのデータ送信を選択できます
.enableTracking(state: boolean): AxeDevToolsWebdriverIOトラッキング URL の設定
このメソッドにより、使用状況メトリクスデータの送信先を変更できます
.setTrackingUrl(url: string): AxeDevToolsWebdriverIO固有 ID の設定
このメソッドにより、保存/使用されている固有 ID を変更できます
.setDistinctId(distinctId: string): AxeDevToolsWebdriverIO