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)	String	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 übergeben werden und diese vorübergehend ändern. Dies steht im Gegensatz zu `axe.configure`, was 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 übergeben werden und diese vorübergehend ändern. Dies steht im Gegensatz zu `axe.configure`, was 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 enthalten sollte `axe.source` oder minifizierte Version von axe-core.

`cy.setAxeCustom()`

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

Axe DevTools für Web Cypress wird auch implizit lesen, axe-ruleset.json wenn es auf der obersten Ebene des Projekts platziert wird, oder es werden auch benutzerdefinierte Regelset-Dateien verwendet, wenn die AXE_RULESET_PATH Umgebungsvariable 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 Benutzern, Regeln pro Tags auszuführen, ähnlich wie bei der Konfiguration 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 Benutzern, die Ergebnisse nach dem Lauf zu nutzen cy.axeAnalyze().

Antworten von getAxeResults() geben die Datenform axe.AxeResults.

Beispiel:

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

`cy.getUniversalResults()`

Dieser verkettbare Befehl gibt die Ergebnisse des jüngsten cy.axeAnalyze() -Aufrufs zurück im Axe Universal Format. 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 (es sei denn, er wird neu generiert)
`AXE_METRICS_URL`	String	—	Die URL des REST-Nutzungsendpunktes
`AXE_TRACK_USAGE`	Boolean	—	Aktiviert die Berichtserstattung über den Nutzungsdienst (Standard ist `false`)
`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
`AXE_SESSION_ID`	String	false	Ein UUID, das die Sitzung des Benutzers identifiziert
`AXE_USER_ID`	String	false	Eine spezifische Benutzeridentität wie Name oder Login-ID
`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 Benutzern, der Datenübermittlung an den Nutzungsdienst zuzustimmen.

`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 irgendwelche Probleme bei der Installation von Axe DevTools für Web haben, wenden Sie sich direkt an Ihren Deque-Ansprechpartner, fragen Sie uns über unseren Supportdesk, oder senden Sie uns eine E-Mail. Wir helfen Ihnen gerne, schnellstmöglich einsatzbereit zu sein.