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

Navigation: instant loading breaks keyboard navigation #5742

Closed
4 tasks done
filips123 opened this issue Jul 21, 2023 · 4 comments · Fixed by #5743
Closed
4 tasks done

Navigation: instant loading breaks keyboard navigation #5742

filips123 opened this issue Jul 21, 2023 · 4 comments · Fixed by #5743
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open

Comments

@filips123
Copy link

Context

No response

Bug description

When navigation.instant is enabled, triggering the navigation with keyboard (with p, n, ,, . keys) still reloads the page, This can be seen as certain parts of the UI (search, theme selection, repository information) blink as the page gets reloaded.

Related links

Reproduction

example.zip

Steps to reproduce

See that instant navigation with footer links works properly:

  1. Click a few times on next and previous links in the footer.
  2. Instant navigation should work, no UI elements will blink.

See that instant navigation with keyboard does not work:

  1. Press , and . a few times to navigate to next and previous pages.
  2. Instant navigation will not work, UI elements like search and repo information will "blink".

Browser

No response

Before submitting
@squidfunk squidfunk added the needs investigation Issue must be investigated by the maintainers label Jul 22, 2023
@squidfunk squidfunk linked a pull request Jul 22, 2023 that will close this issue
Improve support for instant loading with keyboard navigation #5743
Merged
@squidfunk squidfunk added bug Issue reports a bug and removed needs investigation Issue must be investigated by the maintainers labels Jul 22, 2023
@filips123
Copy link
Author

There is another related problem with instant loading and keyboard navigation that I found, and I don't know if it's also addressed in that PR. After navigating through the side by clicking links with instant loading enabled, keyboard navigation will break and redirect you to 404 page.

Steps to reproduce:

  1. Open the home page of my example docs.
  2. In the sidebar, click on FAQ and then Known Problems.
  3. Try to navigate to the previous page with P key. Nothing will happen.
  4. Try to navigate to the next page with N key. You will be redirected to an invalid path (/resources/known-problems/resources/faq/).

@squidfunk
Copy link
Owner

Yes, it's also related to instant loading and will be addressed in the PR. Note that the PR is not ready yet.

@squidfunk squidfunk changed the title Instant loading does not work with keyboard navigation Navigation: instant loading breaks keyboard navigation Aug 10, 2023
@squidfunk
Copy link
Owner

We'll leave it open until released.

@squidfunk squidfunk reopened this Sep 24, 2023
@squidfunk squidfunk added the resolved Issue is resolved, yet unreleased if open label Sep 24, 2023
@squidfunk
Copy link
Owner

Released as part of 9.4.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Issue reports a bug resolved Issue is resolved, yet unreleased if open
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve support for instant loading with keyboard navigation squidfunk/mkdocs-material
2 participants
@squidfunk @filips123