2017-08-28 16:23:44 -04:00
|
|
|
import React, { PureComponent } from 'react';
|
2017-10-31 17:58:38 -04:00
|
|
|
import { ScrollContainer } from 'react-router-scroll-4';
|
2017-08-28 16:23:44 -04:00
|
|
|
import PropTypes from 'prop-types';
|
2017-12-04 02:26:40 -05:00
|
|
|
import IntersectionObserverArticleContainer from 'flavours/glitch/containers/intersection_observer_article_container';
|
2017-08-28 16:23:44 -04:00
|
|
|
import LoadMore from './load_more';
|
2017-12-04 02:26:40 -05:00
|
|
|
import IntersectionObserverWrapper from 'flavours/glitch/util/intersection_observer_wrapper';
|
2017-08-28 16:23:44 -04:00
|
|
|
import { throttle } from 'lodash';
|
2017-09-06 11:29:56 -04:00
|
|
|
import { List as ImmutableList } from 'immutable';
|
2017-10-01 21:01:01 -04:00
|
|
|
import classNames from 'classnames';
|
2017-12-04 02:26:40 -05:00
|
|
|
import { attachFullscreenListener, detachFullscreenListener, isFullscreen } from 'flavours/glitch/util/fullscreen';
|
2017-08-28 16:23:44 -04:00
|
|
|
|
|
|
|
export default class ScrollableList extends PureComponent {
|
|
|
|
|
2017-09-13 04:24:33 -04:00
|
|
|
static contextTypes = {
|
|
|
|
router: PropTypes.object,
|
|
|
|
};
|
|
|
|
|
2017-08-28 16:23:44 -04:00
|
|
|
static propTypes = {
|
|
|
|
scrollKey: PropTypes.string.isRequired,
|
2018-05-27 13:10:37 -04:00
|
|
|
onLoadMore: PropTypes.func,
|
2017-08-28 16:23:44 -04:00
|
|
|
onScrollToTop: PropTypes.func,
|
|
|
|
onScroll: PropTypes.func,
|
|
|
|
trackScroll: PropTypes.bool,
|
|
|
|
shouldUpdateScroll: PropTypes.func,
|
|
|
|
isLoading: PropTypes.bool,
|
|
|
|
hasMore: PropTypes.bool,
|
|
|
|
prepend: PropTypes.node,
|
|
|
|
emptyMessage: PropTypes.node,
|
|
|
|
children: PropTypes.node,
|
|
|
|
};
|
|
|
|
|
|
|
|
static defaultProps = {
|
|
|
|
trackScroll: true,
|
|
|
|
};
|
|
|
|
|
2017-09-08 20:26:41 -04:00
|
|
|
state = {
|
2018-04-15 12:46:23 -04:00
|
|
|
fullscreen: null,
|
2017-09-08 20:26:41 -04:00
|
|
|
};
|
|
|
|
|
2017-08-28 16:23:44 -04:00
|
|
|
intersectionObserverWrapper = new IntersectionObserverWrapper();
|
|
|
|
|
|
|
|
handleScroll = throttle(() => {
|
|
|
|
if (this.node) {
|
|
|
|
const { scrollTop, scrollHeight, clientHeight } = this.node;
|
|
|
|
const offset = scrollHeight - scrollTop - clientHeight;
|
|
|
|
|
2018-05-27 11:46:48 -04:00
|
|
|
if (400 > offset && this.props.onLoadMore && !this.props.isLoading) {
|
|
|
|
this.props.onLoadMore();
|
|
|
|
}
|
|
|
|
|
|
|
|
if (scrollTop < 100 && this.props.onScrollToTop) {
|
2017-08-28 16:23:44 -04:00
|
|
|
this.props.onScrollToTop();
|
|
|
|
} else if (this.props.onScroll) {
|
|
|
|
this.props.onScroll();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}, 150, {
|
|
|
|
trailing: true,
|
|
|
|
});
|
|
|
|
|
|
|
|
componentDidMount () {
|
|
|
|
this.attachScrollListener();
|
|
|
|
this.attachIntersectionObserver();
|
2017-10-01 21:01:01 -04:00
|
|
|
attachFullscreenListener(this.onFullScreenChange);
|
2017-08-28 16:23:44 -04:00
|
|
|
|
|
|
|
// Handle initial scroll posiiton
|
|
|
|
this.handleScroll();
|
|
|
|
}
|
|
|
|
|
2018-04-15 15:29:03 -04:00
|
|
|
getScrollPosition = () => {
|
|
|
|
if (this.node && this.node.scrollTop > 0) {
|
|
|
|
return {height: this.node.scrollHeight, top: this.node.scrollTop};
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
updateScrollBottom = (snapshot) => {
|
|
|
|
const newScrollTop = this.node.scrollHeight - snapshot;
|
|
|
|
|
|
|
|
if (this.node.scrollTop !== newScrollTop) {
|
|
|
|
this.node.scrollTop = newScrollTop;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-04-15 12:23:11 -04:00
|
|
|
getSnapshotBeforeUpdate (prevProps, prevState) {
|
2017-09-09 08:16:11 -04:00
|
|
|
const someItemInserted = React.Children.count(prevProps.children) > 0 &&
|
|
|
|
React.Children.count(prevProps.children) < React.Children.count(this.props.children) &&
|
|
|
|
this.getFirstChildKey(prevProps) !== this.getFirstChildKey(this.props);
|
2018-04-15 12:23:11 -04:00
|
|
|
if (someItemInserted && this.node.scrollTop > 0) {
|
|
|
|
return this.node.scrollHeight - this.node.scrollTop;
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
2017-09-09 08:16:11 -04:00
|
|
|
|
2018-04-15 12:23:11 -04:00
|
|
|
componentDidUpdate (prevProps, prevState, snapshot) {
|
2017-08-28 16:23:44 -04:00
|
|
|
// Reset the scroll position when a new child comes in in order not to
|
|
|
|
// jerk the scrollbar around if you're already scrolled down the page.
|
2018-04-15 15:29:03 -04:00
|
|
|
if (snapshot !== null) this.updateScrollBottom(snapshot);
|
2017-08-28 16:23:44 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
componentWillUnmount () {
|
|
|
|
this.detachScrollListener();
|
|
|
|
this.detachIntersectionObserver();
|
2017-10-01 21:01:01 -04:00
|
|
|
detachFullscreenListener(this.onFullScreenChange);
|
|
|
|
}
|
|
|
|
|
|
|
|
onFullScreenChange = () => {
|
|
|
|
this.setState({ fullscreen: isFullscreen() });
|
2017-08-28 16:23:44 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
attachIntersectionObserver () {
|
|
|
|
this.intersectionObserverWrapper.connect({
|
|
|
|
root: this.node,
|
|
|
|
rootMargin: '300% 0px',
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
detachIntersectionObserver () {
|
|
|
|
this.intersectionObserverWrapper.disconnect();
|
|
|
|
}
|
|
|
|
|
|
|
|
attachScrollListener () {
|
|
|
|
this.node.addEventListener('scroll', this.handleScroll);
|
|
|
|
}
|
|
|
|
|
|
|
|
detachScrollListener () {
|
|
|
|
this.node.removeEventListener('scroll', this.handleScroll);
|
|
|
|
}
|
|
|
|
|
|
|
|
getFirstChildKey (props) {
|
|
|
|
const { children } = props;
|
2017-09-06 11:29:56 -04:00
|
|
|
let firstChild = children;
|
|
|
|
if (children instanceof ImmutableList) {
|
|
|
|
firstChild = children.get(0);
|
|
|
|
} else if (Array.isArray(children)) {
|
|
|
|
firstChild = children[0];
|
|
|
|
}
|
2017-08-28 16:23:44 -04:00
|
|
|
return firstChild && firstChild.key;
|
|
|
|
}
|
|
|
|
|
|
|
|
setRef = (c) => {
|
|
|
|
this.node = c;
|
|
|
|
}
|
|
|
|
|
|
|
|
handleLoadMore = (e) => {
|
|
|
|
e.preventDefault();
|
2018-05-27 11:46:48 -04:00
|
|
|
this.props.onLoadMore();
|
2017-08-28 16:23:44 -04:00
|
|
|
}
|
|
|
|
|
2018-09-03 07:32:35 -04:00
|
|
|
defaultShouldUpdateScroll = (prevRouterProps, { location }) => {
|
|
|
|
return !(location.state && location.state.mastodonModalOpen);
|
|
|
|
}
|
|
|
|
|
2017-08-28 16:23:44 -04:00
|
|
|
render () {
|
2018-05-27 13:10:37 -04:00
|
|
|
const { children, scrollKey, trackScroll, shouldUpdateScroll, isLoading, hasMore, prepend, emptyMessage, onLoadMore } = this.props;
|
2017-10-01 21:01:01 -04:00
|
|
|
const { fullscreen } = this.state;
|
2017-08-28 16:23:44 -04:00
|
|
|
const childrenCount = React.Children.count(children);
|
|
|
|
|
2018-05-27 13:10:37 -04:00
|
|
|
const loadMore = (hasMore && childrenCount > 0 && onLoadMore) ? <LoadMore visible={!isLoading} onClick={this.handleLoadMore} /> : null;
|
2017-08-28 16:23:44 -04:00
|
|
|
let scrollableArea = null;
|
|
|
|
|
|
|
|
if (isLoading || childrenCount > 0 || !emptyMessage) {
|
|
|
|
scrollableArea = (
|
2018-04-15 12:46:23 -04:00
|
|
|
<div className={classNames('scrollable', { fullscreen })} ref={this.setRef}>
|
2017-10-05 19:07:59 -04:00
|
|
|
<div role='feed' className='item-list'>
|
2017-08-28 16:23:44 -04:00
|
|
|
{prepend}
|
|
|
|
|
|
|
|
{React.Children.map(this.props.children, (child, index) => (
|
2017-09-13 04:24:33 -04:00
|
|
|
<IntersectionObserverArticleContainer
|
|
|
|
key={child.key}
|
|
|
|
id={child.key}
|
|
|
|
index={index}
|
|
|
|
listLength={childrenCount}
|
|
|
|
intersectionObserverWrapper={this.intersectionObserverWrapper}
|
|
|
|
saveHeightKey={trackScroll ? `${this.context.router.route.location.key}:${scrollKey}` : null}
|
|
|
|
>
|
2018-04-15 15:29:03 -04:00
|
|
|
{React.cloneElement(child, {getScrollPosition: this.getScrollPosition, updateScrollBottom: this.updateScrollBottom})}
|
2017-09-13 04:24:33 -04:00
|
|
|
</IntersectionObserverArticleContainer>
|
2017-08-28 16:23:44 -04:00
|
|
|
))}
|
|
|
|
|
|
|
|
{loadMore}
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
scrollableArea = (
|
|
|
|
<div className='empty-column-indicator' ref={this.setRef}>
|
|
|
|
{emptyMessage}
|
|
|
|
</div>
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (trackScroll) {
|
|
|
|
return (
|
2018-09-03 07:32:35 -04:00
|
|
|
<ScrollContainer scrollKey={scrollKey} shouldUpdateScroll={shouldUpdateScroll || this.defaultShouldUpdateScroll}>
|
2017-08-28 16:23:44 -04:00
|
|
|
{scrollableArea}
|
|
|
|
</ScrollContainer>
|
|
|
|
);
|
|
|
|
} else {
|
|
|
|
return scrollableArea;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|