Skip to content
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

Jump to bottom

Allow scroll prevention on hash change #31921

Merged
merged 4 commits into from Feb 7, 2022
Merged

Allow scroll prevention on hash change #31921

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
c790b26
Allow scroll prevention on hash change
wouterraateland Nov 29, 2021
7554cad
Merge branch 'canary' into patch-1
ijjk Feb 6, 2022
0d574a3
Add test case and apply fixes
ijjk Feb 6, 2022
6ac2a2e
Merge branch 'canary' into patch-1
kodiakhq[bot] Feb 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 0 additions & 5 deletions packages/next/client/link.tsx
View file
Open in desktop
Expand Up @@ -96,11 +96,6 @@ function linkClicked(

e.preventDefault()

// avoid scroll for urls with anchor refs
if (scroll == null && as.indexOf('#') >= 0) {
scroll = false
}

// replace state instead of push if prop is present
router[replace ? 'replace' : 'push'](href, as, {
shallow,
Expand Down
11 changes: 8 additions & 3 deletions packages/next/shared/lib/router/router.ts
View file
Open in desktop
Expand Up @@ -1009,7 +1009,7 @@ export default class Router implements BaseRouter {
performance.mark('routeChange')
}

const { shallow = false } = options
const { shallow = false, scroll = true } = options
const routeProps = { shallow }

if (this._inFlightRoute) {
Expand Down Expand Up @@ -1045,8 +1045,13 @@ export default class Router implements BaseRouter {
this.asPath = cleanedAs
Router.events.emit('hashChangeStart', as, routeProps)
// TODO: do we need the resolved href when only a hash change?
this.changeState(method, url, as, options)
this.scrollToHash(cleanedAs)
this.changeState(method, url, as, {
...options,
scroll: false,
})
if (scroll) {
this.scrollToHash(cleanedAs)
}
this.notify(this.components[this.route], null)
Router.events.emit('hashChangeComplete', as, routeProps)
return true
Expand Down
5 changes: 5 additions & 0 deletions test/integration/client-navigation/pages/nav/hash-changes.js
View file
Open in desktop
Expand Up @@ -27,6 +27,11 @@ const HashChanges = ({ count }) => {
<Link href="#name-item-400">
<a id="scroll-to-name-item-400">Go to name item 400</a>
</Link>
<Link href="#name-item-400" scroll={false}>
<a id="scroll-to-name-item-400-no-scroll">
Go to name item 400 (no scroll)
</a>
</Link>
<p>COUNT: {count}</p>
{Array.from({ length: 500 }, (x, i) => i + 1).map((i) => {
return (
Expand Down
11 changes: 11 additions & 0 deletions test/integration/client-navigation/test/index.test.js
View file
Open in desktop
Expand Up @@ -625,6 +625,17 @@ describe('Client Navigation', () => {
}
})

it('should not scroll to hash when scroll={false} is set', async () => {
const browser = await webdriver(context.appPort, '/nav/hash-changes')
const curScroll = await browser.eval(
'document.documentElement.scrollTop'
)
await browser.elementByCss('#scroll-to-name-item-400-no-scroll').click()
expect(curScroll).toBe(
await browser.eval('document.documentElement.scrollTop')
)
})

it('should scroll to the specified position on the same page with a name property', async () => {
let browser
try {
Expand Down