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.

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

fix: skip navigation hooks on hashchange #8730

Merged
merged 1 commit into from
Jan 26, 2023
Merged

fix: skip navigation hooks on hashchange #8730

merged 1 commit into from
Jan 26, 2023

Conversation

Rich-Harris
Copy link
Member

closes #8726

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Sorry, something went wrong.

@changeset-bot
Copy link

changeset-bot bot commented Jan 25, 2023

🦋 Changeset detected

Latest commit: f736b2a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Rich-Harris Rich-Harris changed the title skip navigation hooks on hashchange fix: skip navigation hooks on hashchange Jan 25, 2023
const scroll = scroll_positions[event.state[INDEX_KEY]];

// if the only change is the hash, we don't need to do anything...
if (current.url.href.split('#')[0] === location.href.split('#')[0]) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to worry about the case where the old or the new (or both!) URLs don't have a # portion? Are we treating a link from /foo to /foo as a no-op? (I remember this coming up before, but don't remember what the decision was.) What happens in native browser navigation when there's a link from /foo#bar to /foo?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Native navigation:

  • /foo#bar to /foo (or the other way around) only resets the scroll position
  • /foo to /foo doesn't create a new history entry, so that case doesn't occur
    --> maybe the solution is to use replaceState in update in case the URL is the same? Then we don't need to worry about these cases

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, we're in the clear — this check will work the same for /foo#x <-> /foo as for /foo#x <-> /foo#y, and we already treat /foo <-> /foo as a replaceState inside the click handler:

replaceState: url.href === location.href

@dummdidumm dummdidumm merged commit e15554a into master Jan 26, 2023
@dummdidumm dummdidumm deleted the gh-8726 branch January 26, 2023 14:19
@github-actions github-actions bot mentioned this pull request Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

popstate triggers beforeNavigate/afterNavigate for hash changes
3 participants