🚸(frontend) improve keyboard navigation
- add css rules to highlight focused-visible navigable elements - update drop down components to make it keyboard navigable - add e2e keyboard navigation tests asserting it navigates through all focusable elements from top to bottom on groups index view when one group exists
This commit is contained in:
committed by
Sebastien Nobour
parent
779c7d1e0e
commit
7e03d33be0
@@ -2,10 +2,11 @@ import React, {
|
|||||||
PropsWithChildren,
|
PropsWithChildren,
|
||||||
ReactNode,
|
ReactNode,
|
||||||
useEffect,
|
useEffect,
|
||||||
|
useRef,
|
||||||
useState,
|
useState,
|
||||||
} from 'react';
|
} from 'react';
|
||||||
import { Button, DialogTrigger, Popover } from 'react-aria-components';
|
import { Button, DialogTrigger, Popover } from 'react-aria-components';
|
||||||
import styled from 'styled-components';
|
import styled, { createGlobalStyle } from 'styled-components';
|
||||||
|
|
||||||
const StyledPopover = styled(Popover)`
|
const StyledPopover = styled(Popover)`
|
||||||
background-color: white;
|
background-color: white;
|
||||||
@@ -29,6 +30,12 @@ const StyledButton = styled(Button)`
|
|||||||
text-wrap: nowrap;
|
text-wrap: nowrap;
|
||||||
`;
|
`;
|
||||||
|
|
||||||
|
const GlobalStyle = createGlobalStyle`
|
||||||
|
&:focus-visible {
|
||||||
|
outline: none;
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
interface DropButtonProps {
|
interface DropButtonProps {
|
||||||
button: ReactNode;
|
button: ReactNode;
|
||||||
isOpen?: boolean;
|
isOpen?: boolean;
|
||||||
@@ -44,10 +51,18 @@ export const DropButton = ({
|
|||||||
const [opacity, setOpacity] = useState(false);
|
const [opacity, setOpacity] = useState(false);
|
||||||
const [isLocalOpen, setIsLocalOpen] = useState(isOpen);
|
const [isLocalOpen, setIsLocalOpen] = useState(isOpen);
|
||||||
|
|
||||||
|
const ref = useRef<HTMLDivElement>(null);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setIsLocalOpen(isOpen);
|
setIsLocalOpen(isOpen);
|
||||||
}, [isOpen]);
|
}, [isOpen]);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (ref.current) {
|
||||||
|
ref.current[isLocalOpen ? 'focus' : 'blur']();
|
||||||
|
}
|
||||||
|
}, [isLocalOpen]);
|
||||||
|
|
||||||
const onOpenChangeHandler = (isOpen: boolean) => {
|
const onOpenChangeHandler = (isOpen: boolean) => {
|
||||||
setIsLocalOpen(isOpen);
|
setIsLocalOpen(isOpen);
|
||||||
onOpenChange?.(isOpen);
|
onOpenChange?.(isOpen);
|
||||||
@@ -57,15 +72,20 @@ export const DropButton = ({
|
|||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<DialogTrigger onOpenChange={onOpenChangeHandler} isOpen={isLocalOpen}>
|
<>
|
||||||
<StyledButton>{button}</StyledButton>
|
<GlobalStyle />
|
||||||
<StyledPopover
|
<DialogTrigger onOpenChange={onOpenChangeHandler} isOpen={isLocalOpen}>
|
||||||
style={{ opacity: opacity ? 1 : 0 }}
|
<StyledButton>{button}</StyledButton>
|
||||||
isOpen={isLocalOpen}
|
<StyledPopover
|
||||||
onOpenChange={onOpenChangeHandler}
|
style={{ opacity: opacity ? 1 : 0 }}
|
||||||
>
|
isOpen={isLocalOpen}
|
||||||
{children}
|
onOpenChange={onOpenChangeHandler}
|
||||||
</StyledPopover>
|
>
|
||||||
</DialogTrigger>
|
<div ref={ref} tabIndex={-1}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
</StyledPopover>
|
||||||
|
</DialogTrigger>
|
||||||
|
</>
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -5,6 +5,15 @@
|
|||||||
@import url('./cunningham-custom-tokens.css');
|
@import url('./cunningham-custom-tokens.css');
|
||||||
@import url('../assets/fonts/Marianne/Marianne-font.css');
|
@import url('../assets/fonts/Marianne/Marianne-font.css');
|
||||||
|
|
||||||
|
a:focus-visible,
|
||||||
|
button:focus-visible,
|
||||||
|
.c__button:focus-visible,
|
||||||
|
.c__select__wrapper:focus-visible,
|
||||||
|
.c__datagrid__header:focus-visible {
|
||||||
|
outline: var(--c--theme--colors--primary-600) solid 2px;
|
||||||
|
border-radius: var(--c--components--button--border-radius--focus);
|
||||||
|
}
|
||||||
|
|
||||||
.c__input,
|
.c__input,
|
||||||
.c__field,
|
.c__field,
|
||||||
.c__select,
|
.c__select,
|
||||||
@@ -314,6 +323,10 @@ input:-webkit-autofill:focus {
|
|||||||
transition: all 0.8s ease-in-out;
|
transition: all 0.8s ease-in-out;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.c__radio input:focus-visible {
|
||||||
|
outline: var(--c--theme--colors--primary-600) solid 2px;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Button
|
* Button
|
||||||
*/
|
*/
|
||||||
@@ -340,7 +353,8 @@ input:-webkit-autofill:focus {
|
|||||||
var(--c--theme--spacings--s);
|
var(--c--theme--spacings--s);
|
||||||
}
|
}
|
||||||
|
|
||||||
.c__button--primary {
|
.c__button--primary,
|
||||||
|
.c__button--primary:focus-visible {
|
||||||
background-color: var(--c--components--button--primary--background--color);
|
background-color: var(--c--components--button--primary--background--color);
|
||||||
color: var(--c--components--button--primary--color);
|
color: var(--c--components--button--primary--color);
|
||||||
}
|
}
|
||||||
@@ -470,6 +484,11 @@ input:-webkit-autofill:focus {
|
|||||||
/**
|
/**
|
||||||
* Modal
|
* Modal
|
||||||
*/
|
*/
|
||||||
|
.c__modal:focus-visible {
|
||||||
|
outline: none;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
|
||||||
.c__modal__backdrop {
|
.c__modal__backdrop {
|
||||||
z-index: 1000;
|
z-index: 1000;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,6 +30,11 @@ const SelectStyled = styled(Select)<{ $isSmall?: boolean }>`
|
|||||||
&:hover {
|
&:hover {
|
||||||
border-color: var(--c--theme--colors--primary-500);
|
border-color: var(--c--theme--colors--primary-500);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.c__button--tertiary-text:focus-visible {
|
||||||
|
outline: var(--c--theme--colors--primary-600) solid 2px;
|
||||||
|
border-radius: var(--c--components--button--border-radius--focus);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ export const PanelMailDomains = ({ mailDomain }: MailDomainProps) => {
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<Box
|
<Box
|
||||||
$margin={{ all: 'none' }}
|
$margin="none"
|
||||||
as="li"
|
as="li"
|
||||||
$css={`
|
$css={`
|
||||||
transition: all 0.2s ease-in;
|
transition: all 0.2s ease-in;
|
||||||
|
|||||||
@@ -50,6 +50,10 @@ const MenuItem = ({ Icon, label, href, alias }: MenuItemProps) => {
|
|||||||
onMouseOver={() => setIsTooltipOpen(true)}
|
onMouseOver={() => setIsTooltipOpen(true)}
|
||||||
onMouseLeave={() => setIsTooltipOpen(false)}
|
onMouseLeave={() => setIsTooltipOpen(false)}
|
||||||
style={{ display: 'block' }}
|
style={{ display: 'block' }}
|
||||||
|
$css={`
|
||||||
|
&:focus-visible {
|
||||||
|
outline: #fff solid 2px;
|
||||||
|
}`}
|
||||||
>
|
>
|
||||||
<Box
|
<Box
|
||||||
$margin="xtiny"
|
$margin="xtiny"
|
||||||
@@ -63,7 +67,11 @@ const MenuItem = ({ Icon, label, href, alias }: MenuItemProps) => {
|
|||||||
$background={background}
|
$background={background}
|
||||||
$radius="10px"
|
$radius="10px"
|
||||||
>
|
>
|
||||||
<BoxButton aria-label={t(`{{label}} button`, { label })} $color={color}>
|
<BoxButton
|
||||||
|
aria-label={t(`{{label}} button`, { label })}
|
||||||
|
$color={color}
|
||||||
|
tabIndex={-1}
|
||||||
|
>
|
||||||
<Icon
|
<Icon
|
||||||
width="2.375rem"
|
width="2.375rem"
|
||||||
aria-label={t(`{{label}} icon`, { label })}
|
aria-label={t(`{{label}} icon`, { label })}
|
||||||
|
|||||||
@@ -55,7 +55,9 @@ export const CardCreateTeam = () => {
|
|||||||
</Box>
|
</Box>
|
||||||
<Box $justify="space-between" $direction="row" $align="center">
|
<Box $justify="space-between" $direction="row" $align="center">
|
||||||
<StyledLink href="/">
|
<StyledLink href="/">
|
||||||
<Button color="secondary">{t('Cancel')}</Button>
|
<Button color="secondary" tabIndex={-1}>
|
||||||
|
{t('Cancel')}
|
||||||
|
</Button>
|
||||||
</StyledLink>
|
</StyledLink>
|
||||||
<Button
|
<Button
|
||||||
onClick={() => createTeam(teamName)}
|
onClick={() => createTeam(teamName)}
|
||||||
|
|||||||
@@ -47,6 +47,7 @@ export const PanelActions = () => {
|
|||||||
<BoxButton
|
<BoxButton
|
||||||
aria-label={t('Add a team')}
|
aria-label={t('Add a team')}
|
||||||
$color={colorsTokens()['primary-600']}
|
$color={colorsTokens()['primary-600']}
|
||||||
|
tabIndex={-1}
|
||||||
>
|
>
|
||||||
<IconAdd width={30} height={30} aria-label={t('Add team icon')} />
|
<IconAdd width={30} height={30} aria-label={t('Add team icon')} />
|
||||||
</BoxButton>
|
</BoxButton>
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ const Page: NextPageWithLayout = () => {
|
|||||||
return (
|
return (
|
||||||
<Box $align="center" $justify="center" $height="inherit">
|
<Box $align="center" $justify="center" $height="inherit">
|
||||||
<StyledLink href="/teams/create">
|
<StyledLink href="/teams/create">
|
||||||
<StyledButton>{t('Create a new team')}</StyledButton>
|
<StyledButton tabIndex={-1}>{t('Create a new team')}</StyledButton>
|
||||||
</StyledLink>
|
</StyledLink>
|
||||||
</Box>
|
</Box>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -0,0 +1,86 @@
|
|||||||
|
import { Page, expect, test } from '@playwright/test';
|
||||||
|
|
||||||
|
import { keyCloakSignIn } from './common';
|
||||||
|
|
||||||
|
const payloadGetTeams = {
|
||||||
|
count: 4,
|
||||||
|
next: null,
|
||||||
|
previous: null,
|
||||||
|
results: [
|
||||||
|
{
|
||||||
|
id: 'b2224958-ac22-4863-9330-4322add64ebe',
|
||||||
|
name: 'Test Group',
|
||||||
|
accesses: ['1a1ba2ba-a58c-4593-8adb-1da6ee9cd3a3'],
|
||||||
|
abilities: {
|
||||||
|
get: true,
|
||||||
|
patch: true,
|
||||||
|
put: true,
|
||||||
|
delete: true,
|
||||||
|
manage_accesses: true,
|
||||||
|
},
|
||||||
|
slug: 'test-group',
|
||||||
|
created_at: '2024-07-17T19:41:11.404763Z',
|
||||||
|
updated_at: '2024-07-17T19:41:11.404763Z',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
const mockApiRequests = (page: Page) => {
|
||||||
|
void page.route('**/teams/?page=1&ordering=-created_at', (route) => {
|
||||||
|
void route.fulfill({
|
||||||
|
json: payloadGetTeams,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
test.describe('Keyboard navigation', () => {
|
||||||
|
test('navigates through all focusable elements from top to bottom on groups index view when one group exists', async ({
|
||||||
|
browser,
|
||||||
|
browserName,
|
||||||
|
}) => {
|
||||||
|
const page = await browser.newPage();
|
||||||
|
|
||||||
|
await page.goto('/');
|
||||||
|
await keyCloakSignIn(page, browserName);
|
||||||
|
|
||||||
|
void mockApiRequests(page);
|
||||||
|
|
||||||
|
const header = page.locator('header');
|
||||||
|
|
||||||
|
// La Gauffre button is loaded asynchronously, so we wait for it to be visible
|
||||||
|
await expect(
|
||||||
|
header.getByRole('button', {
|
||||||
|
name: 'Les services de La Suite numérique',
|
||||||
|
}),
|
||||||
|
).toBeVisible();
|
||||||
|
|
||||||
|
// necessary to begin the keyboard navigation directly from first button on the app and only select its elements
|
||||||
|
await header.click();
|
||||||
|
|
||||||
|
// ensure ignoring elements (like tanstack query button) that are not part of the app
|
||||||
|
const focusableElements = await page
|
||||||
|
.locator(
|
||||||
|
'.c__app a:not([tabindex="-1"]), .c__app button:not([tabindex="-1"]), ' +
|
||||||
|
'.c__app [tabindex]:not([tabindex="-1"])',
|
||||||
|
)
|
||||||
|
.all();
|
||||||
|
|
||||||
|
expect(focusableElements.length).toEqual(20);
|
||||||
|
|
||||||
|
for (let i = 0; i < focusableElements.length; i++) {
|
||||||
|
await page.keyboard.press('Tab');
|
||||||
|
|
||||||
|
// check language picker language option navigation. 4th element is inner language picker arrow button
|
||||||
|
// eslint-disable-next-line playwright/no-conditional-in-test
|
||||||
|
if (i === 3) {
|
||||||
|
await page.keyboard.press('Enter');
|
||||||
|
|
||||||
|
// eslint-disable-next-line playwright/no-conditional-expect
|
||||||
|
await expect(focusableElements[i]).toBeFocused();
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
await expect(focusableElements[i]).toBeFocused();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user