note

Axe Watcher erfordert einen unterstützten Browser: Chrome für Testing (eine separate Browser-Installation, die sich von Google Chrome unterscheidet), Chromium oder Microsoft Edge. Playwright und Puppeteer verwalten ihre eigenen Browser-Downloads und installieren stets eine Version, die von Axe Watcher unterstützt wird, sodass Sie nichts selbst installieren müssen. Details finden Sie unter Einrichten und Konfigurieren von Browsern für die Verwendung mit Axe Watcher.

  1. Im Stammverzeichnis Ihres Testordners installieren Sie das Paket @axe-core/watcher und alle seine Abhängigkeiten mit npm oder Ihrem bevorzugten Paketmanager (zum Beispiel yarn oder pnpm).

    npm install --save-dev @axe-core/watcher
  2. Importieren Sie in Ihrer Testdatei oder den Testdateien die playwrightConfig()-Funktion, die wrapPlaywright()-Funktion und die PlaywrightController-Klasse von @axe-core/watcher/playwright:

    import {
      wrapPlaywrightPage,
      playwrightConfig,
      PlaywrightController
    } from '@axe-core/watcher/playwright';
  3. In Ihrem Test-Setup-Code (typischerweise in einem before- oder beforeAll-Block) umwickeln Sie vorhandenen Code zum Erstellen einer browserContext-Instanz mit einem Aufruf an playwrightConfig(), während Sie Ihren API-Schlüssel bereitstellen:

    
    const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
    const PROJECT_ID = process.env.PROJECT_ID
    const SERVER_URL = process.env.SERVER_URL
    
    const browserContext: BrowserContext = await chromium.launchPersistentContext(
      /**
       * We set userDataDir to an empty string which saves
       * browser data to a temporary directory
       * @see https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context
       */
      '',
      playwrightConfig({
        axe: {
          apiKey: ACCESSIBILITY_API_KEY,
          projectId: PROJECT_ID,
          serverURL: SERVER_URL
        },
        /**
         * We support both headless and headed mode with Chrome.
         * 
         * For headless mode:
         * - Use '--headless=chrome' for browsers v94-108.
         * - Use '--headless=new' for browsers v109+.
         * 
         * For headed mode:
         * - Remove the '--headless' flag.
         * 
         * @see https://playwright.dev/docs/chrome-extensions#headless-mode
         */
        headless: false,
        args: ['--headless=new']
      })
    );

    Stellen Sie sicher, dass Sie ACCESSIBILITY_API_KEY und PROJECT_ID in Ihrer Umgebung auf Ihren persönlichen API-Schlüssel (zu finden in Ihrem Axe-Konto, im **API-SCHLÜSSEL**-Tab) und Ihre Projekt-ID (angezeigt am oberen Rand dieser Anweisungen, als Sie Ihr Projekt erstellt haben, oder verfügbar auf der Seite „Projekte“ durch Auswahl von **Projekt konfigurieren** unter **Einstellungen**) setzen. Wenn Ihre Organisation eine regionale, private Cloud oder eine lokale Axe Developer Hub-Instanz verwendet, setzen Sie auch SERVER_URL auf die Basis-URL dieser Instanz (zum Beispiel https://axe-eu.deque.com); andernfalls lassen Sie SERVER_URL weg und der Standard https://axe.deque.com wird verwendet.

  4. Sobald Sie eine page-Instanz haben, erstellen Sie eine Instanz der PlaywrightController-Klasse und umwickeln Sie Ihre browserContext:

    // Create a page instance, using your browser context.
    let page = await browserContext.newPage();
    
    // Initialize the PlaywrightController by passing in the Playwright page.
    const controller = new PlaywrightController(page);
    
    // Use the new wrapped Playwright page instance.
    page = wrapPlaywrightPage(page, controller);
  5. Abschließend stellen Sie sicher, dass alle Testergebnisse von Axe Watcher bereinigt werden. Dazu fügen Sie den folgenden Codeblock zu Ihrem Test-Teardown-Code hinzu (typischerweise in einem afterEach Block):

    afterEach(async () => {
      await controller.flush()
    })