fix: properly scroll body if keyboard focusing a item with no other scroll parents #9780
+334
−20
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| /* | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import {Button} from '../src/Button'; | ||
| import {Meta, StoryObj} from '@storybook/react'; | ||
| import React, {useRef} from 'react'; | ||
| import {scrollIntoView} from 'react-aria/private/utils/scrollIntoView'; | ||
|
|
||
| import {useLayoutEffect} from '@react-aria/utils'; | ||
| import './styles.css'; | ||
|
|
||
| export default { | ||
| title: 'React Aria Components/ScrollIntoView', | ||
| component: Button, | ||
| parameters: { | ||
| layout: 'fullscreen', | ||
| description: { | ||
| data: 'Reproduces window scrolling when the document root has a thick border (like a bare HTML page). Uses react-aria scrollIntoView with the document element as the scroll view.' | ||
| } | ||
| } | ||
| } as Meta<typeof Button>; | ||
|
|
||
| export type ScrollIntoViewStory = StoryObj<typeof Button>; | ||
|
|
||
| export function ScrollIntoViewExample() { | ||
| let redSectionRef = useRef<HTMLDivElement>(null); | ||
| let yellowSectionRef = useRef<HTMLDivElement>(null); | ||
| let blueSectionRef = useRef<HTMLDivElement>(null); | ||
|
|
||
| useLayoutEffect(() => { | ||
| let html = document.documentElement; | ||
| let prevBorder = html.style.border; | ||
| let prevWidth = html.style.width; | ||
| html.style.border = '100px solid black'; | ||
| html.style.width = '1000px'; | ||
| return () => { | ||
| html.style.border = prevBorder; | ||
| html.style.width = prevWidth; | ||
| }; | ||
| }, []); | ||
|
|
||
| let triggerScroll = (target: React.RefObject<HTMLDivElement | null>, align: 'start' | 'end') => { | ||
| let root = (document.scrollingElement || document.documentElement) as HTMLElement; | ||
| if (target.current) { | ||
| scrollIntoView(root, target.current, {block: align, inline: align}); | ||
| } | ||
| }; | ||
|
|
||
| let sectionStyle = (color: string): React.CSSProperties => ({ | ||
| height: 1000, | ||
| backgroundColor: color, | ||
| width: '100%' | ||
| }); | ||
|
|
||
| return ( | ||
| <div style={{display: 'flex', flexDirection: 'column', width: '100%'}}> | ||
| <div ref={redSectionRef} style={sectionStyle('red')}> | ||
| Test 1 | ||
| <div style={{display: 'flex', flexWrap: 'wrap', gap: 8, marginTop: 8}}> | ||
| <Button onPress={() => triggerScroll(redSectionRef, 'start')}> | ||
| Scroll to Red (Start) | ||
| </Button> | ||
| <Button onPress={() => triggerScroll(yellowSectionRef, 'start')}> | ||
| Scroll to Yellow (Start) | ||
| </Button> | ||
| <Button onPress={() => triggerScroll(yellowSectionRef, 'end')}> | ||
| Scroll to Yellow (End) | ||
| </Button> | ||
| <Button onPress={() => triggerScroll(blueSectionRef, 'start')}> | ||
| Scroll to Blue (Start) | ||
| </Button> | ||
| <Button onPress={() => triggerScroll(blueSectionRef, 'end')}>Scroll to Blue (End)</Button> | ||
| </div> | ||
| </div> | ||
| <div style={sectionStyle('green')}>Test 2</div> | ||
| <div ref={yellowSectionRef} style={sectionStyle('yellow')}> | ||
| Test 3 | ||
| </div> | ||
| <div ref={blueSectionRef} style={sectionStyle('blue')}> | ||
| Test 4 | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| export const RootScrollPlayground: ScrollIntoViewStory = { | ||
| render: () => <ScrollIntoViewExample /> | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| /* | ||
| * Copyright 2026 Adobe. All rights reserved. | ||
| * This file is licensed to you under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under | ||
| * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS | ||
| * OF ANY KIND, either express or implied. See the License for the specific language | ||
| * governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| import {getScrollParents} from '../../src/utils/getScrollParents'; | ||
|
|
||
| describe('getScrollParents', () => { | ||
| let root: Element; | ||
|
|
||
| beforeEach(() => { | ||
| root = document.documentElement; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| document.body.innerHTML = ''; | ||
| jest.restoreAllMocks(); | ||
| }); | ||
|
|
||
| it('includes root as a scroll parent for a node in the document', () => { | ||
| let div = document.createElement('div'); | ||
| document.body.appendChild(div); | ||
|
|
||
| let parents = getScrollParents(div); | ||
| expect(parents).toContain(root); | ||
| }); | ||
|
|
||
| it('does not include root when root has overflow: hidden', () => { | ||
| let div = document.createElement('div'); | ||
| document.body.appendChild(div); | ||
|
|
||
| jest.spyOn(window, 'getComputedStyle').mockImplementation(el => { | ||
| if (el === root) { | ||
| return {overflow: 'hidden'} as CSSStyleDeclaration; | ||
| } | ||
| return {overflow: 'visible'} as CSSStyleDeclaration; | ||
| }); | ||
|
|
||
| let parents = getScrollParents(div); | ||
| expect(parents).not.toContain(root); | ||
| }); | ||
|
|
||
| it('includes a scrollable intermediate parent', () => { | ||
| let scrollable = document.createElement('div'); | ||
| let child = document.createElement('div'); | ||
| document.body.appendChild(scrollable); | ||
| scrollable.appendChild(child); | ||
|
|
||
| jest.spyOn(window, 'getComputedStyle').mockImplementation(el => { | ||
| if (el === scrollable) { | ||
| return {overflow: 'auto'} as CSSStyleDeclaration; | ||
| } | ||
| return {overflow: 'visible'} as CSSStyleDeclaration; | ||
| }); | ||
|
|
||
| let parents = getScrollParents(child); | ||
| expect(parents).toContain(scrollable); | ||
| expect(parents).toContain(root); | ||
| }); | ||
|
|
||
| it('excludes non-scrollable ancestors', () => { | ||
| let plain = document.createElement('div'); | ||
| let child = document.createElement('div'); | ||
| document.body.appendChild(plain); | ||
| plain.appendChild(child); | ||
|
|
||
| let parents = getScrollParents(child); | ||
| expect(parents).not.toContain(plain); | ||
| expect(parents).not.toContain(document.body); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
old logic wasn't including the root element except if the initial node provided was the root.
isScrollableshould properly check if scrolling is being prevented on the root so we don't actually need thenode ! == rootcheck I believeThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Meh, our test suite was exactly calling with
rootas the container. Sorry about that.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all good haha, I didn't catch this either on my original review. So many different scenarios to test too