[Gatsby Docs Update] Fixed iOS overscroll issues, and redesigned mobile sidebar button to … #10761
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,12 +25,80 @@ class StickyResponsiveSidebar extends Component { | |
| open: false, | ||
| }; | ||
| this.toggleOpen = this._toggleOpen.bind(this); | ||
| this.handleDocumentTouchMove = this._handleDocumentTouchMove.bind(this); | ||
| this.handleSidebarTouchStart = this._handleSidebarTouchStart.bind(this); | ||
| } | ||
|
|
||
| componentDidMount() { | ||
| document.addEventListener('touchmove', this.handleDocumentTouchMove); | ||
| document | ||
| .querySelector('.scrollable') | ||
| .addEventListener('touchstart', this.handleSidebarTouchStart); | ||
|
There was a problem hiding this comment. Strong initial dislike to all of the global handlers/selectors here. If we have to do this, I think we should wrap it up in a separate component rather than mix it into the sticky component. Ideally we could do this in a more "React" way (with props/refs) but I'd have to think about that a bit more. Might be harder to do. There was a problem hiding this comment. Edit: It might be possible to make it a bit more 'React' ish. For now we could start by adding a comment and linking to the blog post that describes this fix for the iOS overscroll bug. (http://blog.christoffer.online/2015-06-10-six-things-i-learnt-about-ios-rubberband-overflow-scrolling/) |
||
| } | ||
|
|
||
| componentWillUnmount() { | ||
| document.removeEventListener('touchmove', this.handleDocumentTouchMove); | ||
| document | ||
| .querySelector('.scrollable') | ||
| .removeEventListener('touchstart', this.handleSidebarTouchStart); | ||
| document.documentElement.classList.remove('is-menu-open'); | ||
| } | ||
|
|
||
| _toggleOpen() { | ||
| document.documentElement.classList[this.state.open ? 'remove' : 'add']( | ||
| 'is-menu-open', | ||
| ); | ||
| this.setState({open: !this.state.open}); | ||
| } | ||
|
|
||
| isMenuOpen() { | ||
| return ( | ||
| this.state.open && | ||
| window.matchMedia(media.greaterThan('small').replace('@media ', '')) | ||
| ); | ||
| } | ||
|
|
||
| // Prevent background scroll | ||
| // http://blog.christoffer.online/2015-06-10-six-things-i-learnt-about-ios-rubberband-overflow-scrolling/ | ||
| _handleDocumentTouchMove(evt) { | ||
| if (!this.isMenuOpen()) { | ||
| return; | ||
| } | ||
|
|
||
| let isTouchMoveAllowed = true; | ||
| let target = evt.target; | ||
|
|
||
| while (target !== null) { | ||
| if (target.classList && target.classList.contains('disable-scrolling')) { | ||
| isTouchMoveAllowed = false; | ||
| break; | ||
| } | ||
| target = target.parentNode; | ||
| } | ||
|
|
||
| if (!isTouchMoveAllowed) { | ||
| evt.preventDefault(); | ||
| } | ||
| } | ||
|
|
||
| // Remove iOS Rubber Effect | ||
| // http://blog.christoffer.online/2015-06-10-six-things-i-learnt-about-ios-rubberband-overflow-scrolling/ | ||
| _handleSidebarTouchStart(evt) { | ||
| if (!this.isMenuOpen()) { | ||
| return; | ||
| } | ||
|
|
||
| const top = evt.currentTarget.scrollTop; | ||
| const totalScroll = evt.currentTarget.scrollHeight; | ||
| const currentScroll = top + evt.currentTarget.offsetHeight; | ||
|
|
||
| if (top === 0) { | ||
| evt.currentTarget.scrollTop = 1; | ||
| } else if (currentScroll === totalScroll) { | ||
| evt.currentTarget.scrollTop = top - 1; | ||
| } | ||
| } | ||
|
|
||
| render() { | ||
| const {title} = this.props; | ||
| const {open} = this.state; | ||
|
|
@@ -60,9 +128,10 @@ class StickyResponsiveSidebar extends Component { | |
| return ( | ||
| <div> | ||
| <div | ||
| className="scrollable" | ||
| style={{ | ||
| opacity: menuOpacity, | ||
| transition: 'opacity 0.2s ease', | ||
| }} | ||
| css={{ | ||
| [media.lessThan('small')]: smallScreenSidebarStyles, | ||
|
|
@@ -106,7 +175,7 @@ class StickyResponsiveSidebar extends Component { | |
| <div | ||
| style={{ | ||
| transform: `translate(0px, ${menuOffset}px)`, | ||
| transition: 'transform 0.2s 0.05s ease', | ||
| }} | ||
| css={{ | ||
| marginTop: 60, | ||
|
|
@@ -124,24 +193,35 @@ class StickyResponsiveSidebar extends Component { | |
| }, | ||
|
|
||
| [media.greaterThan('small')]: { | ||
| transform: 'none !important', | ||
| }, | ||
| }}> | ||
| <div | ||
| css={{ | ||
| [media.lessThan('small')]: { | ||
| // Extra scrolling space for iOS Safari | ||
| paddingBottom: this.state.open ? 150 : 0, | ||
| }, | ||
| }}> | ||
| <Sidebar {...this.props} /> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div | ||
| css={{ | ||
| backgroundColor: colors.darker, | ||
| bottom: 44, // iOS Safari's inert "bottom 44px" | ||
| color: colors.brand, | ||
| display: 'none', // gets overriden at small screen sizes | ||
| left: 20, | ||
| cursor: 'pointer', | ||
| position: 'fixed', | ||
| right: 20, | ||
| zIndex: 3, | ||
| maxWidth: 150, | ||
| marginLeft: 'auto', | ||
| borderRadius: 100, | ||
| border: '1px solid rgba(255, 255, 255, 0.1)', | ||
| [media.lessThan('small')]: smallScreenBottomBarStyles, | ||
| }} | ||
| onClick={this.toggleOpen}> | ||
|
|
@@ -168,17 +248,18 @@ class StickyResponsiveSidebar extends Component { | |
| alignSelf: 'center', | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| color: colors.white, | ||
| }}> | ||
| <ChevronSvg | ||
| cssProps={{ | ||
| transform: `translate(0, ${iconOffset}px) rotate(180deg)`, | ||
| transition: 'transform 0.2s 0.05s ease', | ||
| }} | ||
| /> | ||
| <ChevronSvg | ||
| cssProps={{ | ||
| transform: `translate(0, ${0 - iconOffset}px)`, | ||
| transition: 'transform 0.2s 0.05s ease', | ||
| }} | ||
| /> | ||
| </div> | ||
|
|
@@ -189,14 +270,23 @@ class StickyResponsiveSidebar extends Component { | |
| <div | ||
| style={{ | ||
| transform: `translate(0, ${labelOffset}px)`, | ||
| transition: 'transform 0.2s 0.05s ease', | ||
| }}> | ||
| <div | ||
| css={{ | ||
| height: 40, | ||
| lineHeight: '40px', | ||
| }}> | ||
| <span | ||
| css={{ | ||
| whiteSpace: 'nowrap', | ||
| textOverflow: 'ellipsis', | ||
| maxWidth: 90, | ||
| display: 'inline-block', | ||
| overflow: 'hidden', | ||
| }}> | ||
| {title} | ||
| </span> | ||
| </div> | ||
| <div | ||
| css={{ | ||
|
|
||
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to avoid global styles for this. I suggest we pass an
isOpenprop do this component instead and (probably) expose a toggle function to the sticky sidebar via context. (I'll be happy to help implement this change.)