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 side navigation edge case bug introduced in #1475 #1477

Merged
merged 1 commit into from
Mar 27, 2019

Conversation

KyleJShaver
Copy link
Contributor

Summary
In some cases, the code from #1475 can render the page unable to scroll in response to a click in the side navigation.

Issue:
demonstration of the issue

Fixed:
demonstration of the resolution

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:
This is information in the file packages/@vuepress/plugin-active-header-links/clientRootMixin.js

The bug comes from the fact that the call to this.$router.replace fails if there is nothing in the URL to replace. Since disableScrollBehavior is set to true before this call, and disableScrollBehavior is set to false in the callback for this.$router.replace, the navigation links would not be allowed to scroll if the function fails and the callback is never reached. The only way to get out of this state would be to scroll manually, forcing disableScrollBehavior to be reset to false. Since the replace call fails anyway, simply returning out of the function if there is a match for the element at the bottom of the screen gets around this issue.

@ulivz ulivz merged commit 8a11d14 into vuejs:master Mar 27, 2019
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

2 participants