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: yield main thread before navigating #12225

Merged
merged 5 commits into from
May 17, 2024
Merged

fix: yield main thread before navigating #12225

merged 5 commits into from
May 17, 2024

Conversation

Rich-Harris
Copy link
Member

By default, SvelteKit preloads the data and code needed to navigate when you touch or hover over a link. As a consequence, it's often the case that navigation can occur immediately following a click event, with no delay for network activity.

Ironically, this means that navigation becomes less responsive, not more, because the browser doesn't get a chance to repaint before the navigation occurs and the page is re-rendered, which can cause dropped frames on slower devices. Because of this, the Interaction to Next Paint (INP) metric suffers, which harms the Core Web Vitals (CWV) score of SvelteKit apps.

This PR adds a tiny pause inside the click handler before navigation. The combination of requestAnimationFrame and setTimeout allows the browser to repaint, but without creating a user-noticeable delay.

No tests because I'm not sure how you would test for this.


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:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented May 17, 2024

🦋 Changeset detected

Latest commit: 5cfa4a9

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

@@ -2027,7 +2027,7 @@ function _start_router() {
}

/** @param {MouseEvent} event */
container.addEventListener('click', (event) => {
container.addEventListener('click', async (event) => {
Copy link
Member

Choose a reason for hiding this comment

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

I think this may cause errors to be ignored because addEventListener isn't async and doesn't accept a promise and so there's no rejection handler that gets applied in the error case

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.

None yet

4 participants