Cypress-API-Referenz für Axe DevTools für das 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 @axe-devtools/cypress-Paket

Not for use with personal data

Cypress Chainable Commands (analyze)

`cy.axeAnalyze()`

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

Parameter	Typ	Standardwert	Beschreibung
name (optional)	Zeichenkette	nicht definiert	Legt die Kennung für dieses Scan-Ergebnis fest, das im Bericht gespeichert wird. Standardmäßig wird ein Zeitstempel verwendet, wenn keine Angabe erfolgt.
context (optional)	axe.ElementContext	nicht definiert	Definiert den Umfang der Analyse – den Teil des DOM, den Sie analysieren möchten. Dies ist in der Regel das Dokument oder ein bestimmter Selektor wie Klassenname, ID, Selektor usw.
options (optional)	axe.RunOptions	nicht definiert	Satz von Optionen, die in Regeln oder Prüfungen eingebracht werden und diese vorübergehend modifizieren. Dies steht im Gegensatz zu `axe.configure`, das dauerhafter ist.
log (optional)	Boolean	false	Gibt die Ausgabe an stdout mit der Anzahl von Elementen zurück, die nicht zugänglich sind, und den Auswirkungen der Verstöße als Tabelle.

`cy.isAxeClean()`

Dieser verkettbare Befehl ist eine Behauptung, dass die Seite keine Barrierefreiheitsverletzungen aufweist.

Parameter:

Parameter	Typ	Standardwert	Beschreibung
context (optional)	axe.ElementContext	nicht definiert	Definiert den Umfang der Analyse – den Teil des DOM, den Sie analysieren möchten. Dies ist in der Regel das Dokument oder ein bestimmter Selektor wie Klassenname, ID, Selektor usw.
options (optional)	axe.RunOptions	nicht definiert	Satz von Optionen, die in Regeln oder Prüfungen eingebracht werden und diese vorübergehend modifizieren. Dies steht im Gegensatz zu `axe.configure`, das dauerhafter ist.

Cypress Chainable Commands (configuration)

Integrieren Sie Axe DevTools für das Web mit Cypress, indem Sie benutzerdefinierte Cypress-Chainable-Befehle verwenden, um analysierte Ergebnisse zu konfigurieren.

`cy.setAxeSource()`

Dieser verkettbare Befehl legt die Version von axe-core fest.

Parameter	Typ	Standardwert	Beschreibung
Dateipfad (erforderlich)	Zeichenkette	null	Pfad relativ zum Projektstamm, der `axe.source` oder eine minifizierte Version von axe-core enthalten sollte.

`cy.setAxeCustom()`

Dieser verkettbare Befehl ermöglicht die Verwendung von benutzerdefinierten Regelsets.

Axe DevTools for Web Cypress wird auch automatisch axe-ruleset.json lesen, wenn es auf der obersten Ebene des Projekts platziert wird, oder es wird auch benutzerdefinierte Regeldateien verwenden, wenn die Umgebungsvariable AXE_RULESET_PATH gesetzt ist.

Parameter	Typ	Standardwert	Beschreibung
Dateipfad (erforderlich)	Zeichenkette	null	Pfad relativ zum Projektstamm, der Prüfungen und Regeln enthalten sollte

`cy.setAxeRuleset()`

Dieser verkettbare Befehl ermöglicht es den Nutzern, Regeln pro Tags auszuführen, ähnlich wie bei der Konfiguration von axe.run().

Parameter	Typ	Standardwert	Beschreibung
Regelsatz (erforderlich)	'508', 'en301549', 'rgaav4', 'ttv5', 'wcag2', 'wcag2.1', 'wcag2.2', 'wcag2aaa', 'wcag2.1aaa', 'wcag2.2aaa'	'wcag2.1'	Array von Tags, die dieser Regel zugeordnet sind.

`cy.setAxeReportName()`

Dieser verkettbare Befehl ermöglicht es den Benutzern, den Namen der Berichtdatei festzulegen.

Parameter	Typ	Standardwert	Beschreibung
Berichtsname (erforderlich)	Zeichenkette	@axe-devtools-cypress	Name der Berichtdatei.

`cy.getAxeResults()`

Dieser verkettbare Befehl ermöglicht es den Nutzern, die Ergebnisse nach dem Ausführen von cy.axeAnalyze() zu nutzen.

Antworten von getAxeResults() liefern die Datenstruktur axe.AxeResults zurück.

Beispiel:

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

`cy.getUniversalResults()`

Dieser verkettbare Befehl gibt die Ergebnisse des letzten cy.axeAnalyze()-Aufrufs im Axe Universal Format zurück. Gibt null zurück, wenn noch keine Analyse durchgeführt wurde.

Beispiel:

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

Nutzungsdienst

Der Nutzungsdienst ermöglicht es Ihnen, Einblicke in die Nutzungstrends von Axe DevTools für Web innerhalb Ihrer Organisation zu gewinnen.

Umgebungsvariablen

Diese Umgebungsvariablen ermöglichen es Ihnen, den Nutzungsdienst zu konfigurieren und die Eigenschaften der gemeldeten Ereignisse zu ändern.

Name	Typ	Kann überschrieben werden	Beschreibung
`AXE_DISTINCT_ID`	String	—	Ein UUID-Identifikator, der für den angemeldeten Benutzer gleich bleibt (außer er wird neu generiert). In Ruby heißt diese Variable `DEQUE_DISTINCT_ID`.
`AXE_INCLUDE_TEST_RESULTS`	Boolean	—	Setzen Sie `true`, um die vollständigen axe-core-Ergebnisse im `testResults`-Objekt jedes Ereignisses einzuschließen (Standard ist `false`). Wird nur von der CLI und den Node.js-APIs unterstützt.
`AXE_METRICS_URL`	String	—	Die URL des REST-Nutzungsendpunkts (Standard ist `https://usage.deque.com`)
`AXE_TRACK_USAGE`	Boolean	—	Setzen Sie `false`, um das Reporting des Nutzungsdienstes zu deaktivieren. Das Reporting ist standardmäßig aktiviert.
`AXE_APPLICATION`	String	false	Die Anwendung, die verwendet wurde, um Barrierefreiheitsfehler zu überprüfen
`AXE_DEV_INSTANCE`	Boolean	true	Zeigt an, ob dieses Ereignis durch die Aktionen eines Softwareentwicklers entstanden ist. Nützlich zum Markieren und späteren Entfernen von Ereignissen, die während der Entwicklung oder des Testens protokolliert wurden.
`AXE_DEPARTMENT`	String	true	Die Abteilung des Benutzers innerhalb der Organisation
`AXE_KEYCLOAK_ID`	String	false	Die Keycloak-ID des Benutzers
`AXE_LOGGED_IN`	Boolean	false	Zeichnet auf, ob der Benutzer im zu testenden Anwendung angemeldet ist
`AXE_ORGANIZATION`	String	true	Die Organisation des Benutzers. Um Ihre Nutzung in Axe Reports anzuzeigen, setzen Sie dies auf die ID Ihrer Organisation (kontaktieren Sie Deque, um diese zu erhalten).
`AXE_SESSION_ID`	String	false	Ein UUID, das die Sitzung des Benutzers identifiziert
`AXE_USER_ID`	String	false	Die Identität eines bestimmten Benutzers, wie eine E-Mail-Adresse, ein Name oder eine Login-ID. Axe Reports zählt anhand dieses Wertes eindeutige Benutzer.
`AXE_USER_JOB_ROLE`	String	false	Die Rolle des Benutzers im Beruf
`AXE_USER_STATUS`	String	false	Statusinformationen, die Sie mit dem Benutzer verknüpfen möchten

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

Diese Cypress-Aufgabe ermöglicht es den Benutzern, sich dafür zu entscheiden, Daten an den Nutzungsdienst zu senden oder nicht. Das Senden ist standardmäßig aktiviert.

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

Diese Cypress-Aufgabe ermöglicht es Benutzern, zu ändern, wohin die Nutzungsmetriken gesendet werden.

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

Diese Cypress-Aufgabe ermöglicht es Benutzern, die gespeicherte oder verwendete eindeutige ID zu ändern.

Nächste Schritte

Wenn Sie Probleme bei der Installation von Axe DevTools for Web haben, kontaktieren Sie direkt Ihren Deque-Ansprechpartner, fragen Sie uns über unseren Supportdesk oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne beim Starten.