Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(html-reporter): make settings and metadata controls keyboard accessible (#42335)

Yury Semikhatsky1586a4d51fcb
diff --git a/packages/html-reporter/src/common.css b/packages/html-reporter/src/common.css
index c67df07e6a..bff639271e 100644
--- a/packages/html-reporter/src/common.css
+++ b/packages/html-reporter/src/common.css
@@ -211,10 +211,23 @@ article, aside, details, figcaption, figure, footer, header, main, menu, nav, se
user-select: none;
}
+button.subnav-item {
+ background: none;
+ font-family: inherit;
+ font-size: inherit;
+ cursor: pointer;
+}
+
.subnav-item:hover {
background-color: var(--color-canvas-subtle);
}
+/* Items overlap by 1px, lift the focused one so that the ring is not clipped by the next one. */
+.subnav-item:focus-visible {
+ outline-color: var(--color-accent-fg);
+ z-index: 1;
+}
+
.subnav-item[aria-selected="true"] {
background: var(--color-control-transparent-bg-hover);
}
diff --git a/packages/html-reporter/src/headerView.spec.ts b/packages/html-reporter/src/headerView.spec.ts
index b63213b1e8..429aba31b3 100644
--- a/packages/html-reporter/src/headerView.spec.ts
+++ b/packages/html-reporter/src/headerView.spec.ts
@@ -37,6 +37,19 @@ test('should render counters', async ({ mount }) => {
`);
});
+test('should open settings with keyboard', async ({ mount }) => {
+ const component = await mount<typeof Default>('headerView/Default');
+ const settings = component.getByRole('button', { name: 'Settings' });
+ const dialog = component.getByTestId('settings-dialog');
+ await settings.focus();
+ await expect(settings).toBeFocused();
+ await expect(dialog).toBeHidden();
+ await settings.press('Enter');
+ await expect(dialog).toBeVisible();
+ await settings.press(' ');
+ await expect(dialog).toBeHidden();
+});
+
test('should toggle filters', async ({ page, mount }) => {
const component = await mount<typeof Default>('headerView/Default');
const filterText = component.getByTestId('filter-text');
diff --git a/packages/html-reporter/src/headerView.tsx b/packages/html-reporter/src/headerView.tsx
index 86e8db0149..f36978d5df 100644
--- a/packages/html-reporter/src/headerView.tsx
+++ b/packages/html-reporter/src/headerView.tsx
@@ -128,24 +128,25 @@ const NavLink: React.FC<{
};
const SettingsButton: React.FC = () => {
- const settingsRef = React.useRef<HTMLDivElement>(null);
+ const settingsRef = React.useRef<HTMLButtonElement>(null);
const [settingsOpen, setSettingsOpen] = React.useState(false);
const [theme, setTheme] = useThemeSetting();
return <>
- <div
- role='button'
+ <button
+ type='button'
ref={settingsRef}
- style={{ cursor: 'pointer' }}
className='subnav-item'
title='Settings'
+ aria-haspopup='dialog'
+ aria-expanded={settingsOpen}
onClick={e => {
setSettingsOpen(!settingsOpen);
e.preventDefault();
}}
onMouseDown={preventDefault}>
{icons.settings()}
- </div>
+ </button>
<Dialog
open={settingsOpen}
diff --git a/packages/html-reporter/src/metadataView.css b/packages/html-reporter/src/metadataView.css
index b91a5e830c..ec30b917eb 100644
--- a/packages/html-reporter/src/metadataView.css
+++ b/packages/html-reporter/src/metadataView.css
@@ -15,11 +15,21 @@
*/
.metadata-toggle {
+ all: unset;
+ box-sizing: border-box;
+ display: inline-flex;
+ align-items: center;
+ border-radius: 4px;
cursor: pointer;
user-select: none;
color: var(--color-fg-default);
}
+.metadata-toggle:focus-visible {
+ outline: 1px solid var(--color-accent-fg);
+ outline-offset: 2px;
+}
+
.metadata-toggle-second-line {
margin-top: 8px;
margin-left: 8px;
diff --git a/packages/html-reporter/src/testFilesView.tsx b/packages/html-reporter/src/testFilesView.tsx
index 84dbc98809..c2d9a087a8 100644
--- a/packages/html-reporter/src/testFilesView.tsx
+++ b/packages/html-reporter/src/testFilesView.tsx
@@ -81,9 +81,14 @@ export const TestFilesHeader: React.FC<{
const isMetadataInTopLine = !showProject && !filteredStats;
const metadataToggleButton = !isMetadataEmpty(report.metadata) && (
- <div className={clsx('metadata-toggle', !isMetadataInTopLine && 'metadata-toggle-second-line')} role='button' onClick={toggleMetadataVisible} title={metadataVisible ? 'Hide metadata' : 'Show metadata'}>
+ <button
+ type='button'
+ className={clsx('metadata-toggle', !isMetadataInTopLine && 'metadata-toggle-second-line')}
+ aria-expanded={metadataVisible}
+ onClick={toggleMetadataVisible}
+ title={metadataVisible ? 'Hide metadata' : 'Show metadata'}>
{metadataVisible ? icons.downArrow() : icons.rightArrow()}Metadata
- </div>
+ </button>
);
const leftSuperHeader = <div className='test-file-header-info'>
diff --git a/tests/playwright-test/reporter-html.spec.ts b/tests/playwright-test/reporter-html.spec.ts
index 96e4e1907b..d282e54708 100644
--- a/tests/playwright-test/reporter-html.spec.ts
+++ b/tests/playwright-test/reporter-html.spec.ts
@@ -1595,6 +1595,41 @@ for (const useIntermediateMergeReport of [true, false] as const) {
`);
});
+ test('should toggle metadata with keyboard', async ({ runInlineTest, writeFiles, showReport, page }) => {
+ test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/42323' });
+ const files = {
+ 'playwright.config.ts': `
+ export default {
+ captureGitInfo: { commit: true },
+ };
+ `,
+ 'example.spec.ts': `
+ import { test, expect } from '@playwright/test';
+ test('sample', async ({}) => { expect(2).toBe(2); });
+ `,
+ };
+ const baseDir = await writeFiles(files);
+ await initGitRepo(baseDir);
+
+ const result = await runInlineTest(files, { reporter: 'dot,html' }, {
+ PLAYWRIGHT_HTML_OPEN: 'never',
+ });
+
+ await showReport();
+
+ expect(result.exitCode).toBe(0);
+ const toggle = page.getByRole('button', { name: 'Metadata' });
+ await toggle.focus();
+ await expect(toggle).toBeFocused();
+ await expect(toggle).toHaveAttribute('aria-expanded', 'false');
+ await toggle.press('Enter');
+ await expect(toggle).toHaveAttribute('aria-expanded', 'true');
+ await expect(page.locator('.metadata-view')).toBeVisible();
+ await toggle.press(' ');
+ await expect(toggle).toHaveAttribute('aria-expanded', 'false');
+ await expect(page.locator('.metadata-view')).toBeHidden();
+ });
+
test('should not include git metadata w/o CI', async ({ runInlineTest, showReport, page }) => {
const result = await runInlineTest({
'playwright.config.ts': `