Skip to content

Commit a64085f

Browse files
committed
✨(frontend) enable enter key to open documents and subdocuments
added keyboard support to open docs and subdocs using the enter key Signed-off-by: Cyril <[email protected]>
1 parent 0a1eaa3 commit a64085f

File tree

8 files changed

+327
-78
lines changed

8 files changed

+327
-78
lines changed

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ and this project adheres to
88

99
## [Unreleased]
1010

11-
### Added
11+
### Added
1212

1313
- ✨(api) add API route to fetch document content #1206
1414

1515
### Changed
1616

1717
- 🔒️(backend) configure throttle on every viewsets #1343
1818
- ⬆️ Bump eslint to V9 #1071
19+
- ♿(frontend) improve accessibility:
20+
- #1354
1921

2022
## [3.6.0] - 2025-09-04
2123

src/frontend/apps/e2e/__tests__/app-impress/doc-tree.spec.ts

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,46 @@ test.describe('Doc Tree', () => {
252252
page.getByRole('menuitem', { name: 'Move to my docs' }),
253253
).toHaveAttribute('aria-disabled', 'true');
254254
});
255+
256+
test('keyboard navigation with Enter key opens documents', async ({
257+
page,
258+
browserName,
259+
}) => {
260+
// Create a parent document
261+
const [docParent] = await createDoc(
262+
page,
263+
'doc-tree-keyboard-nav',
264+
browserName,
265+
1,
266+
);
267+
await verifyDocName(page, docParent);
268+
269+
// Create a sub-document
270+
const { name: docChild } = await createRootSubPage(
271+
page,
272+
browserName,
273+
'doc-tree-keyboard-child',
274+
);
275+
276+
const docTree = page.getByTestId('doc-tree');
277+
await expect(docTree).toBeVisible();
278+
279+
// Test keyboard navigation on root document
280+
const rootItem = page.getByTestId('doc-tree-root-item');
281+
await expect(rootItem).toBeVisible();
282+
283+
// Focus on the root item and press Enter
284+
await rootItem.focus();
285+
await expect(rootItem).toBeFocused();
286+
await page.keyboard.press('Enter');
287+
288+
// Verify we navigated to the root document
289+
await verifyDocName(page, docParent);
290+
await expect(page).toHaveURL(/\/docs\/[^\/]+\/?$/);
291+
292+
// Now test keyboard navigation on sub-document
293+
await expect(docTree.getByText(docChild)).toBeVisible();
294+
});
255295
});
256296

257297
test.describe('Doc Tree: Inheritance', () => {

src/frontend/apps/impress/src/features/docs/doc-management/components/SimpleDocItem.tsx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { DateTime } from 'luxon';
2+
import { useRouter } from 'next/navigation';
23
import { useTranslation } from 'react-i18next';
34
import { css } from 'styled-components';
45

@@ -26,17 +27,28 @@ type SimpleDocItemProps = {
2627
doc: Doc;
2728
isPinned?: boolean;
2829
showAccesses?: boolean;
30+
onActivate?: () => void;
2931
};
3032

3133
export const SimpleDocItem = ({
3234
doc,
3335
isPinned = false,
3436
showAccesses = false,
37+
onActivate,
3538
}: SimpleDocItemProps) => {
3639
const { t } = useTranslation();
3740
const { spacingsTokens, colorsTokens } = useCunninghamTheme();
3841
const { isDesktop } = useResponsiveStore();
3942
const { untitledDocument } = useTrans();
43+
const router = useRouter();
44+
45+
const handleActivate = () => {
46+
if (onActivate) {
47+
onActivate();
48+
} else {
49+
router.push(`/docs/${doc.id}`);
50+
}
51+
};
4052

4153
const { emoji, titleWithoutEmoji: displayTitle } = getEmojiAndTitle(
4254
doc.title || untitledDocument,
@@ -49,6 +61,9 @@ export const SimpleDocItem = ({
4961
$overflow="auto"
5062
$width="100%"
5163
className="--docs--simple-doc-item"
64+
role="presentation"
65+
onClick={handleActivate}
66+
aria-label={`${t('Open document')} ${doc.title || untitledDocument}`}
5267
>
5368
<Box
5469
$direction="row"
@@ -59,6 +74,7 @@ export const SimpleDocItem = ({
5974
`}
6075
$padding={`${spacingsTokens['3xs']} 0`}
6176
data-testid={isPinned ? `doc-pinned-${doc.id}` : undefined}
77+
aria-hidden="true"
6278
>
6379
{isPinned ? (
6480
<PinnedDocumentIcon
@@ -97,6 +113,7 @@ export const SimpleDocItem = ({
97113
$align="center"
98114
$gap={spacingsTokens['3xs']}
99115
$margin={{ top: '-2px' }}
116+
aria-hidden="true"
100117
>
101118
<Text $variation="600" $size="xs">
102119
{DateTime.fromISO(doc.updated_at).toRelative()}

src/frontend/apps/impress/src/features/docs/doc-tree/components/DocSubPageItem.tsx

Lines changed: 83 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ import {
55
} from '@gouvfr-lasuite/ui-kit';
66
import { useRouter } from 'next/navigation';
77
import { useState } from 'react';
8+
import { useTranslation } from 'react-i18next';
89
import { css } from 'styled-components';
910

10-
import { Box, Icon, Text } from '@/components';
11+
import { Box, BoxButton, Icon, Text } from '@/components';
1112
import { useCunninghamTheme } from '@/cunningham';
1213
import {
1314
Doc,
@@ -20,6 +21,7 @@ import { useResponsiveStore } from '@/stores';
2021

2122
import SubPageIcon from './../assets/sub-page-logo.svg';
2223
import { DocTreeItemActions } from './DocTreeItemActions';
24+
import { useKeyboardActivation } from './hooks/useKeyboardActivation';
2325

2426
const ItemTextCss = css`
2527
overflow: hidden;
@@ -38,14 +40,23 @@ export const DocSubPageItem = (props: TreeViewNodeProps<Doc>) => {
3840
const { node } = props;
3941
const { spacingsTokens } = useCunninghamTheme();
4042
const { isDesktop } = useResponsiveStore();
41-
const [actionsOpen, setActionsOpen] = useState(false);
43+
const { t } = useTranslation();
44+
45+
const [menuOpen, setMenuOpen] = useState(false);
46+
const isSelectedNow = treeContext?.treeData.selectedNode?.id === doc.id;
47+
const isActive = node.isFocused || menuOpen || isSelectedNow;
4248

4349
const router = useRouter();
4450
const { togglePanel } = useLeftPanelStore();
4551

4652
const { emoji, titleWithoutEmoji } = getEmojiAndTitle(doc.title || '');
4753
const displayTitle = titleWithoutEmoji || untitledDocument;
4854

55+
const handleActivate = () => {
56+
treeContext?.treeData.setSelectedNode(doc);
57+
router.push(`/docs/${doc.id}`);
58+
};
59+
4960
const afterCreate = (createdDoc: Doc) => {
5061
const actualChildren = node.data.children ?? [];
5162

@@ -76,62 +87,87 @@ export const DocSubPageItem = (props: TreeViewNodeProps<Doc>) => {
7687
}
7788
};
7889

90+
useKeyboardActivation(
91+
['Enter', ' '],
92+
isActive && !menuOpen,
93+
handleActivate,
94+
true,
95+
);
96+
97+
// prepare the text for the screen reader
98+
const docTitle = doc.title || untitledDocument;
99+
const hasChildren = (doc.children?.length || 0) > 0;
100+
const isExpanded = node.isOpen;
101+
const isSelected = isSelectedNow;
102+
103+
const ariaLabel = docTitle;
104+
79105
return (
80106
<Box
81107
className="--docs-sub-page-item"
82108
draggable={doc.abilities.move && isDesktop}
83109
$position="relative"
110+
role="treeitem"
111+
aria-label={ariaLabel}
112+
aria-selected={isSelected}
113+
aria-expanded={hasChildren ? isExpanded : undefined}
84114
$css={css`
85-
background-color: ${actionsOpen
86-
? 'var(--c--theme--colors--greyscale-100)'
87-
: 'var(--c--theme--colors--greyscale-000)'};
115+
/* Ensure the outline (handled by TreeView) matches the visual area */
116+
.c__tree-view--node {
117+
padding: ${spacingsTokens['3xs']};
118+
border-radius: 4px;
119+
}
88120
89121
.light-doc-item-actions {
90-
display: ${actionsOpen || !isDesktop ? 'flex' : 'none'};
122+
display: flex;
123+
opacity: ${isActive || !isDesktop ? 1 : 0};
91124
position: absolute;
92125
right: 0;
93-
background: ${isDesktop
94-
? 'var(--c--theme--colors--greyscale-100)'
95-
: 'var(--c--theme--colors--greyscale-000)'};
126+
top: 0;
127+
height: 100%;
128+
z-index: 10;
96129
}
97130
98-
.c__tree-view--node.isSelected {
99-
.light-doc-item-actions {
100-
background: var(--c--theme--colors--greyscale-100);
101-
}
102-
}
103-
104-
&:hover {
131+
.c__tree-view--node:hover,
132+
.c__tree-view--node.isFocused {
105133
background-color: var(--c--theme--colors--greyscale-100);
106-
border-radius: 4px;
107134
108135
.light-doc-item-actions {
109136
display: flex;
110-
background: var(--c--theme--colors--greyscale-100);
137+
opacity: 1;
138+
visibility: visible;
139+
/* background: var(--c--theme--colors--greyscale-100); */
111140
}
112141
}
113142
114143
.row.preview & {
115144
background-color: inherit;
116145
}
146+
147+
/* Ensure actions are visible when hovering the whole item container */
148+
&:hover {
149+
.light-doc-item-actions {
150+
display: flex;
151+
opacity: 1;
152+
visibility: visible;
153+
}
154+
}
117155
`}
118156
>
119-
<TreeViewItem
120-
{...props}
121-
onClick={() => {
122-
treeContext?.treeData.setSelectedNode(props.node.data.value as Doc);
123-
router.push(`/docs/${props.node.data.value.id}`);
124-
}}
125-
>
126-
<Box
127-
data-testid={`doc-sub-page-item-${props.node.data.value.id}`}
157+
<TreeViewItem {...props} onClick={handleActivate}>
158+
<BoxButton
159+
onClick={(e) => {
160+
e.stopPropagation();
161+
handleActivate();
162+
}}
163+
tabIndex={-1}
128164
$width="100%"
129165
$direction="row"
130166
$gap={spacingsTokens['xs']}
131-
role="button"
132-
tabIndex={0}
133167
$align="center"
134168
$minHeight="24px"
169+
data-testid={`doc-sub-page-item-${doc.id}`}
170+
aria-label={`${t('Open document')} ${docTitle}`}
135171
>
136172
<Box $width="16px" $height="16px">
137173
<DocIcon emoji={emoji} defaultIcon={<SubPageIcon />} $size="sm" />
@@ -157,25 +193,28 @@ export const DocSubPageItem = (props: TreeViewNodeProps<Doc>) => {
157193
iconName="group"
158194
$size="16px"
159195
$variation="400"
196+
aria-hidden="true"
160197
/>
161198
)}
162199
</Box>
163-
164-
<Box
165-
$direction="row"
166-
$align="center"
167-
className="light-doc-item-actions"
168-
>
169-
<DocTreeItemActions
170-
doc={doc}
171-
isOpen={actionsOpen}
172-
onOpenChange={setActionsOpen}
173-
parentId={node.data.parentKey}
174-
onCreateSuccess={afterCreate}
175-
/>
176-
</Box>
177-
</Box>
200+
</BoxButton>
178201
</TreeViewItem>
202+
203+
<Box
204+
$direction="row"
205+
$align="center"
206+
className="light-doc-item-actions"
207+
role="toolbar"
208+
aria-label={`${t('Actions for')} ${docTitle}`}
209+
>
210+
<DocTreeItemActions
211+
doc={doc}
212+
isOpen={menuOpen}
213+
onOpenChange={setMenuOpen}
214+
parentId={node.data.parentKey}
215+
onCreateSuccess={afterCreate}
216+
/>
217+
</Box>
179218
</Box>
180219
);
181220
};

0 commit comments

Comments
 (0)