Skip to content

restore tabindex after navigation #4140

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
Merged
Rich-Harris merged 4 commits into from
Feb 28, 2022
Merged

restore tabindex after navigation #4140

Rich-Harris merged 4 commits into from
Feb 28, 2022

Conversation

@mrkishi
Copy link
Member

@mrkishi mrkishi commented Feb 26, 2022

Fixes #3501.

As noted in the issue, adding tabindex="-1" to <body> causes a few focus management problems with body "stealing" input from other elements (eg. scrolling overflown children).

Since it's only needed to reset the page's focus during navigation, we can safely [?] remove it afterwards.

[?]: I'm not able to test this on Apple devices.

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0
@changeset-bot
Copy link

changeset-bot bot commented Feb 26, 2022 •
edited
Loading

🦋 Changeset detected

Latest commit: cf4a145

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
@geoffrich
Copy link
Member

geoffrich commented Feb 26, 2022

I think this is a good change - I can do some testing on an iPhone to make sure things are working as expected there.

Is there a reason you chose to start focusing html instead of body? I'm not sure it matters much, but was wondering if there was a reason to change the element we reset focus to.

We'll also need to update this line in kit.svelte.dev, which assumed body was focusable:

kit/sites/kit.svelte.dev/src/lib/search/SearchBox.svelte

Lines 54 to 63 in 09bf92f

function close() {
if ($searching) {
$searching = false;
const scroll = -parseInt(document.body.style.top || '0');
document.body.style.position = '';
document.body.style.top = '';
document.body.focus();
window.scrollTo(0, scroll);
}
}

@mrkishi
Copy link
Member Author

mrkishi commented Feb 26, 2022

No technical reason—I just suspect very few users handle focus events on html, whereas doing it on body would be more usual.
@mrkishi
Copy link
Member Author

mrkishi commented Feb 26, 2022

You were absolutely right about kit.svelte.dev, too. I had looked for focus() but forgot the site folder... Turns out this bug's been affecting us already: users can't click in the nav and navigate with the keyboard, for instance.

I pushed a fix.
benmccann
benmccann reviewed Feb 28, 2022
View reviewed changes
benmccann
benmccann reviewed Feb 28, 2022
View reviewed changes
@mrkishi @benmccann
Update packages/kit/src/runtime/client/renderer.js
cf4a145 
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
@Rich-Harris Rich-Harris merged commit e3410cc into sveltejs:master Feb 28, 2022
@github-actions github-actions bot mentioned this pull request Feb 28, 2022
Merged
@mrkishi mrkishi deleted the navigation-focus branch February 28, 2022 18:29
@geoffrich geoffrich mentioned this pull request Mar 2, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

5 participants

@mrkishi @geoffrich @benmccann @bluwy @Rich-Harris