Fix side navigation edge case bug introduced in #1475 #1477
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Fixed:
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
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. SincedisableScrollBehavior
is set totrue
before this call, anddisableScrollBehavior
is set tofalse
in the callback forthis.$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, forcingdisableScrollBehavior
to be reset tofalse
. Since thereplace
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.