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($theme-default): smooth scroll (close #567) #1881

Merged
merged 5 commits into from
Sep 23, 2019

Conversation

meteorlxy
Copy link
Member

@meteorlxy meteorlxy commented Sep 22, 2019

Summary

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:

smooth-scroll

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:

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:

The reason of changing throttle to debounce is to avoid this issue.

@ulivz
Copy link
Member

ulivz commented Sep 22, 2019

Good job, but I found a little frame dropping in my computer (Especially in the starting time when I clicked the sidebar like), I don't know what's going on on your machine and if there's any frame dropping. 😳

@meteorlxy
Copy link
Member Author

meteorlxy commented Sep 23, 2019

What about an option of themeConfig to enable / disable smooth-scroll ?


Done. Added themeConfig.smoothScroll option with docs.

image

@@ -35,6 +35,7 @@ module.exports = ctx => ({
apiKey: '3a539aab83105f01761a137c61004d85',
indexName: 'vuepress'
}) : null,
smoothScroll: true,
Copy link
Member Author

@meteorlxy meteorlxy Sep 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's TBD that if we should enable smoothScroll for official docs site. cc @ulivz @kefranabg

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I support trying out new features in our official docs.

@ulivz ulivz merged commit 2e3efb4 into vuejs:master Sep 23, 2019
@vue-bot
Copy link

vue-bot commented Sep 23, 2019

Hey @meteorlxy, thank you for your time and effort spent on this PR, contributions like yours help make Vue better for everyone. Cheers! 💚

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.

Smooth scrolling when clicking header links
3 participants