/** * Copyright (c) 2015-present, Facebook, Inc. * All rights reserved. * * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. An additional grant * of patent rights can be found in the PATENTS file in the same directory. * * @providesModule VirtualizedList * @flow */ 'use strict'; const Batchinator = require('Batchinator'); const React = require('React'); const ReactNative = require('ReactNative'); const RefreshControl = require('RefreshControl'); const ScrollView = require('ScrollView'); const View = require('View'); const ViewabilityHelper = require('ViewabilityHelper'); const infoLog = require('infoLog'); const invariant = require('fbjs/lib/invariant'); const {computeWindowedRenderLimits} = require('VirtualizeUtils'); import type {ViewabilityConfig, ViewToken} from 'ViewabilityHelper'; type Item = any; type renderItemType = (info: {item: Item, index: number}) => ?React.Element; type RequiredProps = { renderItem: renderItemType, /** * The default accessor functions assume this is an Array<{key: string}> but you can override * getItem, getItemCount, and keyExtractor to handle any type of index-based data. */ data?: any, }; type OptionalProps = { /** * `debug` will turn on extra logging and visual overlays to aid with debugging both usage and * implementation, but with a significant perf hit. */ debug?: ?boolean, /** * DEPRECATED: Virtualization provides significant performance and memory optimizations, but fully * unmounts react instances that are outside of the render window. You should only need to disable * this for debugging purposes. */ disableVirtualization: boolean, /** * A marker property for telling the list to re-render (since it implements `PureComponent`). If * any of your `renderItem`, Header, Footer, etc. functions depend on anything outside of the * `data` prop, stick it here and treat it immutably. */ extraData?: any, /** * A generic accessor for extracting an item from any sort of data blob. */ getItem: (data: any, index: number) => ?Item, /** * Determines how many items are in the data blob. */ getItemCount: (data: any) => number, getItemLayout?: (data: any, index: number) => {length: number, offset: number, index: number}, // e.g. height, y horizontal?: ?boolean, /** * How many items to render in the initial batch. This should be enough to fill the screen but not * much more. Note these items will never be unmounted as part of the windowed rendering in order * to improve perceived performance of scroll-to-top actions. */ initialNumToRender: number, keyExtractor: (item: Item, index: number) => string, /** * The maximum number of items to render in each incremental render batch. The more rendered at * once, the better the fill rate, but responsiveness my suffer because rendering content may * interfere with responding to button taps or other interactions. */ maxToRenderPerBatch: number, onEndReached?: ?(info: {distanceFromEnd: number}) => void, onEndReachedThreshold?: ?number, // units of visible length onLayout?: ?Function, /** * If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. Make * sure to also set the `refreshing` prop correctly. */ onRefresh?: ?Function, /** * Called when the viewability of rows changes, as defined by the * `viewabilityConfig` prop. */ onViewableItemsChanged?: ?(info: { viewableItems: Array, changed: Array, }) => void, /** * Set this true while waiting for new data from a refresh. */ refreshing?: ?boolean, /** * A native optimization that removes clipped subviews (those outside the parent) from the view * hierarchy to offload work from the native rendering system. They are still kept around so no * memory is saved and state is preserved. */ removeClippedSubviews?: boolean, /** * Render a custom scroll component, e.g. with a differently styled `RefreshControl`. */ renderScrollComponent: (props: Object) => React.Element, /** * Amount of time between low-pri item render batches, e.g. for rendering items quite a ways off * screen. Similar fill rate/responsiveness tradeoff as `maxToRenderPerBatch`. */ updateCellsBatchingPeriod: number, viewabilityConfig?: ViewabilityConfig, /** * Determines the maximum number of items rendered outside of the visible area, in units of * visible lengths. So if your list fills the screen, then `windowSize={21}` (the default) will * render the visible screen area plus up to 10 screens above and 10 below the viewport. Reducing * this number will reduce memory consumption and may improve performance, but will increase the * chance that fast scrolling may reveal momentary blank areas of unrendered content. */ windowSize: number, }; export type Props = RequiredProps & OptionalProps; let _usedIndexForKey = false; type State = {first: number, last: number}; /** * Base implementation for the more convenient [``](/react-native/docs/flatlist.html) * and [``](/react-native/docs/sectionlist.html) components, which are also better * documented. In general, this should only really be used if you need more flexibility than * `FlatList` provides, e.g. for use with immutable data instead of plain arrays. * * Virtualization massively improves memory consumption and performance of large lists by * maintaining a finite render window of active items and replacing all items outside of the render * window with appropriately sized blank space. The window adapts to scrolling behavior, and items * are rendered incrementally with low-pri (after any running interactions) if they are far from the * visible area, or with hi-pri otherwise to minimize the potential of seeing blank space. * * Some caveats: * * - Internal state is not preserved when content scrolls out of the render window. Make sure all * your data is captured in the item data or external stores like Flux, Redux, or Relay. * - This is a `PureComponent` which means that it will not re-render if `props` remain shallow- * equal. Make sure that everything your `renderItem` function depends on is passed as a prop that * is not `===` after updates, otherwise your UI may not update on changes. This includes the * `data` prop and parent component state. * - In order to constrain memory and enable smooth scrolling, content is rendered asynchronously * offscreen. This means it's possible to scroll faster than the fill rate ands momentarily see * blank content. This is a tradeoff that can be adjusted to suit the needs of each application, * and we are working on improving it behind the scenes. * - By default, the list looks for a `key` prop on each item and uses that for the React key. * Alternatively, you can provide a custom `keyExtractor` prop. * * NOTE: `LayoutAnimation` and sticky section headers both have bugs when used with this and are * therefore not officially supported yet. * * NOTE: `removeClippedSubviews` might not be necessary and may cause bugs. If you see issues with * content not rendering, try disabling it, and we may change the default there. */ class VirtualizedList extends React.PureComponent { props: Props; // scrollToEnd may be janky without getItemLayout prop scrollToEnd(params?: ?{animated?: ?boolean}) { const animated = params ? params.animated : true; const veryLast = this.props.getItemCount(this.props.data) - 1; const frame = this._getFrameMetricsApprox(veryLast); const offset = frame.offset + frame.length + this._footerLength - this._scrollMetrics.visibleLength; this._scrollRef.scrollTo( this.props.horizontal ? {x: offset, animated} : {y: offset, animated} ); } // scrollToIndex may be janky without getItemLayout prop scrollToIndex(params: {animated?: ?boolean, index: number, viewPosition?: number}) { const {data, horizontal, getItemCount, getItemLayout} = this.props; const {animated, index, viewPosition} = params; invariant( index >= 0 && index < getItemCount(data), `scrollToIndex out of range: ${index} vs ${getItemCount(data) - 1}`, ); invariant( getItemLayout || index < this._highestMeasuredFrameIndex, 'scrollToIndex should be used in conjunction with getItemLayout, ' + 'otherwise there is no way to know the location of an arbitrary index.', ); const frame = this._getFrameMetricsApprox(index); const offset = Math.max( 0, frame.offset - (viewPosition || 0) * (this._scrollMetrics.visibleLength - frame.length), ); this._scrollRef.scrollTo(horizontal ? {x: offset, animated} : {y: offset, animated}); } // scrollToItem may be janky without getItemLayout prop. Required linear scan through items - // use scrollToIndex instead if possible. scrollToItem(params: {animated?: ?boolean, item: Item, viewPosition?: number}) { const {item} = params; const {data, getItem, getItemCount} = this.props; const itemCount = getItemCount(data); for (let index = 0; index < itemCount; index++) { if (getItem(data, index) === item) { this.scrollToIndex({...params, index}); break; } } } scrollToOffset(params: {animated?: ?boolean, offset: number}) { const {animated, offset} = params; this._scrollRef.scrollTo( this.props.horizontal ? {x: offset, animated} : {y: offset, animated} ); } recordInteraction() { this._viewabilityHelper.recordInteraction(); this._updateViewableItems(this.props.data); } getScrollableNode() { if (this._scrollRef && this._scrollRef.getScrollableNode) { return this._scrollRef.getScrollableNode(); } else { return ReactNative.findNodeHandle(this._scrollRef); } } static defaultProps = { disableVirtualization: false, getItem: (data: any, index: number) => data[index], getItemCount: (data: any) => data ? data.length : 0, horizontal: false, initialNumToRender: 10, keyExtractor: (item: Item, index: number) => { if (item.key != null) { return item.key; } _usedIndexForKey = true; return String(index); }, maxToRenderPerBatch: 10, onEndReached: () => {}, onEndReachedThreshold: 2, // multiples of length removeClippedSubviews: true, renderScrollComponent: (props: Props) => { if (props.onRefresh) { invariant( typeof props.refreshing === 'boolean', '`refreshing` prop must be set as a boolean in order to use `onRefresh`, but got `' + JSON.stringify(props.refreshing) + '`', ); return ( } /> ); } else { return ; } }, updateCellsBatchingPeriod: 50, windowSize: 21, // multiples of length }; state: State = { first: 0, last: this.props.initialNumToRender, }; constructor(props: Props) { super(props); invariant( !props.onScroll || !props.onScroll.__isNative, 'Components based on VirtualizedList must be wrapped with Animated.createAnimatedComponent ' + 'to support native onScroll events with useNativeDriver', ); this._updateCellsToRenderBatcher = new Batchinator( this._updateCellsToRender, this.props.updateCellsBatchingPeriod, ); this._viewabilityHelper = new ViewabilityHelper(this.props.viewabilityConfig); this.state = { first: 0, last: Math.min(this.props.getItemCount(this.props.data), this.props.initialNumToRender) - 1, }; } componentWillUnmount() { this._updateViewableItems(null); this._updateCellsToRenderBatcher.dispose(); this._viewabilityHelper.dispose(); } componentWillReceiveProps(newProps: Props) { const {data, extraData, getItemCount, maxToRenderPerBatch} = newProps; // first and last could be stale (e.g. if a new, shorter items props is passed in), so we make // sure we're rendering a reasonable range here. this.setState({ first: Math.max(0, Math.min(this.state.first, getItemCount(data) - 1 - maxToRenderPerBatch)), last: Math.max(0, Math.min(this.state.last, getItemCount(data) - 1)), }); if (data !== this.props.data || extraData !== this.props.extraData) { this._hasDataChangedSinceEndReached = true; } this._updateCellsToRenderBatcher.schedule(); } _pushCells( cells: Array, stickyHeaderIndices: Array, stickyIndicesFromProps: Set, first: number, last: number, ) { const {ItemSeparatorComponent, data, getItem, getItemCount, keyExtractor} = this.props; const stickyOffset = this.props.ListHeaderComponent ? 1 : 0; const end = getItemCount(data) - 1; last = Math.min(end, last); for (let ii = first; ii <= last; ii++) { const item = getItem(data, ii); invariant(item, 'No item for index ' + ii); const key = keyExtractor(item, ii); if (stickyIndicesFromProps.has(ii + stickyOffset)) { stickyHeaderIndices.push(cells.length); } cells.push( this._onCellLayout(e, key, ii)} onUnmount={this._onCellUnmount} parentProps={this.props} /> ); if (ItemSeparatorComponent && ii < end) { cells.push(); } } } render() { const {ListFooterComponent, ListHeaderComponent} = this.props; const {data, disableVirtualization, horizontal} = this.props; const cells = []; const stickyIndicesFromProps = new Set(this.props.stickyHeaderIndices); const stickyHeaderIndices = []; if (ListHeaderComponent) { cells.push( ); } const itemCount = this.props.getItemCount(data); if (itemCount > 0) { _usedIndexForKey = false; const spacerKey = !horizontal ? 'height' : 'width'; const lastInitialIndex = this.props.initialNumToRender - 1; const {first, last} = this.state; this._pushCells(cells, stickyHeaderIndices, stickyIndicesFromProps, 0, lastInitialIndex); const firstAfterInitial = Math.max(lastInitialIndex + 1, first); if (!disableVirtualization && first > lastInitialIndex + 1) { let insertedStickySpacer = false; if (stickyIndicesFromProps.size > 0) { const stickyOffset = ListHeaderComponent ? 1 : 0; // See if there are any sticky headers in the virtualized space that we need to render. for (let ii = firstAfterInitial - 1; ii > lastInitialIndex; ii--) { if (stickyIndicesFromProps.has(ii + stickyOffset)) { const initBlock = this._getFrameMetricsApprox(lastInitialIndex); const stickyBlock = this._getFrameMetricsApprox(ii); const leadSpace = stickyBlock.offset - (initBlock.offset + initBlock.length); cells.push( ); this._pushCells(cells, stickyHeaderIndices, stickyIndicesFromProps, ii, ii); const trailSpace = this._getFrameMetricsApprox(first).offset - (stickyBlock.offset + stickyBlock.length); cells.push( ); insertedStickySpacer = true; break; } } } if (!insertedStickySpacer) { const initBlock = this._getFrameMetricsApprox(lastInitialIndex); const firstSpace = this._getFrameMetricsApprox(first).offset - (initBlock.offset + initBlock.length); cells.push( ); } } this._pushCells(cells, stickyHeaderIndices, stickyIndicesFromProps, firstAfterInitial, last); if (!this._hasWarned.keys && _usedIndexForKey) { console.warn( 'VirtualizedList: missing keys for items, make sure to specify a key property on each ' + 'item or provide a custom keyExtractor.' ); this._hasWarned.keys = true; } if (!disableVirtualization && last < itemCount - 1) { const lastFrame = this._getFrameMetricsApprox(last); // Without getItemLayout, we limit our tail spacer to the _highestMeasuredFrameIndex to // prevent the user for hyperscrolling into un-measured area because otherwise content will // likely jump around as it renders in above the viewport. const end = this.props.getItemLayout ? itemCount - 1 : Math.min(itemCount - 1, this._highestMeasuredFrameIndex); const endFrame = this._getFrameMetricsApprox(end); const tailSpacerLength = (endFrame.offset + endFrame.length) - (lastFrame.offset + lastFrame.length); cells.push( ); } } if (ListFooterComponent) { cells.push( ); } const ret = React.cloneElement( this.props.renderScrollComponent(this.props), { onContentSizeChange: this._onContentSizeChange, onLayout: this._onLayout, onScroll: this._onScroll, onScrollBeginDrag: this._onScrollBeginDrag, ref: this._captureScrollRef, scrollEventThrottle: 50, // TODO: Android support stickyHeaderIndices, }, cells, ); if (this.props.debug) { return {ret}{this._renderDebugOverlay()}; } else { return ret; } } componentDidUpdate() { this._updateCellsToRenderBatcher.schedule(); } _averageCellLength = 0; _hasDataChangedSinceEndReached = true; _hasWarned = {}; _highestMeasuredFrameIndex = 0; _headerLength = 0; _frames = {}; _footerLength = 0; _scrollMetrics = { visibleLength: 0, contentLength: 0, offset: 0, dt: 10, velocity: 0, timestamp: 0, }; _scrollRef = (null: any); _sentEndForContentLength = 0; _totalCellLength = 0; _totalCellsMeasured = 0; _updateCellsToRenderBatcher: Batchinator; _viewabilityHelper: ViewabilityHelper; _captureScrollRef = (ref) => { this._scrollRef = ref; }; _onCellLayout(e, cellKey, index) { const layout = e.nativeEvent.layout; const next = { offset: this._selectOffset(layout), length: this._selectLength(layout), index, inLayout: true, }; const curr = this._frames[cellKey]; if (!curr || next.offset !== curr.offset || next.length !== curr.length || index !== curr.index ) { this._totalCellLength += next.length - (curr ? curr.length : 0); this._totalCellsMeasured += (curr ? 0 : 1); this._averageCellLength = this._totalCellLength / this._totalCellsMeasured; this._frames[cellKey] = next; this._highestMeasuredFrameIndex = Math.max(this._highestMeasuredFrameIndex, index); this._updateCellsToRenderBatcher.schedule(); } else { this._frames[cellKey].inLayout = true; } } _onCellUnmount = (cellKey: string) => { const curr = this._frames[cellKey]; if (curr) { this._frames[cellKey] = {...curr, inLayout: false}; } }; _onLayout = (e: Object) => { this._scrollMetrics.visibleLength = this._selectLength(e.nativeEvent.layout); this.props.onLayout && this.props.onLayout(e); this._updateCellsToRenderBatcher.schedule(); }; _onLayoutFooter = (e) => { this._footerLength = this._selectLength(e.nativeEvent.layout); }; _onLayoutHeader = (e) => { this._headerLength = this._selectLength(e.nativeEvent.layout); }; _renderDebugOverlay() { const normalize = this._scrollMetrics.visibleLength / this._scrollMetrics.contentLength; const framesInLayout = []; const itemCount = this.props.getItemCount(this.props.data); for (let ii = 0; ii < itemCount; ii++) { const frame = this._getFrameMetricsApprox(ii); if (frame.inLayout) { framesInLayout.push(frame); } } const windowTop = this._getFrameMetricsApprox(this.state.first).offset; const frameLast = this._getFrameMetricsApprox(this.state.last); const windowLen = frameLast.offset + frameLast.length - windowTop; const visTop = this._scrollMetrics.offset; const visLen = this._scrollMetrics.visibleLength; const baseStyle = {position: 'absolute', top: 0, right: 0}; return ( {framesInLayout.map((f, ii) => )} ); } _selectLength(metrics: {height: number, width: number}): number { return !this.props.horizontal ? metrics.height : metrics.width; } _selectOffset(metrics: {x: number, y: number}): number { return !this.props.horizontal ? metrics.y : metrics.x; } _onContentSizeChange = (width: number, height: number) => { if (this.props.onContentSizeChange) { this.props.onContentSizeChange(width, height); } this._scrollMetrics.contentLength = this._selectLength({height, width}); this._updateCellsToRenderBatcher.schedule(); }; _onScroll = (e: Object) => { if (this.props.onScroll) { this.props.onScroll(e); } const timestamp = e.timeStamp; const visibleLength = this._selectLength(e.nativeEvent.layoutMeasurement); const contentLength = this._selectLength(e.nativeEvent.contentSize); const offset = this._selectOffset(e.nativeEvent.contentOffset); const dt = Math.max(1, timestamp - this._scrollMetrics.timestamp); if (dt > 500 && this._scrollMetrics.dt > 500 && (contentLength > (5 * visibleLength)) && !this._hasWarned.perf) { infoLog( 'VirtualizedList: You have a large list that is slow to update - make sure your ' + 'renderItem function renders components that follow React performance best practices ' + 'like PureComponent, shouldComponentUpdate, etc.', {dt, prevDt: this._scrollMetrics.dt, contentLength}, ); this._hasWarned.perf = true; } const dOffset = offset - this._scrollMetrics.offset; const velocity = dOffset / dt; this._scrollMetrics = {contentLength, dt, offset, timestamp, velocity, visibleLength}; const {data, getItemCount, onEndReached, onEndReachedThreshold, windowSize} = this.props; this._updateViewableItems(data); if (!data) { return; } const distanceFromEnd = contentLength - visibleLength - offset; const itemCount = getItemCount(data); if (this.state.last === itemCount - 1 && distanceFromEnd < onEndReachedThreshold * visibleLength && (this._hasDataChangedSinceEndReached || this._scrollMetrics.contentLength !== this._sentEndForContentLength)) { // Only call onEndReached once for a given dataset + content length. this._hasDataChangedSinceEndReached = false; this._sentEndForContentLength = this._scrollMetrics.contentLength; onEndReached({distanceFromEnd}); } const {first, last} = this.state; if ((first > 0 && velocity < 0) || (last < itemCount - 1 && velocity > 0)) { const distanceToContentEdge = Math.min( Math.abs(this._getFrameMetricsApprox(first).offset - offset), Math.abs(this._getFrameMetricsApprox(last).offset - (offset + visibleLength)), ); const hiPri = distanceToContentEdge < (windowSize * visibleLength / 4); if (hiPri) { // Don't worry about interactions when scrolling quickly; focus on filling content as fast // as possible. this._updateCellsToRenderBatcher.dispose({abort: true}); this._updateCellsToRender(); return; } } this._updateCellsToRenderBatcher.schedule(); }; _onScrollBeginDrag = (e): void => { this._viewabilityHelper.recordInteraction(); this.props.onScrollBeginDrag && this.props.onScrollBeginDrag(e); }; _updateCellsToRender = () => { const {data, disableVirtualization, getItemCount, onEndReachedThreshold} = this.props; this._updateViewableItems(data); if (!data) { return; } this.setState((state) => { let newState; if (!disableVirtualization) { newState = computeWindowedRenderLimits( this.props, state, this._getFrameMetricsApprox, this._scrollMetrics, ); } else { const {contentLength, offset, visibleLength} = this._scrollMetrics; const distanceFromEnd = contentLength - visibleLength - offset; const renderAhead = distanceFromEnd < onEndReachedThreshold * visibleLength ? this.props.maxToRenderPerBatch : 0; newState = { first: 0, last: Math.min(state.last + renderAhead, getItemCount(data) - 1), }; } return newState; }); }; _createViewToken = (index: number, isViewable: boolean) => { const {data, getItem, keyExtractor} = this.props; const item = getItem(data, index); invariant(item, 'Missing item for index ' + index); return {index, item, key: keyExtractor(item, index), isViewable}; }; _getFrameMetricsApprox = (index: number): {length: number, offset: number} => { const frame = this._getFrameMetrics(index); if (frame && frame.index === index) { // check for invalid frames due to row re-ordering return frame; } else { const {getItemLayout} = this.props; invariant( !getItemLayout, 'Should not have to estimate frames when a measurement metrics function is provided' ); return { length: this._averageCellLength, offset: this._averageCellLength * index, }; } }; _getFrameMetrics = (index: number): ?{length: number, offset: number, index: number} => { const {data, getItem, getItemCount, getItemLayout, keyExtractor} = this.props; invariant(getItemCount(data) > index, 'Tried to get frame for out of range index ' + index); const item = getItem(data, index); let frame = item && this._frames[keyExtractor(item, index)]; if (!frame || frame.index !== index) { if (getItemLayout) { frame = getItemLayout(data, index); } } return frame; }; _updateViewableItems(data: any) { const {getItemCount, onViewableItemsChanged} = this.props; if (!onViewableItemsChanged) { return; } this._viewabilityHelper.onUpdate( getItemCount(data), this._scrollMetrics.offset, this._scrollMetrics.visibleLength, this._getFrameMetrics, this._createViewToken, onViewableItemsChanged, this.state, ); } } class CellRenderer extends React.Component { props: { cellKey: string, index: number, item: Item, onLayout: (event: Object) => void, // This is extracted by ScrollViewStickyHeader onUnmount: (cellKey: string) => void, parentProps: { renderItem: renderItemType, getItemLayout?: ?Function, }, }; componentWillUnmount() { this.props.onUnmount(this.props.cellKey); } render() { const {item, index, parentProps} = this.props; const {renderItem, getItemLayout} = parentProps; invariant(renderItem, 'no renderItem!'); const element = renderItem({item, index}); if (getItemLayout && !parentProps.debug) { return element; } // NOTE: that when this is a sticky header, `onLayout` will get automatically extracted and // called explicitly by `ScrollViewStickyHeader`. return ( {element} ); } } module.exports = VirtualizedList;