mcpField
P
playwright-testing

playwright-testing

github.com/community-accessTesting & quality431316 installsUpdated 1d ago
Repository

About playwright-testing

A reusable Playwright accessibility testing guide for teams testing web pages. It covers keyboard behavior, dynamic states, viewports, contrast, and accessibility trees, with @axe-core/playwright patterns and test templates.

Key features

  1. 01Keyboard order and trap checks
  2. 02Post-interaction state scans
  3. 03Viewport and touch-target checks
  4. 04Computed-style contrast scans
  5. 05Browser accessibility tree snapshots

Use cases

  1. 01Check keyboard navigation and focus handling
  2. 02Test content revealed by dialogs or accordions
  3. 03Run accessibility tests in CI

MCP support

The README lists MCP tools for keyboard, state, viewport, contrast, and accessibility-tree scans. Some scans require @axe-core/playwright.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/community-access/accessibility-agents --skill playwright-testing

After installing, type/playwright-testingin Claude Code to confirm it loaded.

Details

From the project README

Playwright Accessibility Testing

Reusable knowledge module for browser-based accessibility testing using Playwright and @axe-core/playwright.

MCP Tools Available

ToolPurposeRequires @axe-core/playwright
run_playwright_keyboard_scanTab-order traversal, keyboard trap detectionNo
run_playwright_state_scanClick triggers, scan revealed content with axe-coreYes
run_playwright_viewport_scanMulti-viewport axe-core + touch target measurementYes
run_playwright_contrast_scanComputed-style contrast ratio after CSS cascadeNo
run_playwright_a11y_treeBrowser accessibility tree snapshotNo

@axe-core/playwright Patterns

Full Page Scan
import AxeBuilder from '@axe-core/playwright';

const results = await new AxeBuilder({ page })
  .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'wcag22aa'])
  .analyze();
Scoped Element Scan
const results = await new AxeBuilder({ page })
  .include('.modal-content')
  .withTags(['wcag2a', 'wcag2aa'])
  .analyze();
Single Rule Verification
const results = await new AxeBuilder({ page })
  .include('#hero-image')
  .withRules(['image-alt'])
  .analyze();
expect(results.violations).toEqual([]);
Scan After Interaction
await page.click('[aria-expanded="false"]');
await page.waitForSelector('.accordion-content', { state: 'visible' });
const results = await new AxeBuilder({ page })
  .include('.accordion-content')
  .analyze();

Keyboard Traversal Patterns

Record Tab Sequence
const tabStops = [];
for (let i = 0; i < maxTabs; i++) {
  await page.keyboard.press('Tab');
  const info = await page.evaluate(() => {
    const el = document.activeElement;
    return {
      tagName: el?.tagName,
      role: el?.getAttribute('role'),
      name: el?.getAttribute('aria-label') || el?.textContent?.trim().slice(0, 50),
      id: el?.id,
      tabIndex: el?.tabIndex
    };
  });
  tabStops.push(info);
}
Detect Keyboard Traps

A keyboard trap is detected when the same element receives focus after consecutive Tab presses:

let trapCount = 0;
let lastSelector = '';
for (const stop of tabStops) {
  const currentSelector = `${stop.tagName}#${stop.id}`;
  if (currentSelector === lastSelector) {
    trapCount++;
    if (trapCount >= 3) { /* TRAP DETECTED */ }
  } else {
    trapCount = 0;
  }
  lastSelector = currentSelector;
}
Focus Management After Modal Open
await page.click('[data-modal-trigger]');
await page.waitForSelector('[role="dialog"]', { state: 'visible' });
const focusedRole = await page.evaluate(() =>
  document.activeElement?.closest('[role="dialog"]') ? 'inside-dialog' : 'outside-dialog'
);
// focusedRole should be 'inside-dialog'

Focus Management Test Templates

Modal Focus Trap Test
test('modal traps focus correctly', async ({ page }) => {
  await page.goto(url);
  await page.click('[data-open-modal]');
  await page.waitForSelector('[role="dialog"]', { state: 'visible' });

  // Focus should be inside the dialog
  const inDialog = await page.evaluate(() =>
    document.activeElement?.closest('[role="dialog"]') !== null
  );
  expect(inDialog).toBe(true);

  // Tab through dialog — should not escape
  for (let i = 0; i < 20; i++) {
    await page.keyboard.press('Tab');
    const stillInDialog = await page.evaluate(() =>
      document.activeElement?.closest('[role="dialog"]') !== null
    );
    expect(stillInDialog).toBe(true);
  }

  // Escape should close and return focus to trigger
  await page.keyboard.press('Escape');
  const focusedId = await page.evaluate(() => document.activeElement?.id);
  expect(focusedId).toBe('modal-trigger-id');
});
Skip Link Test
test('skip link moves focus to main content', async ({ page }) => {
  await page.goto(url);
  await page.keyboard.press('Tab'); // Focus skip link
  await page.keyboard.press('Enter'); // Activate it
  const focusedId = await page.evaluate(() => document.activeElement?.id);
  expect(focusedId).toBe('main-content');
});

CI Integration

GitHub Actions with Playwright
name: Accessibility Tests
on: [push, pull_request]

jobs:
  a11y:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npx playwright install --with-deps chromium
      - name: Start dev server
        run: npm run dev &
        env:
          CI: true
      - name: Wait for server
        run: npx wait-on http://localhost:3000 --timeout 30000
      - name: Run accessibility tests
        run: npx playwright test tests/a11y/
      - uses: actions/upload-artifact@v4
        if: failure()
        with:
          name: a11y-test-results
          path: test-results/
Playwright Config for Accessibility Tests
// playwright.config.js (a11y section)
export default {
  testDir: './tests/a11y',
  use: {
    baseURL: process.env.BASE_URL || 'http://localhost:3000',
    // Use Chromium only — @axe-core/playwright is Chromium-validated
    browserName: 'chromium',
  },
  webServer: {
    command: 'npm run dev',
    url: 'http://localhost:3000',
    reuseExistingServer: !process.env.CI,
  },
};

Graceful Degradation

Detection Pattern
let _playwrightAvailable = null;
async function isPlaywrightAvailable() {
  if (_playwrightAvailable !== null) return _playwrightAvailable;
  try {
    await import('playwright');
    _playwrightAvailable = true;
  } catch {
    _playwrightAvailable = false;
  }
  return _playwrightAvailable;
}
Degradation Matrix
Playwright@axe-core/playwrightAvailable Scans
YesYesAll 5 tools (keyboard, state, viewport, contrast, tree)
YesNo3 tools (keyboard, contrast, tree)
No—None — fall back to code review + axe-core CLI
User-Facing Messages

When unavailable:

Playwright not installed. Behavioral testing (keyboard traversal, dynamic states,
responsive viewport, rendered contrast) is unavailable.

Install: npm install -D playwright @axe-core/playwright && npx playwright install chromium

When partially available:

@axe-core/playwright not installed. State scanning and viewport scanning are
unavailable. Keyboard, contrast, and accessibility tree scans will proceed.

Install: npm install -D @axe-core/playwright

WCAG Coverage Map

WCAG SCDescriptionPlaywright Tool
1.3.1Info and Relationshipsa11y tree, state scan
1.4.3Contrast (Minimum)contrast scan
1.4.6Contrast (Enhanced)contrast scan
1.4.10Reflowviewport scan
2.1.1Keyboardkeyboard scan
2.1.2No Keyboard Trapkeyboard scan
2.4.3Focus Orderkeyboard scan
2.4.7Focus Visiblekeyboard scan
2.5.5Target Size (Enhanced)viewport scan
2.5.8Target Size (Minimum)viewport scan
4.1.2Name, Role, Valuea11y tree, state scan

Comments

Markdown supported