Skip to content

A11y: Add ScrollArea prop focusable for when it has static children #33876

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
Sidnioulz merged 2 commits into from
Feb 27, 2026
Merged

A11y: Add ScrollArea prop focusable for when it has static children #33876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47ce1da
fix: Add ScrollArea prop focusable for when it has no interactive chi…
Sidnioulz Feb 20, 2026
0cb0d09
UI: Add focus outline to focusable scroll area
Sidnioulz Feb 27, 2026
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
34 changes: 34 additions & 0 deletions code/core/src/components/components/ScrollArea/ScrollArea.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,37 @@ export const CustomSize = () => (
))}
</ScrollArea>
);

export const FocusableVertical = () => (
<ScrollArea vertical focusable>
{list((i) => (
<Fragment key={i}>
<Block>{i}</Block>
<br />
</Fragment>
))}
</ScrollArea>
);

export const FocusableHorizontal = () => (
<ScrollArea horizontal focusable>
<div style={{ padding: 5 }}>
{list((i) => (
<Block key={i}>{i}</Block>
))}
</div>
</ScrollArea>
);

export const FocusableBoth = () => (
<ScrollArea horizontal vertical focusable>
{list((i) => (
<Fragment key={i}>
{list((ii) => (
<Block key={ii}>{ii * i}</Block>
))}
<br />
</Fragment>
))}
</ScrollArea>
);
29 changes: 24 additions & 5 deletions code/core/src/components/components/ScrollArea/ScrollArea.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ export interface ScrollAreaProps {
offset?: number;
scrollbarSize?: number;
scrollPadding?: number | string;
/**
* Set this to define a tabIndex on the scrollable content; only needed when content has no
* interactive elements.
*/
focusable?: boolean;
}

const ScrollAreaRoot = styled(ScrollAreaPrimitive.Root)<{ scrollbarsize: number; offset: number }>(
Expand All @@ -23,10 +28,18 @@ const ScrollAreaRoot = styled(ScrollAreaPrimitive.Root)<{ scrollbarsize: number;
})
);

const ScrollAreaViewport = styled(ScrollAreaPrimitive.Viewport)({
width: '100%',
height: '100%',
});
const ScrollAreaViewport = styled(ScrollAreaPrimitive.Viewport)<{ focusable: boolean }>(
({ focusable, theme }) => ({
width: '100%',
height: '100%',
'&:focus': focusable
? {
outline: `2px solid ${theme.color.secondary}`,
outlineOffset: -2,
}
: {},
})
);

const ScrollAreaScrollbar = styled(ScrollAreaPrimitive.Scrollbar)<{
offset: number;
Expand Down Expand Up @@ -89,11 +102,17 @@ export const ScrollArea = forwardRef<HTMLDivElement, ScrollAreaProps>(
scrollbarSize = 6,
scrollPadding = 0,
className,
focusable = false,
},
ref
) => (
<ScrollAreaRoot scrollbarsize={scrollbarSize} offset={offset} className={className}>
<ScrollAreaViewport ref={ref} style={{ scrollPadding }}>
<ScrollAreaViewport
ref={ref}
style={{ scrollPadding }}
tabIndex={focusable ? 0 : undefined}
focusable={focusable}
>
{children}
</ScrollAreaViewport>
{horizontal && (
Expand Down
2 changes: 1 addition & 1 deletion code/core/src/components/components/syntaxhighlighter/syntaxhighlighter.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ const Wrapper = styled.div<WrapperProps>(
);

const UnstyledScroller = ({ children, className }: ScrollAreaProps) => (
<ScrollArea horizontal vertical className={className}>
<ScrollArea horizontal vertical focusable className={className}>
{children}
</ScrollArea>
);
Expand Down
Loading