Last active
April 6, 2020 13:38
-
-
Save dohoons/127c6259c4d9a570412016d6f8ddca8d to your computer and use it in GitHub Desktop.
ScrollManager : https://github.com/ReactTraining/react-router/issues/3950
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
import React from 'react' | |
import { func, node, number, object, shape, string } from 'prop-types' | |
import { withRouter } from 'react-router-dom' | |
const debounce = (fn, time) => { | |
let timeout; | |
return function() { | |
const functionCall = () => fn.apply(this, arguments) | |
clearTimeout(timeout) | |
timeout = setTimeout(functionCall, time) | |
} | |
} | |
class ScrollManager extends React.Component { | |
static propTypes = { | |
children: node.isRequired, | |
history: shape({ | |
action: string.isRequired, | |
push: func.isRequired, | |
replace: func.isRequired | |
}).isRequired, | |
basename: string, | |
location: object, | |
onLocationChange: func, | |
scrollCaptureDebounce: number, | |
scrollSyncDebounce: number, | |
scrollSyncAttemptLimit: number | |
} | |
static defaultProps = { | |
basename: '', | |
scrollCaptureDebounce: 50, | |
scrollSyncDebounce: 100, | |
scrollSyncAttemptLimit: 5 | |
} | |
constructor (props) { | |
super(props) | |
this.scrollSyncData = { | |
x: 0, | |
y: 0, | |
attemptsRemaining: props.scrollSyncAttemptLimit | |
} | |
const scrollCapture = () => { | |
requestAnimationFrame(() => { | |
const { pageXOffset: x, pageYOffset: y } = window | |
const { pathname, search, hash } = this.props.location | |
// use browser history instead of router history | |
// to avoid infinite history.replace loop | |
const historyState = window.history.state || {} | |
const { state = {} } = historyState | |
if (!state.scroll || state.scroll.x !== window.pageXOffset || state.scroll.y !== window.pageYOffset) { | |
window.history.replaceState( | |
{ | |
...historyState, | |
state: { ...state, scroll: { x, y } } | |
}, | |
null, | |
`${this.props.basename}${pathname}${search}${hash}` | |
) | |
} | |
}) | |
} | |
const _scrollSync = () => { | |
requestAnimationFrame(() => { | |
const { x, y, attemptsRemaining } = this.scrollSyncData | |
if (attemptsRemaining < 1) { | |
return | |
} | |
const { pageXOffset, pageYOffset } = window | |
if (y < window.document.body.scrollHeight && (x !== pageXOffset || y !== pageYOffset)) { | |
window.scrollTo(x, y) | |
this.scrollSyncData.attemptsRemaining = attemptsRemaining - 1 | |
_scrollSync() | |
} | |
}) | |
} | |
const scrollSync = (x = 0, y = 0) => { | |
this.scrollSyncData = { x, y, attemptsRemaining: this.props.scrollSyncAttemptLimit } | |
_scrollSync() | |
} | |
this.debouncedScroll = debounce(scrollCapture, props.scrollCaptureDebounce) | |
this.debouncedScrollSync = debounce(scrollSync, props.scrollSyncDebounce) | |
} | |
componentDidMount () { | |
const { location, onLocationChange } = this.props | |
if (onLocationChange) { | |
onLocationChange(location) | |
} | |
this.onPop(this.props) | |
window.addEventListener('scroll', this.debouncedScroll, { passive: true }) | |
} | |
componentWillUnmount () { | |
this.scrollSyncPending = false | |
window.removeEventListener('scroll', this.debouncedScroll, { passive: true }) | |
} | |
componentDidUpdate() { | |
switch (this.props.history.action) { | |
case 'PUSH': | |
case 'REPLACE': this.onPush(); break | |
case 'POP': this.onPop(this.props); break | |
default: | |
console.warn(`Unrecognized location change action! "${this.props.history.action}"`) | |
} | |
if (this.props.onLocationChange) { | |
this.props.onLocationChange(this.props.location) | |
} | |
} | |
onPush () { | |
this.debouncedScrollSync(0, 0) | |
} | |
onPop ({ location: { state = {} } }) { | |
// attempt location restore | |
const { x = 0, y = 0 } = state.scroll || {} | |
this.debouncedScrollSync(x, y) | |
} | |
render () { | |
return this.props.children | |
} | |
} | |
export default withRouter(ScrollManager) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment