Instructies voor Playwright en TypeScript
Uw tests configureren met Playwright en TypeScript
-
Installeer op het hoofdniveau van je testmap het
@axe-core/watcherpakket en al zijn afhankelijkheden met behulp vannpmof je voorkeurspakketmanager (bijvoorbeeld,yarnofpnpm).npm install --save-dev @axe-core/watcher -
Importeer in uw testbestand of -bestanden de
playwrightConfig()functie, dewrapPlaywright()functie, en dePlaywrightControllerklasse uit@axe-core/watcher/playwright:import { wrapPlaywrightPage, playwrightConfig, PlaywrightController } from '@axe-core/watcher/playwright'; -
In uw testopzetcode (meestal in een
beforeofbeforeAllblok), omring alle bestaande code voor het maken van eenbrowserContextinstantie met een oproep naarplaywrightConfig(), terwijl u uw API-sleutel opgeeft:const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY const PROJECT_ID = process.env.PROJECT_ID 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 }, /** * 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'] }) );Zorg ervoor dat u
ACCESSIBILITY_API_KEYenPROJECT_IDin uw omgeving instelt op uw persoonlijke API-sleutel (te vinden in uw axe-account, **API-SLEUTELS** tab) en uw project-ID (weergegeven bovenaan deze instructies toen u uw project aanmaakte of beschikbaar op de projectpagina door te kiezen voor **Project configureren** onder **Instellingen**). -
Zodra u een
pageinstantie heeft, maak een instantie van dePlaywrightControllerklasse en omring uwbrowserContext:// 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); -
Zorg er ten slotte voor dat alle testresultaten van axe Watcher worden verwerkt. Voeg hiervoor het volgende codeblok toe aan uw testopruimcode (meestal in een
afterEachblok):afterEach(async () => { await controller.flush() })
