WebDriverJS API-Referenz für axe DevTools

Konstruktor

In der Standardkonfiguration ist das einzige Argument, das an den axe DevTools-Konstruktor übergeben werden muss, die WebDriverJS-Instanz. Wenn Sie eine andere Axe-Core-Version als die ursprünglich enthaltene oder einen benutzerdefinierten Regelsatz verwenden möchten, können Sie diese Optionen an den Konstruktor übergeben.

axe DevTools WebDriverJS-Konstruktor:

AxeDevToolsBuilder(driver:WebDriver, String:ruleset|Object:axe (optional))

Sie müssen als erstes Argument eine Instanz eines Selenium WebDriver übergeben. Das zweite optionale Argument kann entweder eine Regelsatz-ID oder ein axe Objekt sein. Wenn Sie kein zweites Argument angeben, müssen Sie die benutzerdefinierte Regelkonfigurationsdatei @axe-devtools/script-builder konfigurieren. Andernfalls löst die Konstruktorfunktion eine Ausnahme aus.

Die folgenden Beispiele zeigen, wie der Konstruktor verwendet wird:

// instantiate with the Section 508 rule set
const builder = new AxeDevToolsBuilder(driver, '508');

// or with a specific axe instance
const axe = require('../axe-core-2.3.0');
const builder = new AxeDevToolsBuilder(driver, axe);

Benutzerdefinierte Regeln

Informationen zur Verwendung benutzerdefinierter Regeln mit axe DevTools for Web finden Sie im Handbuch zur Generierung und Integration benutzerdefinierter Regelsätze im CLI-Handbuch.

analysieren

Die analyze() Methode führt die Analyse aus und gibt die Ergebnisse des Barrierefreiheitsscans zurück.

analyze(): Promise<axe.AxeResults>

Führen Sie eine Analyse mit der Standardkonfiguration auf dem angegebenen Client aus. Es wird ein Promise zurückgegeben, der mit dem von axe-core zurückgegebenen Ergebnissatz zur Barrierefreiheit übereinstimmt.

Verkettungsoptionen

Für die Eingrenzung Ihrer axe DevTools-Scans stehen Ihnen zwei Optionen zur Verfügung. Sie können bestimmte CSS-Bereiche ein- oder ausschließen. Die Kettenmethoden (unten) des Konstruktors machen dies möglich.

beinhaltet

new AxeDevToolsBuilder(driver).include('<CSS-Selector>');

Fügt der Liste der in die Analyse einzubeziehenden Elemente einen CSS-Selektor hinzu. Elemente außerhalb des an include() übergebenen Bereichs werden nicht gescannt.

ausschließen

new AxeDevToolsBuilder(driver).exclude('<CSS-Selector>');

Fügen Sie der Liste der Elemente, die von der Analyse ausgeschlossen werden sollen, einen CSS-Selektor hinzu. Es werden nur Elemente außerhalb des Bereichs, der an exclude() übergeben wurde, gescannt.

Diese Methoden können verkettet werden, um den Scan-Umfang weiter einzugrenzen, wie unten gezeigt:

new AxeDevToolsBuilder(driver).include('<CSS-Selector>').exclude('<Inner-CSS-Selector>');

In diesem Beispiel würden alle Elemente innerhalb von <CSS-Selector> gescannt, mit Ausnahme der Elemente innerhalb von <Inner-CSS-Selector>.

Regelkonfiguration

Die Methoden der Regelkonfiguration überschreiben die Standardregelkonfiguration. Zusätzliche Aufrufe mit diesen Methoden überschreiben vorherige Aufrufe.

mitRegeln

Die withRules() Methode beschränkt die Analyse auf nur die Regeln mit den angegebenen Regel-IDs. Es akzeptiert eine Zeichenfolge für eine einzelne Regel-ID oder ein Array aus mehreren Regel-IDs.

Diese Beispiele zeigen die Verwendung withRules mit einer einzelnen Regel-ID und einem Array von Regel-IDs:

//with a single rule ID
AxeDevToolsBuilder(driver).withRules('html-lang');

//with an array of rule IDs
AxeDevToolsBuilder(driver).withRules(['html-lang', 'image-alt']);

MitTags

Die withTags() Methode beschränkt die Analyse auf nur die Regeln, die mit dem bereitgestellten Tag verknüpft sind. Akzeptiert ein einzelnes Tag oder ein Array von Tags, wie unten gezeigt:

//with a single tag
AxeDevToolsBuilder(driver).withTags('wcag2a');

//with an array of tags
AxeDevToolsBuilder(driver).withTags(['wcag2a', 'wcag2aa']);

Regeln deaktivieren

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

Die disableRules() Methode bewirkt, dass das bereitgestellte Regel-Array beim Ausführen einer Analyse übersprungen wird.

axe-core-Optionen

Optionen

.options(options: Axe.RunOptions)

Die Methode options gibt die von axe.run zu verwendenden Optionen an. Dadurch werden alle anderen konfigurierten Optionen überschrieben, einschließlich Aufrufe von withRules und withTags. Weitere Informationen finden Sie in der axe-core API-Dokumentation .

new AxeDevToolsBuilder(page).options({
  checks: { 'valid-lang': ['orcish'] }
});

konfigurieren

.configure(config: Axe.Spec)

Die configure Methode fügt ein Axe-Konfigurationsobjekt ein, um den Regelsatz vor einer Analyse zu ändern. Nachfolgende Aufrufe dieser Methode machen vorherige Aufrufe ungültig, indem sie axe.configure() aufrufen und das Konfigurationsobjekt ersetzen. Informationen zur Struktur des Objekts finden Sie in der axe-core API-Dokumentation .

Das folgende Beispiel erstellt eine neue Axe-Core-Konfiguration und übergibt sie zur Verwendung beim Scannen an die axe DevTools:

const config = {
  checks: [Object],
  rules: [Object]
};
const results = await new AxeDevToolsBuilder(page).configure(config).analyze();

Usage Service

Standardmäßig ist der Nutzungsdienst deaktiviert und die Standard-URL lautet https://usage.deque.com.

Umgebungsvariablen

Mit dieser Methode können Benutzer bestimmte Werte des Nutzungsdienstes über Umgebungsvariablen ändern.

Tracking aktivieren

Bei dieser Methode können Benutzer sich dafür entscheiden, Daten an den Nutzungsdienst zu senden.

.enableTracking(state: boolean)

AxeDevToolsBuilder(driver).enableTracking(true)

setTrackingUrl

Mit dieser Methode können Benutzer ändern, wohin die Nutzungsdaten gesendet werden.

.setTrackingUrl(url: string)

AxeDevToolsBuilder(driver).setTrackingUrl('https://foobar.biz')

setDistinctId

Mit dieser Methode können Benutzer die gespeicherte oder verwendete eindeutige ID ändern.

.setDistinctId(distinctId: string)

AxeDevToolsBuilder(driver).setDistinctId('foobar')