kopia lustrzana https://gitlab.com/soapbox-pub/soapbox
Reimplement ScrollableList with Virtuoso
Alex Gleason
rodzic
0658c51058
commit
b3f4abc8c1
|
|
@ -1,347 +0,0 @@
|
||||||
import classNames from 'classnames';
|
|
||||||
import { List as ImmutableList } from 'immutable';
|
|
||||||
import { throttle } from 'lodash';
|
|
||||||
import PropTypes from 'prop-types';
|
|
||||||
import React, { PureComponent } from 'react';
|
|
||||||
import { connect } from 'react-redux';
|
|
||||||
import { withRouter } from 'react-router-dom';
|
|
||||||
|
|
||||||
import { getSettings } from 'soapbox/actions/settings';
|
|
||||||
import PullToRefresh from 'soapbox/components/pull-to-refresh';
|
|
||||||
|
|
||||||
import IntersectionObserverArticleContainer from '../containers/intersection_observer_article_container';
|
|
||||||
import IntersectionObserverWrapper from '../features/ui/util/intersection_observer_wrapper';
|
|
||||||
|
|
||||||
import LoadMore from './load_more';
|
|
||||||
import MoreFollows from './more_follows';
|
|
||||||
import { Spinner, Text } from './ui';
|
|
||||||
|
|
||||||
const MOUSE_IDLE_DELAY = 300;
|
|
||||||
|
|
||||||
const mapStateToProps = state => {
|
|
||||||
const settings = getSettings(state);
|
|
||||||
|
|
||||||
return {
|
|
||||||
autoload: settings.get('autoloadMore'),
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
export default @connect(mapStateToProps, null, null, { forwardRef: true })
|
|
||||||
@withRouter
|
|
||||||
class ScrollableList extends PureComponent {
|
|
||||||
|
|
||||||
static propTypes = {
|
|
||||||
scrollKey: PropTypes.string.isRequired,
|
|
||||||
onLoadMore: PropTypes.func,
|
|
||||||
isLoading: PropTypes.bool,
|
|
||||||
showLoading: PropTypes.bool,
|
|
||||||
hasMore: PropTypes.bool,
|
|
||||||
diffCount: PropTypes.number,
|
|
||||||
prepend: PropTypes.node,
|
|
||||||
alwaysPrepend: PropTypes.bool,
|
|
||||||
emptyMessage: PropTypes.node,
|
|
||||||
children: PropTypes.node,
|
|
||||||
onScrollToTop: PropTypes.func,
|
|
||||||
onScroll: PropTypes.func,
|
|
||||||
placeholderComponent: PropTypes.object,
|
|
||||||
placeholderCount: PropTypes.number,
|
|
||||||
autoload: PropTypes.bool,
|
|
||||||
onRefresh: PropTypes.func,
|
|
||||||
className: PropTypes.string,
|
|
||||||
location: PropTypes.object,
|
|
||||||
};
|
|
||||||
|
|
||||||
state = {
|
|
||||||
cachedMediaWidth: 250, // Default media/card width using default theme
|
|
||||||
};
|
|
||||||
|
|
||||||
intersectionObserverWrapper = new IntersectionObserverWrapper();
|
|
||||||
|
|
||||||
mouseIdleTimer = null;
|
|
||||||
mouseMovedRecently = false;
|
|
||||||
lastScrollWasSynthetic = false;
|
|
||||||
scrollToTopOnMouseIdle = false;
|
|
||||||
|
|
||||||
setScrollTop = newScrollTop => {
|
|
||||||
if (this.documentElement.scrollTop !== newScrollTop) {
|
|
||||||
this.lastScrollWasSynthetic = true;
|
|
||||||
this.documentElement.scrollTop = newScrollTop;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
clearMouseIdleTimer = () => {
|
|
||||||
if (this.mouseIdleTimer === null) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
clearTimeout(this.mouseIdleTimer);
|
|
||||||
this.mouseIdleTimer = null;
|
|
||||||
};
|
|
||||||
|
|
||||||
handleMouseMove = throttle(() => {
|
|
||||||
// As long as the mouse keeps moving, clear and restart the idle timer.
|
|
||||||
this.clearMouseIdleTimer();
|
|
||||||
this.mouseIdleTimer = setTimeout(this.handleMouseIdle, MOUSE_IDLE_DELAY);
|
|
||||||
|
|
||||||
if (!this.mouseMovedRecently && this.documentElement.scrollTop === 0) {
|
|
||||||
// Only set if we just started moving and are scrolled to the top.
|
|
||||||
this.scrollToTopOnMouseIdle = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Save setting this flag for last, so we can do the comparison above.
|
|
||||||
this.mouseMovedRecently = true;
|
|
||||||
}, MOUSE_IDLE_DELAY / 2);
|
|
||||||
|
|
||||||
handleMouseIdle = () => {
|
|
||||||
if (this.scrollToTopOnMouseIdle) {
|
|
||||||
this.setScrollTop(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.mouseMovedRecently = false;
|
|
||||||
this.scrollToTopOnMouseIdle = false;
|
|
||||||
}
|
|
||||||
|
|
||||||
componentDidMount() {
|
|
||||||
this.window = window;
|
|
||||||
this.documentElement = document.scrollingElement || document.documentElement;
|
|
||||||
|
|
||||||
this.attachScrollListener();
|
|
||||||
this.attachIntersectionObserver();
|
|
||||||
// Handle initial scroll position
|
|
||||||
this.handleScroll();
|
|
||||||
}
|
|
||||||
|
|
||||||
getScrollPosition = () => {
|
|
||||||
if (this.documentElement && (this.documentElement.scrollTop > 0 || this.mouseMovedRecently)) {
|
|
||||||
return { height: this.documentElement.scrollHeight, top: this.documentElement.scrollTop };
|
|
||||||
} else {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
updateScrollBottom = (snapshot) => {
|
|
||||||
const newScrollTop = this.documentElement.scrollHeight - snapshot;
|
|
||||||
|
|
||||||
this.setScrollTop(newScrollTop);
|
|
||||||
}
|
|
||||||
|
|
||||||
componentDidUpdate(prevProps, prevState, snapshot) {
|
|
||||||
// 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.
|
|
||||||
if (snapshot !== null) {
|
|
||||||
this.setScrollTop(this.documentElement.scrollHeight - snapshot);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
attachScrollListener() {
|
|
||||||
this.window.addEventListener('scroll', this.handleScroll);
|
|
||||||
this.window.addEventListener('wheel', this.handleWheel);
|
|
||||||
}
|
|
||||||
|
|
||||||
detachScrollListener() {
|
|
||||||
this.window.removeEventListener('scroll', this.handleScroll);
|
|
||||||
this.window.removeEventListener('wheel', this.handleWheel);
|
|
||||||
}
|
|
||||||
|
|
||||||
handleScroll = throttle(() => {
|
|
||||||
const { autoload } = this.props;
|
|
||||||
|
|
||||||
if (this.window) {
|
|
||||||
const { scrollTop, scrollHeight } = this.documentElement;
|
|
||||||
const { innerHeight } = this.window;
|
|
||||||
const offset = scrollHeight - scrollTop - innerHeight;
|
|
||||||
|
|
||||||
if (autoload && 400 > offset && this.props.onLoadMore && this.props.hasMore && !this.props.isLoading) {
|
|
||||||
this.props.onLoadMore();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (scrollTop < 100 && this.props.onScrollToTop) {
|
|
||||||
this.props.onScrollToTop();
|
|
||||||
} else if (this.props.onScroll) {
|
|
||||||
this.props.onScroll();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!this.lastScrollWasSynthetic) {
|
|
||||||
// If the last scroll wasn't caused by setScrollTop(), assume it was
|
|
||||||
// intentional and cancel any pending scroll reset on mouse idle
|
|
||||||
this.scrollToTopOnMouseIdle = false;
|
|
||||||
}
|
|
||||||
this.lastScrollWasSynthetic = false;
|
|
||||||
}
|
|
||||||
}, 150, {
|
|
||||||
trailing: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
handleWheel = throttle(() => {
|
|
||||||
this.scrollToTopOnMouseIdle = false;
|
|
||||||
}, 150, {
|
|
||||||
trailing: true,
|
|
||||||
});
|
|
||||||
|
|
||||||
getSnapshotBeforeUpdate(prevProps) {
|
|
||||||
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);
|
|
||||||
|
|
||||||
if (someItemInserted && (this.documentElement.scrollTop > 0 || this.mouseMovedRecently)) {
|
|
||||||
return this.documentElement.scrollHeight - this.documentElement.scrollTop;
|
|
||||||
} else {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
cacheMediaWidth = (width) => {
|
|
||||||
if (width && this.state.cachedMediaWidth !== width) {
|
|
||||||
this.setState({ cachedMediaWidth: width });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
componentWillUnmount() {
|
|
||||||
this.clearMouseIdleTimer();
|
|
||||||
this.detachScrollListener();
|
|
||||||
this.detachIntersectionObserver();
|
|
||||||
}
|
|
||||||
|
|
||||||
attachIntersectionObserver() {
|
|
||||||
this.intersectionObserverWrapper.connect();
|
|
||||||
}
|
|
||||||
|
|
||||||
detachIntersectionObserver() {
|
|
||||||
this.intersectionObserverWrapper.disconnect();
|
|
||||||
}
|
|
||||||
|
|
||||||
getFirstChildKey(props) {
|
|
||||||
const { children } = props;
|
|
||||||
let firstChild = children;
|
|
||||||
|
|
||||||
if (children instanceof ImmutableList) {
|
|
||||||
firstChild = children.get(0);
|
|
||||||
} else if (Array.isArray(children)) {
|
|
||||||
firstChild = children[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
return firstChild && firstChild.key;
|
|
||||||
}
|
|
||||||
|
|
||||||
handleLoadMore = e => {
|
|
||||||
e.preventDefault();
|
|
||||||
this.props.onLoadMore();
|
|
||||||
}
|
|
||||||
|
|
||||||
getMoreFollows = () => {
|
|
||||||
const { scrollKey, isLoading, diffCount, hasMore } = this.props;
|
|
||||||
const isMoreFollows = ['followers', 'following'].some(k => k === scrollKey);
|
|
||||||
if (!(diffCount && isMoreFollows)) return null;
|
|
||||||
if (hasMore) return null;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<MoreFollows visible={!isLoading} count={diffCount} type={scrollKey} />
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
setRef = c => {
|
|
||||||
this.node = c;
|
|
||||||
}
|
|
||||||
|
|
||||||
renderLoading = () => {
|
|
||||||
const { className, prepend, placeholderComponent: Placeholder, placeholderCount } = this.props;
|
|
||||||
|
|
||||||
if (Placeholder && placeholderCount > 0) {
|
|
||||||
return (
|
|
||||||
<div role='feed' className={className}>
|
|
||||||
{Array(placeholderCount).fill().map((_, i) => (
|
|
||||||
<Placeholder key={i} />
|
|
||||||
))}
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className={classNames('slist slist--flex', className)}>
|
|
||||||
<div role='feed' className='item-list'>
|
|
||||||
{prepend}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div className='slist__append'>
|
|
||||||
<Spinner />
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
renderEmptyMessage = () => {
|
|
||||||
const { className, prepend, alwaysPrepend, emptyMessage } = this.props;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div className={classNames('mt-2', className)} ref={this.setRef}>
|
|
||||||
{alwaysPrepend && prepend}
|
|
||||||
|
|
||||||
<div className='bg-primary-50 dark:bg-slate-700 mt-2 rounded-lg text-center p-8'>
|
|
||||||
<Text>{emptyMessage}</Text>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
renderFeed = () => {
|
|
||||||
const { className, children, scrollKey, isLoading, hasMore, prepend, onLoadMore, onRefresh, placeholderComponent: Placeholder } = this.props;
|
|
||||||
const childrenCount = React.Children.count(children);
|
|
||||||
const trackScroll = true; //placeholder
|
|
||||||
const loadMore = (hasMore && onLoadMore) ? <LoadMore visible={!isLoading} onClick={this.handleLoadMore} /> : null;
|
|
||||||
|
|
||||||
const feed = (
|
|
||||||
<div ref={this.setRef} onMouseMove={this.handleMouseMove}>
|
|
||||||
<div role='feed' className={className}>
|
|
||||||
{prepend}
|
|
||||||
|
|
||||||
{React.Children.map(children, (child, index) => (
|
|
||||||
<IntersectionObserverArticleContainer
|
|
||||||
key={child.key}
|
|
||||||
id={child.key}
|
|
||||||
index={index}
|
|
||||||
listLength={childrenCount}
|
|
||||||
intersectionObserverWrapper={this.intersectionObserverWrapper}
|
|
||||||
saveHeightKey={trackScroll ? `${this.props.location.key}:${scrollKey}` : null}
|
|
||||||
>
|
|
||||||
{React.cloneElement(child, {
|
|
||||||
getScrollPosition: this.getScrollPosition,
|
|
||||||
updateScrollBottom: this.updateScrollBottom,
|
|
||||||
cachedMediaWidth: this.state.cachedMediaWidth,
|
|
||||||
cacheMediaWidth: this.cacheMediaWidth,
|
|
||||||
})}
|
|
||||||
</IntersectionObserverArticleContainer>
|
|
||||||
))}
|
|
||||||
{(isLoading && Placeholder) && (
|
|
||||||
<Placeholder />
|
|
||||||
)}
|
|
||||||
{this.getMoreFollows()}
|
|
||||||
{loadMore}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
|
|
||||||
if (onRefresh) {
|
|
||||||
return (
|
|
||||||
<PullToRefresh onRefresh={onRefresh}>
|
|
||||||
{feed}
|
|
||||||
</PullToRefresh>
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
return feed;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
render() {
|
|
||||||
const { children, showLoading, isLoading, hasMore, emptyMessage } = this.props;
|
|
||||||
const childrenCount = React.Children.count(children);
|
|
||||||
|
|
||||||
if (showLoading) {
|
|
||||||
return this.renderLoading();
|
|
||||||
} else if (isLoading || childrenCount > 0 || hasMore || !emptyMessage) {
|
|
||||||
return this.renderFeed();
|
|
||||||
} else {
|
|
||||||
return this.renderEmptyMessage();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
@ -0,0 +1,87 @@
|
||||||
|
import React from 'react';
|
||||||
|
import { Virtuoso } from 'react-virtuoso';
|
||||||
|
|
||||||
|
import PullToRefresh from 'soapbox/components/pull-to-refresh';
|
||||||
|
// import { useSettings } from 'soapbox/hooks';
|
||||||
|
|
||||||
|
import { Spinner, Text } from './ui';
|
||||||
|
|
||||||
|
const List = React.forwardRef((props: any, ref: React.ForwardedRef<HTMLDivElement>) => {
|
||||||
|
const { context, ...rest } = props;
|
||||||
|
return <div ref={ref} className={context.listClassName} {...rest} />;
|
||||||
|
});
|
||||||
|
|
||||||
|
interface IScrollableList {
|
||||||
|
scrollKey?: string,
|
||||||
|
onLoadMore?: () => void,
|
||||||
|
isLoading?: boolean,
|
||||||
|
showLoading?: boolean,
|
||||||
|
hasMore?: boolean,
|
||||||
|
prepend?: React.ReactElement,
|
||||||
|
alwaysPrepend?: boolean,
|
||||||
|
emptyMessage?: React.ReactNode,
|
||||||
|
children: Iterable<React.ReactNode>,
|
||||||
|
onScrollToTop?: () => void,
|
||||||
|
onScroll?: () => void,
|
||||||
|
placeholderComponent?: React.ComponentType,
|
||||||
|
placeholderCount?: number,
|
||||||
|
onRefresh?: () => Promise<any>,
|
||||||
|
className?: string,
|
||||||
|
}
|
||||||
|
|
||||||
|
const ScrollableList: React.FC<IScrollableList> = ({
|
||||||
|
prepend = null,
|
||||||
|
children,
|
||||||
|
isLoading,
|
||||||
|
emptyMessage,
|
||||||
|
showLoading,
|
||||||
|
onRefresh,
|
||||||
|
onScroll,
|
||||||
|
onScrollToTop,
|
||||||
|
onLoadMore,
|
||||||
|
className,
|
||||||
|
placeholderComponent: Placeholder,
|
||||||
|
placeholderCount = 0,
|
||||||
|
}) => {
|
||||||
|
// const settings = useSettings();
|
||||||
|
// const autoload = settings.get('autoloadMore');
|
||||||
|
|
||||||
|
const showPlaceholder = showLoading && Placeholder && placeholderCount > 0;
|
||||||
|
|
||||||
|
const renderItem = (_i: number, element: JSX.Element) => {
|
||||||
|
if (showPlaceholder) {
|
||||||
|
return <Placeholder />;
|
||||||
|
} else {
|
||||||
|
return element;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<PullToRefresh onRefresh={onRefresh}>
|
||||||
|
<Virtuoso
|
||||||
|
useWindowScroll
|
||||||
|
className={className}
|
||||||
|
data={showPlaceholder ? Array(placeholderCount).fill('') : Array.from(children)}
|
||||||
|
startReached={onScrollToTop}
|
||||||
|
endReached={onLoadMore}
|
||||||
|
isScrolling={isScrolling => isScrolling && onScroll && onScroll()}
|
||||||
|
itemContent={renderItem}
|
||||||
|
context={{
|
||||||
|
listClassName: className,
|
||||||
|
}}
|
||||||
|
components={{
|
||||||
|
Header: () => prepend,
|
||||||
|
ScrollSeekPlaceholder: Placeholder as any,
|
||||||
|
EmptyPlaceholder: () => isLoading ? (
|
||||||
|
<Spinner />
|
||||||
|
) : (
|
||||||
|
<Text>{emptyMessage}</Text>
|
||||||
|
),
|
||||||
|
List,
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</PullToRefresh>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default ScrollableList;
|
||||||
Ładowanie…
Reference in New Issue