Skip to content

[EuiCodeBlock] Add accessible labels for virtualized code blocks #8887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mgadewoll merged 4 commits into from
Jul 24, 2025
Merged

[EuiCodeBlock] Add accessible labels for virtualized code blocks #8887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20fa806
fix(codeBlock): add missing accessible labels for virtualized code bl…
mgadewoll Jul 21, 2025
6016858
test: update snapshots
mgadewoll Jul 21, 2025
aa5c7fb
chore: add changelog
mgadewoll Jul 21, 2025
974b992
refactor: include aria-label in codeBlockLabel
mgadewoll Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/eui/changelogs/upcoming/8887.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**Accessibility**

- Added accessible labels to virtualized `EuiCodeBlock`

23 changes: 21 additions & 2 deletions packages/eui/src/components/code/__snapshots__/code_block.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,27 @@ exports[`EuiCodeBlock Virtualization renders a virtualized code block 1`] = `
style="position: relative; block-size: 600px; inline-size: 600px; overflow: auto; will-change: transform; direction: ltr;"
tabindex="0"
>
<span
aria-hidden="true"
class="euiScreenReaderOnly"
data-tabular-copy-marker="no-copy"
>
✄𐘗
</span>
<div
class="emotion-euiScreenReaderOnly"
>
aria-label,
text code block:
</div>
<span
aria-hidden="true"
class="euiScreenReaderOnly"
data-tabular-copy-marker="no-copy"
>
✄𐘗
</span>
<code
aria-label="aria-label"
class="euiCodeBlock__code emotion-euiCodeBlock__code-isVirtualized"
data-code-language="text"
data-test-subj="test subject string"
Expand Down Expand Up @@ -73,6 +92,7 @@ exports[`EuiCodeBlock renders a code block 1`] = `
<div
class="emotion-euiScreenReaderOnly"
>
aria-label,
text code block:
</div>
<span
Expand All @@ -83,7 +103,6 @@ exports[`EuiCodeBlock renders a code block 1`] = `
✄𐘗
</span>
<code
aria-label="aria-label"
class="euiCodeBlock__code emotion-euiCodeBlock__code"
data-code-language="text"
data-test-subj="test subject string"
Expand Down
8 changes: 7 additions & 1 deletion packages/eui/src/components/code/code_block.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ export const EuiCodeBlock: FunctionComponent<EuiCodeBlockProps> = ({
overflowHeight,
isVirtualized: _isVirtualized,
lineNumbers = false,
'aria-label': ariaLabel,
...rest
}) => {
const euiTheme = useEuiTheme();
Expand Down Expand Up @@ -278,7 +279,10 @@ export const EuiCodeBlock: FunctionComponent<EuiCodeBlockProps> = ({
<>
{tabularCopyMarkers.hiddenNoCopyBoundary}
<EuiScreenReaderOnly>
<div>{codeBlockLabel}</div>
<div>
{ariaLabel ? `${ariaLabel}, ` : undefined}
{codeBlockLabel}
</div>
</EuiScreenReaderOnly>
{tabularCopyMarkers.hiddenNoCopyBoundary}
</>
Expand All @@ -293,6 +297,7 @@ export const EuiCodeBlock: FunctionComponent<EuiCodeBlockProps> = ({
{isVirtualized ? (
<EuiCodeBlockVirtualized
data={data}
label={codeBlockLabelElement}
rowHeight={fontSizeToRowHeightMap[fontSize]}
overflowHeight={overflowHeight}
preProps={preProps}
Expand All @@ -314,6 +319,7 @@ export const EuiCodeBlock: FunctionComponent<EuiCodeBlockProps> = ({
{isVirtualized ? (
<EuiCodeBlockVirtualized
data={data}
label={codeBlockLabelElement}
rowHeight={fontSizeToRowHeightMap.l}
preProps={preFullscreenProps}
codeProps={codeProps}
Expand Down
13 changes: 9 additions & 4 deletions packages/eui/src/components/code/code_block_virtualized.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* Side Public License, v 1.
*/

import React, { HTMLAttributes, forwardRef, useMemo } from 'react';
import React, { HTMLAttributes, ReactNode, forwardRef, useMemo } from 'react';
import { FixedSizeList, ListChildComponentProps } from 'react-window';
import { RefractorNode } from 'refractor';
import { logicalStyles } from '../../global_styling';
Expand All @@ -19,23 +19,28 @@ import { nodeToHtml } from './utils';

export const EuiCodeBlockVirtualized = ({
data,
label,
rowHeight,
overflowHeight,
preProps,
codeProps,
}: {
data: RefractorNode[];
label: ReactNode;
rowHeight: number;
overflowHeight?: number | string;
preProps: HTMLAttributes<HTMLPreElement>;
codeProps: HTMLAttributes<HTMLElement>;
}) => {
const VirtualizedOuterElement = useMemo(
() =>
forwardRef<any, any>(({ style, ...props }, ref) => (
<pre style={logicalStyles(style)} {...props} ref={ref} {...preProps} />
forwardRef<any, any>(({ style, children, ...props }, ref) => (
<pre style={logicalStyles(style)} {...props} ref={ref} {...preProps}>
{label}
{children}
</pre>
)),
[preProps]
[preProps, label]
);

const VirtualizedInnerElement = useMemo(
Expand Down