Verstoß-Screenshots erfassen

Wenn Axe Watcher Barrierefreiheitsverstöße findet, kann es in diesem Moment einen Screenshot der Seite erfassen. Die Screenshots werden in den Axe Developer Hub hochgeladen und können optional in einem lokalen Verzeichnis zur Überprüfung während der Entwicklung gespeichert werden.

Die Bildschirmaufnahme ist für alle JavaScript- und TypeScript-Integrationen (Playwright Test, Cypress, WebdriverIO, WebDriverJS und Puppeteer) sowie beide Java-Integrationen (Selenium und Playwright) verfügbar.

Bildschirmfotos sind automatisch auf der Developer Hub-Problemdetailseite für das betroffene Ergebnis sichtbar, keine zusätzliche Konfiguration ist erforderlich.

Screenshot-Erfassung aktivieren

JavaScript oder TypeScript:

Setzen Sie takeScreenshots: true in Ihrem AxeConfiguration:

axe: {
  takeScreenshots: true
}

Java:

Rufen Sie setTakeScreenshots(true) auf AxeWatcherOptions auf:

AxeWatcherOptions options = new AxeWatcherOptions()
    .setApiKey(System.getenv("ACCESSIBILITY_API_KEY"))
    .setProjectId(System.getenv("PROJECT_ID"))
    .setTakeScreenshots(true);

Screenshots lokal speichern

Sie können Screenshots auch in einem Verzeichnis auf Ihrem lokalen Rechner speichern. Dies ist nützlich, um Verstöße zu überprüfen, während Tests lokal laufen, ohne den Axe Developer Hub zu öffnen.

JavaScript oder TypeScript:

Fügen Sie screenshotDir zu Ihrem AxeConfiguration hinzu:

axe: {
  takeScreenshots: true,
  screenshotDir: './axe-screenshots'
}

Java:

Rufen Sie setScreenshotDir() auf AxeWatcherOptions auf:

AxeWatcherOptions options = new AxeWatcherOptions()
    .setApiKey(System.getenv("ACCESSIBILITY_API_KEY"))
    .setProjectId(System.getenv("PROJECT_ID"))
    .setTakeScreenshots(true)
    .setScreenshotDir("./axe-screenshots");

setScreenshotDir hat keine Wirkung, es sei denn, setTakeScreenshots(true) ist ebenfalls gesetzt. Relative Pfade werden relativ zum Arbeitsverzeichnis der JVM aufgelöst. Wenn das Verzeichnis nicht existiert, erstellt Watcher es. Wenn die Verzeichniserstellung oder das Schreiben der Datei fehlschlägt, wird eine Warnung protokolliert und die Testsuite wird fortgesetzt.

Die Screenshots werden mit folgendem Dateinamensmuster gespeichert: YYYYMMDDTHHmmssSSS-{id}.png. Das Zeitstempel-Präfix hält die Dateien nach Aufnahmezeit sortiert und verhindert Kollisionen, wenn mehrere Screenshots im selben Testrun aufgenommen werden.

Siehe setTakeScreenshots und setScreenshotDir in der Java-API-Referenz für vollständige Parameterdetails.