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

feat: allow for disabling of active hash on scroll (#482) #489

Merged
merged 1 commit into from
May 24, 2018

Conversation

achendrick
Copy link
Contributor

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)

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

  • A convincing reason for adding this feature
  • Related documents 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:

Auto setting the active hash based on the side bar links and page headers was having some non-ideal behaviors on my site. If you have headers that aren't in the side bar, or update the hash programmatically this feature can cause issues.

I introduced a simple config to disable the capability.

Please not I'm open to suggestions, I opted to check the config in an isolated area related to the logic, but it still maintains the scroll listener which may not be optimal or preferred.

@ulivz ulivz merged commit 4c09627 into vuejs:master May 24, 2018
@ulivz
Copy link
Member

ulivz commented May 24, 2018

Thanks for your work!

I just renamed the disableActiveHash to activeHeaderLinks, made sure the script of active header links loaded on demand (b0c9e11), and updated document (affecd8)

@ulivz
Copy link
Member

ulivz commented May 24, 2018

Close: #482

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.

2 participants