Cypress API-Referenz für axe DevTools for Web

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Referenz für die APIs im Paket @axe-devtools/cypress

Not for use with personal data

Cypress Chainable Commands (analyze)

`cy.axeAnalyze()`

Dieser verkettbare Befehl fügt axe in alle Seiten und iframes ein und führt dann axe auf der Seite aus.

Parameter	Art	Standardwert	Beschreibung
Kontext (optional)	axe.ElementContext	undefiniert	Definiert den Umfang der Analyse – den Teil des DOM, den Sie analysieren möchten. Dies ist normalerweise das Dokument oder ein bestimmter Selektor wie Klassenname, ID, Selektor usw.
Optionen (optional)	axe.RunOptions	undefiniert	Satz von Optionen, die an Regeln oder Checks übergeben werden, die diese vorübergehend modifizieren. Dies steht im Gegensatz zu `axe.configure`, das dauerhafter ist.
Protokoll (optional)	Boolescher Wert	false	Gibt die Ausgabe mit der Anzahl der nicht zugänglichen Elemente und den Auswirkungen von Verstößen als Tabelle auf stdout aus.

`cy.isAxeClean()`

Dieser verkettbare Befehl ist eine Behauptung, dass die Seite keine Zugänglichkeitsverletzungen aufweist.

Parameter:

Parameter	Art	Standardwert	Beschreibung
Kontext (optional)	axe.ElementContext	undefiniert	Definiert den Umfang der Analyse – den Teil des DOM, den Sie analysieren möchten. Dies ist normalerweise das Dokument oder ein bestimmter Selektor wie Klassenname, ID, Selektor usw.
Optionen (optional)	axe.RunOptions	undefiniert	Satz von Optionen, die an Regeln oder Checks übergeben werden, die diese vorübergehend modifizieren. Dies steht im Gegensatz zu `axe.configure`, das dauerhafter ist.

Cypress Chainable Commands (configuration)

Integrieren Sie axe DevTools for Web mit Cypress, indem Sie benutzerdefinierte, verkettbare Cypress-Befehle verwenden, um analysierte Ergebnisse zu konfigurieren.

`cy.setAxeSource()`

Dieser verkettbare Befehl legt die Version von axe fest.

Parameter	Art	Standardwert	Beschreibung
Dateipfad (erforderlich)	String	null	Pfad relativ zur Wurzel des Projekts, der eine `axe.source` oder minimierte Version von Axe einschließen sollte.

`cy.setAxeCustom()`

Dieser verkettbare Befehl ermöglicht die Verwendung benutzerdefinierter Regelsätze.

axe DevTools für Web Cypress wird auch implizit lesen axe-ruleset.json , wenn es auf der Wurzelebene des Projekts platziert wird, oder es wird auch benutzerdefinierte Regelsatzdateien verwenden, wenn die Umgebungsvariable AXE_RULESET_PATH festgelegt ist.

Parameter	Art	Standardwert	Beschreibung
Dateipfad (erforderlich)	String	null	Pfad relativ zur Wurzel des Projekts, der Prüfungen und Regeln enthalten soll

`cy.setAxeRuleset()`

Mit diesem verkettbaren Befehl können Benutzer Regeln pro Tag ausführen, ähnlich wie bei der Konfiguration axe.run().

Parameter	Art	Standardwert	Beschreibung
Regelsatz (erforderlich)	'508', 'en301549', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	'wcag2.1'	Array von Tags, denen diese Regel zugewiesen ist.

`cy.setAxeReportName()`

Mit diesem verkettbaren Befehl können Benutzer den Namen der Berichtsdatei festlegen.

Parameter	Art	Standardwert	Beschreibung
Berichtsname (erforderlich)	String	@axe-devtools-cypress	Name der Berichtsdatei.

`cy.getAxeResults()`

Dieser verkettbare Befehl ermöglicht es Benutzern, die Ergebnisse nach der Ausführung von cy.axeAnalyze()[Befehl oder Funktion] zu nutzen.

Antworten von getAxeResults() gibt die Datenform axe.AxeResults zurück.

Beispiel:

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

Usage Service

Mit dem Nutzungsdienst können Sie Einblicke in die Nutzungstrends von axe DevTools for Web in Ihrer Organisation gewinnen.

Umgebungsvariablen

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

Umgebungsvariable	Art
AXE_IS_LOGGED_IN	Boolescher Wert
AXE_KEYCLOAK_ID	String
AXE_USER_ID	String
AXE_SESSION_ID	String
AXE_BENUTZER_STATUS	String
AXE_BENUTZER_JOB_ROLLE	String
AXE_DISTINCT_ID	String
AXE_IS_DEV_INSTANCE	Boolescher Wert
AXE_ORGANISATION	String
AXE_ANWENDUNG	String
AXE_METRICS_URL	String
AXE_TRACK_VERWENDUNG	Boolescher Wert

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

Mit dieser Cypress-Aufgabe können Benutzer entscheiden, ob sie Daten an den Nutzungsdienst senden möchten.

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

Mit dieser Cypress-Aufgabe können Benutzer ändern, wohin die Nutzungsmetrikdaten gesendet werden.

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

Mit dieser Cypress-Aufgabe können Benutzer die gespeicherte oder verwendete eindeutige ID ändern.

Nächster Schritt

Wenn bei der Installation von axe DevTools for Web Probleme auftreten, wenden Sie sich direkt an Ihren Deque-Vertreter, fragen Sie uns über unseren Support-Desk oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne beim Einstieg.