feat(v2): hide navbar on scroll #2055
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Deploy preview for docusaurus-2 ready! Built with commit e7db3f5 |
|
Deploy preview for docusaurus-preview ready! Built with commit e7db3f5 |
|
Hmm, for several days there has been no review from anyone, I think this is a good addition, don't you like it? |
yangshun
approved these changes
Nov 30, 2019
packages/docusaurus-theme-classic/src/theme/Navbar/styles.module.css
Outdated
Show resolved
Hide resolved
packages/docusaurus-theme-classic/src/theme/Navbar/styles.module.css
Outdated
Show resolved
Hide resolved
|
Docs needed |
wgao19
approved these changes
Dec 2, 2019
endiliey
suggested changes
Dec 6, 2019
|
Sorry for the delay, all proposals implemented (hook, docs). |
wgao19
reviewed
Dec 10, 2019
| @@ -90,6 +90,23 @@ module.exports = { | |||
|
|
|||
| Outbound links automatically get `target="_blank" rel="noopener noreferrer"`. | |||
|
|
|||
| ### Auto-hide sticky navbar | |||
|
|
|||
| You can enable this cool UI feature that automatically hides the navbar when a user starts scrolling down the page, and show it again when the user scrolls up. | |||
There was a problem hiding this comment.
it feels a bit weird that here we first address reader by "you" then later on say "a user" or "the user". I think it is ok to keep using you.
just personal opinion: i prefer it to be less objective. "cool" is also a very vague adjective and i found it a bit weird to read this from our docs
endiliey
reviewed
Dec 11, 2019
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import React, {useState, useCallback, useEffect} from 'react'; // eslint-disable-line no-unused-vars |
There was a problem hiding this comment.
why need eslint disable ? is it React :O
endiliey
approved these changes
Dec 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
I propose to consider including in my opinion a good feature called "Auto-Hide Sticky Header". The bottom line is simple - navbar hides when scrolling down, and is shown again when scrolling up. This helps the user to better focus on the content. Since not everyone may like it, this option is enabled in the theme config.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
The
hideOnScrolloption must be enabled.