2015-01-30 01:10:49 +00:00
|
|
|
/**
|
2016-03-17 19:10:35 +00:00
|
|
|
* Copyright (c) 2013-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.
|
2015-03-23 22:07:33 +00:00
|
|
|
*
|
2015-07-24 19:58:12 +00:00
|
|
|
* Facebook, Inc. ("Facebook") owns all right, title and interest, including
|
2015-03-26 16:32:19 +00:00
|
|
|
* all intellectual property and other proprietary rights, in and to the React
|
2015-07-24 19:58:12 +00:00
|
|
|
* Native CustomComponents software (the "Software"). Subject to your
|
2015-03-26 16:32:19 +00:00
|
|
|
* compliance with these terms, you are hereby granted a non-exclusive,
|
|
|
|
* worldwide, royalty-free copyright license to (1) use and copy the Software;
|
|
|
|
* and (2) reproduce and distribute the Software as part of your own software
|
2015-07-24 19:58:12 +00:00
|
|
|
* ("Your Software"). Facebook reserves all rights not expressly granted to
|
2015-03-26 16:32:19 +00:00
|
|
|
* you in this license agreement.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE AND DOCUMENTATION, IF ANY, ARE PROVIDED "AS IS" AND ANY EXPRESS
|
|
|
|
* OR IMPLIED WARRANTIES (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED.
|
|
|
|
* IN NO EVENT SHALL FACEBOOK OR ITS AFFILIATES, OFFICERS, DIRECTORS OR
|
|
|
|
* EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
|
|
|
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
|
|
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE SOFTWARE, EVEN IF
|
|
|
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
2015-01-30 01:10:49 +00:00
|
|
|
*
|
|
|
|
* @providesModule ListView
|
2016-06-23 16:23:09 +00:00
|
|
|
* @flow
|
2015-01-30 01:10:49 +00:00
|
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
|
|
|
|
var ListViewDataSource = require('ListViewDataSource');
|
2017-03-03 23:26:17 +00:00
|
|
|
var Platform = require('Platform');
|
2015-01-30 01:10:49 +00:00
|
|
|
var React = require('React');
|
2016-10-15 01:50:14 +00:00
|
|
|
var ReactNative = require('ReactNative');
|
2015-07-20 19:32:14 +00:00
|
|
|
var RCTScrollViewManager = require('NativeModules').ScrollViewManager;
|
2015-01-30 01:10:49 +00:00
|
|
|
var ScrollView = require('ScrollView');
|
|
|
|
var ScrollResponder = require('ScrollResponder');
|
|
|
|
var StaticRenderer = require('StaticRenderer');
|
2015-03-25 02:34:12 +00:00
|
|
|
var TimerMixin = require('react-timer-mixin');
|
2017-02-03 03:50:04 +00:00
|
|
|
var View = require('View');
|
2015-01-30 01:10:49 +00:00
|
|
|
|
2016-04-14 13:40:54 +00:00
|
|
|
var cloneReferencedElement = require('react-clone-referenced-element');
|
2016-03-02 16:26:11 +00:00
|
|
|
var isEmpty = require('isEmpty');
|
2015-01-30 01:10:49 +00:00
|
|
|
var merge = require('merge');
|
|
|
|
|
|
|
|
var PropTypes = React.PropTypes;
|
|
|
|
|
2015-03-09 23:18:15 +00:00
|
|
|
var DEFAULT_PAGE_SIZE = 1;
|
|
|
|
var DEFAULT_INITIAL_ROWS = 10;
|
|
|
|
var DEFAULT_SCROLL_RENDER_AHEAD = 1000;
|
|
|
|
var DEFAULT_END_REACHED_THRESHOLD = 1000;
|
|
|
|
var DEFAULT_SCROLL_CALLBACK_THROTTLE = 50;
|
|
|
|
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
/**
|
|
|
|
* ListView - A core component designed for efficient display of vertically
|
2017-01-09 11:08:05 +00:00
|
|
|
* scrolling lists of changing data. The minimal API is to create a
|
2016-04-24 15:12:28 +00:00
|
|
|
* [`ListView.DataSource`](docs/listviewdatasource.html), populate it with a simple
|
|
|
|
* array of data blobs, and instantiate a `ListView` component with that data
|
|
|
|
* source and a `renderRow` callback which takes a blob from the data array and
|
|
|
|
* returns a renderable component.
|
2015-03-09 23:18:15 +00:00
|
|
|
*
|
|
|
|
* Minimal example:
|
2015-01-30 01:10:49 +00:00
|
|
|
*
|
2015-03-09 23:18:15 +00:00
|
|
|
* ```
|
2016-08-16 16:48:13 +00:00
|
|
|
* class MyComponent extends Component {
|
|
|
|
* constructor() {
|
|
|
|
* super();
|
|
|
|
* const ds = new ListView.DataSource({rowHasChanged: (r1, r2) => r1 !== r2});
|
|
|
|
* this.state = {
|
|
|
|
* dataSource: ds.cloneWithRows(['row 1', 'row 2']),
|
|
|
|
* };
|
|
|
|
* }
|
2015-01-30 01:10:49 +00:00
|
|
|
*
|
2016-08-16 16:48:13 +00:00
|
|
|
* render() {
|
|
|
|
* return (
|
|
|
|
* <ListView
|
|
|
|
* dataSource={this.state.dataSource}
|
|
|
|
* renderRow={(rowData) => <Text>{rowData}</Text>}
|
|
|
|
* />
|
|
|
|
* );
|
|
|
|
* }
|
|
|
|
* }
|
2015-03-09 23:18:15 +00:00
|
|
|
* ```
|
2015-01-30 01:10:49 +00:00
|
|
|
*
|
|
|
|
* ListView also supports more advanced features, including sections with sticky
|
|
|
|
* section headers, header and footer support, callbacks on reaching the end of
|
|
|
|
* the available data (`onEndReached`) and on the set of rows that are visible
|
|
|
|
* in the device viewport change (`onChangeVisibleRows`), and several
|
|
|
|
* performance optimizations.
|
|
|
|
*
|
|
|
|
* There are a few performance operations designed to make ListView scroll
|
|
|
|
* smoothly while dynamically loading potentially very large (or conceptually
|
|
|
|
* infinite) data sets:
|
|
|
|
*
|
2015-05-14 16:45:38 +00:00
|
|
|
* * Only re-render changed rows - the rowHasChanged function provided to the
|
2015-01-30 01:10:49 +00:00
|
|
|
* data source tells the ListView if it needs to re-render a row because the
|
|
|
|
* source data has changed - see ListViewDataSource for more details.
|
|
|
|
*
|
|
|
|
* * Rate-limited row rendering - By default, only one row is rendered per
|
2017-01-09 11:08:05 +00:00
|
|
|
* event-loop (customizable with the `pageSize` prop). This breaks up the
|
2015-01-30 01:10:49 +00:00
|
|
|
* work into smaller chunks to reduce the chance of dropping frames while
|
|
|
|
* rendering rows.
|
|
|
|
*/
|
|
|
|
|
|
|
|
var ListView = React.createClass({
|
2016-06-23 16:23:09 +00:00
|
|
|
_childFrames: ([]: Array<Object>),
|
|
|
|
_sentEndForContentLength: (null: ?number),
|
|
|
|
_scrollComponent: (null: any),
|
|
|
|
_prevRenderedRowsCount: 0,
|
|
|
|
_visibleRows: ({}: Object),
|
|
|
|
scrollProperties: ({}: Object),
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
mixins: [ScrollResponder.Mixin, TimerMixin],
|
|
|
|
|
2015-03-03 16:38:50 +00:00
|
|
|
statics: {
|
|
|
|
DataSource: ListViewDataSource,
|
|
|
|
},
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
/**
|
|
|
|
* You must provide a renderRow function. If you omit any of the other render
|
|
|
|
* functions, ListView will simply skip rendering them.
|
|
|
|
*
|
2015-05-26 22:16:42 +00:00
|
|
|
* - renderRow(rowData, sectionID, rowID, highlightRow);
|
2015-01-30 01:10:49 +00:00
|
|
|
* - renderSectionHeader(sectionData, sectionID);
|
|
|
|
*/
|
2015-03-05 05:06:49 +00:00
|
|
|
propTypes: {
|
|
|
|
...ScrollView.propTypes,
|
2016-04-24 15:12:28 +00:00
|
|
|
/**
|
|
|
|
* An instance of [ListView.DataSource](docs/listviewdatasource.html) to use
|
|
|
|
*/
|
2015-03-05 05:06:49 +00:00
|
|
|
dataSource: PropTypes.instanceOf(ListViewDataSource).isRequired,
|
|
|
|
/**
|
2015-05-26 22:16:42 +00:00
|
|
|
* (sectionID, rowID, adjacentRowHighlighted) => renderable
|
2015-12-03 18:53:40 +00:00
|
|
|
*
|
2015-05-26 22:16:42 +00:00
|
|
|
* If provided, a renderable component to be rendered as the separator
|
|
|
|
* below each row but not the last row if there is a section header below.
|
|
|
|
* Take a sectionID and rowID of the row above and whether its adjacent row
|
|
|
|
* is highlighted.
|
|
|
|
*/
|
|
|
|
renderSeparator: PropTypes.func,
|
|
|
|
/**
|
|
|
|
* (rowData, sectionID, rowID, highlightRow) => renderable
|
2015-12-03 18:53:40 +00:00
|
|
|
*
|
2015-03-05 05:06:49 +00:00
|
|
|
* Takes a data entry from the data source and its ids and should return
|
2017-01-09 11:08:05 +00:00
|
|
|
* a renderable component to be rendered as the row. By default the data
|
2015-03-05 05:06:49 +00:00
|
|
|
* is exactly what was put into the data source, but it's also possible to
|
2015-05-26 22:16:42 +00:00
|
|
|
* provide custom extractors. ListView can be notified when a row is
|
2016-05-05 10:42:02 +00:00
|
|
|
* being highlighted by calling `highlightRow(sectionID, rowID)`. This
|
|
|
|
* sets a boolean value of adjacentRowHighlighted in renderSeparator, allowing you
|
|
|
|
* to control the separators above and below the highlighted row. The highlighted
|
|
|
|
* state of a row can be reset by calling highlightRow(null).
|
2015-03-05 05:06:49 +00:00
|
|
|
*/
|
|
|
|
renderRow: PropTypes.func.isRequired,
|
|
|
|
/**
|
2017-01-09 11:08:05 +00:00
|
|
|
* How many rows to render on initial component mount. Use this to make
|
2015-12-15 17:08:39 +00:00
|
|
|
* it so that the first screen worth of data appears at one time instead of
|
2015-03-05 05:06:49 +00:00
|
|
|
* over the course of multiple frames.
|
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
initialListSize: PropTypes.number.isRequired,
|
2015-03-05 05:06:49 +00:00
|
|
|
/**
|
|
|
|
* Called when all rows have been rendered and the list has been scrolled
|
2017-01-09 11:08:05 +00:00
|
|
|
* to within onEndReachedThreshold of the bottom. The native scroll
|
2015-03-05 05:06:49 +00:00
|
|
|
* event is provided.
|
|
|
|
*/
|
|
|
|
onEndReached: PropTypes.func,
|
|
|
|
/**
|
Fixed missing rows on UIExplorer <ListView> - Grid Layout example
Summary:
public
I was looking into the missing panels at the bottom of the <ListView> - Grid Layout example, and found that it was caused by several problems, some in the example and some in ListView itself.
The first problem seemed to be a bug in the `_getDistanceFromEnd()` method, which calculates whether the ListView needs to load more content based on the distance of the visible content from the bottom of the scrollview. This was previously using the function
Math.max(scrollProperties.contentLength, scrollProperties.visibleLength) - scrollProperties.visibleLength - scrollProperties.offset
to calculate the amount the user could scroll before they run out of content. This sort-of works in most cases because `scrollProperties.contentLength` is usually longer than `scrollProperties.visibleLength`, so this would generally evaluate to
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
which meant that it would be positive as long as there was content still to be displayed offscreen, and negative when you reached the end of the content. This logic breaks down if `contentLength` is less than `visibleLength`, however. For example, if you have 300pts of content loaded, and your scrollView is 500pts tall, and your scroll position is zero, this evaluates to
Math.max(300, 500) - 500 - 0 = 0
In other words, the algorithm is saying that you have zero pts of scroll content remaining before you need to reload. But actually, the bottom 200pts of the screen are empty, so you're really 200pts in debt, and need to load extra rows to fill that space. The correct algorithm is simply to get rid of the `Math.max` and just use
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
I originally thought that this was the cause of the gap, but it isn't, because ListView has `DEFAULT_SCROLL_RENDER_AHEAD = 1000`, which means that it tries to load at least 1000pts more content than is currently visible, to avoid gaps. This masked the bug, so in practice it wasn't causing an issue.
The next problem I found was that there is an implict assumption in ListView that the first page of content you load is sufficient to cover the screen, or rather, that the first _ second page is sufficient. The constants `DEFAULT_INITIAL_ROWS = 10` and `DEFAULT_PAGE_SIZE = 1`, mean that when the ListView first loads, the following happens:
1. It loads 10 rows of content.
2. It checks if `_getDistanceFromEnd() < DEFAULT_SCROLL_RENDER_AHEAD` (1000).
3. If it is, it loads another `DEFAULT_PAGE_SIZE` rows of content, then stops.
In the case of the ListView Grid Layout example, this meant that it first loaded 10 cells, then loaded another 1, for a total of 11. The problem was that going from 10 to 11 cells isn't sufficient to fill the visible scroll area, and it doesn't change the `contentSize` (since the cells wrap onto the same line), and since ListView doesn't try to load any more until the `contentSize` or `scrollOffset ` changes, it stops loading new rows at that point.
I tried fixing this by calling `_renderMoreRowsIfNeeded()` after `_pageInNewRows()` so that it will continue to fetch new rows until the `_getDistanceFromEnd()` is less than the threshold, rather than stopping after the first page and waiting until the `contentSize` or `scrollOffset` change, but although this solves the problem for the Grid Layout example, it leads to over-fetching in the more common case of a standard row-based ListView.
In the end, I just increased the `pageSize` to 3 for the Grid Layout example, which makes more sense anyway since loading a page that is not a multiple of the number of cells per row confuses the `_renderMoreRowsIfNeeded` algorithm, and leads to gaps at the bottom of the view.
This solved the problem, however there was still a "pop-in" effect, where the additional rows were paged in after the ListView appeared. This was simply a misconfiguration in the example itself: The default of 10 rows was insufficient to fill the screen, so I changed the `initialListSize` prop to `20`.
Reviewed By: javache
Differential Revision: D2911690
fb-gh-sync-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
shipit-source-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
2016-02-10 16:36:15 +00:00
|
|
|
* Threshold in pixels (virtual, not physical) for calling onEndReached.
|
2015-03-05 05:06:49 +00:00
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
onEndReachedThreshold: PropTypes.number.isRequired,
|
2015-03-05 05:06:49 +00:00
|
|
|
/**
|
Fixed missing rows on UIExplorer <ListView> - Grid Layout example
Summary:
public
I was looking into the missing panels at the bottom of the <ListView> - Grid Layout example, and found that it was caused by several problems, some in the example and some in ListView itself.
The first problem seemed to be a bug in the `_getDistanceFromEnd()` method, which calculates whether the ListView needs to load more content based on the distance of the visible content from the bottom of the scrollview. This was previously using the function
Math.max(scrollProperties.contentLength, scrollProperties.visibleLength) - scrollProperties.visibleLength - scrollProperties.offset
to calculate the amount the user could scroll before they run out of content. This sort-of works in most cases because `scrollProperties.contentLength` is usually longer than `scrollProperties.visibleLength`, so this would generally evaluate to
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
which meant that it would be positive as long as there was content still to be displayed offscreen, and negative when you reached the end of the content. This logic breaks down if `contentLength` is less than `visibleLength`, however. For example, if you have 300pts of content loaded, and your scrollView is 500pts tall, and your scroll position is zero, this evaluates to
Math.max(300, 500) - 500 - 0 = 0
In other words, the algorithm is saying that you have zero pts of scroll content remaining before you need to reload. But actually, the bottom 200pts of the screen are empty, so you're really 200pts in debt, and need to load extra rows to fill that space. The correct algorithm is simply to get rid of the `Math.max` and just use
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
I originally thought that this was the cause of the gap, but it isn't, because ListView has `DEFAULT_SCROLL_RENDER_AHEAD = 1000`, which means that it tries to load at least 1000pts more content than is currently visible, to avoid gaps. This masked the bug, so in practice it wasn't causing an issue.
The next problem I found was that there is an implict assumption in ListView that the first page of content you load is sufficient to cover the screen, or rather, that the first _ second page is sufficient. The constants `DEFAULT_INITIAL_ROWS = 10` and `DEFAULT_PAGE_SIZE = 1`, mean that when the ListView first loads, the following happens:
1. It loads 10 rows of content.
2. It checks if `_getDistanceFromEnd() < DEFAULT_SCROLL_RENDER_AHEAD` (1000).
3. If it is, it loads another `DEFAULT_PAGE_SIZE` rows of content, then stops.
In the case of the ListView Grid Layout example, this meant that it first loaded 10 cells, then loaded another 1, for a total of 11. The problem was that going from 10 to 11 cells isn't sufficient to fill the visible scroll area, and it doesn't change the `contentSize` (since the cells wrap onto the same line), and since ListView doesn't try to load any more until the `contentSize` or `scrollOffset ` changes, it stops loading new rows at that point.
I tried fixing this by calling `_renderMoreRowsIfNeeded()` after `_pageInNewRows()` so that it will continue to fetch new rows until the `_getDistanceFromEnd()` is less than the threshold, rather than stopping after the first page and waiting until the `contentSize` or `scrollOffset` change, but although this solves the problem for the Grid Layout example, it leads to over-fetching in the more common case of a standard row-based ListView.
In the end, I just increased the `pageSize` to 3 for the Grid Layout example, which makes more sense anyway since loading a page that is not a multiple of the number of cells per row confuses the `_renderMoreRowsIfNeeded` algorithm, and leads to gaps at the bottom of the view.
This solved the problem, however there was still a "pop-in" effect, where the additional rows were paged in after the ListView appeared. This was simply a misconfiguration in the example itself: The default of 10 rows was insufficient to fill the screen, so I changed the `initialListSize` prop to `20`.
Reviewed By: javache
Differential Revision: D2911690
fb-gh-sync-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
shipit-source-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
2016-02-10 16:36:15 +00:00
|
|
|
* Number of rows to render per event loop. Note: if your 'rows' are actually
|
|
|
|
* cells, i.e. they don't span the full width of your view (as in the
|
|
|
|
* ListViewGridLayoutExample), you should set the pageSize to be a multiple
|
|
|
|
* of the number of cells per row, otherwise you're likely to see gaps at
|
|
|
|
* the edge of the ListView as new pages are loaded.
|
2015-03-05 05:06:49 +00:00
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
pageSize: PropTypes.number.isRequired,
|
2015-03-05 05:06:49 +00:00
|
|
|
/**
|
|
|
|
* () => renderable
|
|
|
|
*
|
|
|
|
* The header and footer are always rendered (if these props are provided)
|
2017-01-09 11:08:05 +00:00
|
|
|
* on every render pass. If they are expensive to re-render, wrap them
|
|
|
|
* in StaticContainer or other mechanism as appropriate. Footer is always
|
2015-03-05 05:06:49 +00:00
|
|
|
* at the bottom of the list, and header at the top, on every render pass.
|
|
|
|
*/
|
|
|
|
renderFooter: PropTypes.func,
|
|
|
|
renderHeader: PropTypes.func,
|
|
|
|
/**
|
|
|
|
* (sectionData, sectionID) => renderable
|
|
|
|
*
|
2017-01-09 11:08:05 +00:00
|
|
|
* If provided, a header is rendered for this section.
|
2015-03-05 05:06:49 +00:00
|
|
|
*/
|
|
|
|
renderSectionHeader: PropTypes.func,
|
2015-07-01 16:02:38 +00:00
|
|
|
/**
|
|
|
|
* (props) => renderable
|
|
|
|
*
|
|
|
|
* A function that returns the scrollable component in which the list rows
|
|
|
|
* are rendered. Defaults to returning a ScrollView with the given props.
|
|
|
|
*/
|
|
|
|
renderScrollComponent: React.PropTypes.func.isRequired,
|
2015-03-05 05:06:49 +00:00
|
|
|
/**
|
|
|
|
* How early to start rendering rows before they come on screen, in
|
|
|
|
* pixels.
|
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
scrollRenderAheadDistance: React.PropTypes.number.isRequired,
|
2015-03-05 05:06:49 +00:00
|
|
|
/**
|
|
|
|
* (visibleRows, changedRows) => void
|
|
|
|
*
|
2017-01-09 11:08:05 +00:00
|
|
|
* Called when the set of visible rows changes. `visibleRows` maps
|
2015-03-05 05:06:49 +00:00
|
|
|
* { sectionID: { rowID: true }} for all the visible rows, and
|
|
|
|
* `changedRows` maps { sectionID: { rowID: true | false }} for the rows
|
|
|
|
* that have changed their visibility, with true indicating visible, and
|
|
|
|
* false indicating the view has moved out of view.
|
|
|
|
*/
|
|
|
|
onChangeVisibleRows: React.PropTypes.func,
|
|
|
|
/**
|
2015-12-28 15:55:39 +00:00
|
|
|
* A performance optimization for improving scroll perf of
|
2015-03-05 05:06:49 +00:00
|
|
|
* large lists, used in conjunction with overflow: 'hidden' on the row
|
2017-01-09 11:08:05 +00:00
|
|
|
* containers. This is enabled by default.
|
2015-03-05 05:06:49 +00:00
|
|
|
*/
|
|
|
|
removeClippedSubviews: React.PropTypes.bool,
|
2017-01-09 11:08:05 +00:00
|
|
|
/**
|
|
|
|
* Makes the sections headers sticky. The sticky behavior means that it
|
|
|
|
* will scroll with the content at the top of the section until it reaches
|
|
|
|
* the top of the screen, at which point it will stick to the top until it
|
|
|
|
* is pushed off the screen by the next section header.
|
|
|
|
* @platform ios
|
|
|
|
*/
|
|
|
|
stickySectionHeadersEnabled: React.PropTypes.bool,
|
2016-01-06 17:16:40 +00:00
|
|
|
/**
|
|
|
|
* An array of child indices determining which children get docked to the
|
|
|
|
* top of the screen when scrolling. For example, passing
|
|
|
|
* `stickyHeaderIndices={[0]}` will cause the first child to be fixed to the
|
|
|
|
* top of the scroll view. This property is not supported in conjunction
|
|
|
|
* with `horizontal={true}`.
|
|
|
|
* @platform ios
|
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
stickyHeaderIndices: PropTypes.arrayOf(PropTypes.number).isRequired,
|
2016-03-15 19:13:34 +00:00
|
|
|
/**
|
|
|
|
* Flag indicating whether empty section headers should be rendered. In the future release
|
|
|
|
* empty section headers will be rendered by default, and the flag will be deprecated.
|
|
|
|
* If empty sections are not desired to be rendered their indices should be excluded from sectionID object.
|
|
|
|
*/
|
|
|
|
enableEmptySections: PropTypes.bool,
|
2015-03-05 05:06:49 +00:00
|
|
|
},
|
2015-01-30 01:10:49 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Exports some data, e.g. for perf investigations or analytics.
|
|
|
|
*/
|
|
|
|
getMetrics: function() {
|
|
|
|
return {
|
2015-07-15 17:05:13 +00:00
|
|
|
contentLength: this.scrollProperties.contentLength,
|
2016-03-15 19:13:34 +00:00
|
|
|
totalRows: (this.props.enableEmptySections ? this.props.dataSource.getRowAndSectionCount() : this.props.dataSource.getRowCount()),
|
2015-01-30 01:10:49 +00:00
|
|
|
renderedRows: this.state.curRenderedRowsCount,
|
|
|
|
visibleRows: Object.keys(this._visibleRows).length,
|
|
|
|
};
|
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
2016-02-03 17:16:15 +00:00
|
|
|
* Provides a handle to the underlying scroll responder.
|
2016-04-14 13:40:54 +00:00
|
|
|
* Note that `this._scrollComponent` might not be a `ScrollView`, so we
|
2016-02-19 13:02:27 +00:00
|
|
|
* need to check that it responds to `getScrollResponder` before calling it.
|
2015-01-30 01:10:49 +00:00
|
|
|
*/
|
|
|
|
getScrollResponder: function() {
|
2016-04-14 13:40:54 +00:00
|
|
|
if (this._scrollComponent && this._scrollComponent.getScrollResponder) {
|
|
|
|
return this._scrollComponent.getScrollResponder();
|
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
2016-12-14 04:31:30 +00:00
|
|
|
getScrollableNode: function() {
|
|
|
|
if (this._scrollComponent && this._scrollComponent.getScrollableNode) {
|
|
|
|
return this._scrollComponent.getScrollableNode();
|
|
|
|
} else {
|
|
|
|
return ReactNative.findNodeHandle(this._scrollComponent);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2016-04-09 18:12:46 +00:00
|
|
|
/**
|
|
|
|
* Scrolls to a given x, y offset, either immediately or with a smooth animation.
|
|
|
|
*
|
|
|
|
* See `ScrollView#scrollTo`.
|
|
|
|
*/
|
2016-06-23 16:23:09 +00:00
|
|
|
scrollTo: function(...args: Array<mixed>) {
|
2016-04-14 13:40:54 +00:00
|
|
|
if (this._scrollComponent && this._scrollComponent.scrollTo) {
|
|
|
|
this._scrollComponent.scrollTo(...args);
|
|
|
|
}
|
2016-01-06 18:24:48 +00:00
|
|
|
},
|
|
|
|
|
2017-01-27 18:09:20 +00:00
|
|
|
/**
|
|
|
|
* If this is a vertical ListView scrolls to the bottom.
|
|
|
|
* If this is a horizontal ListView scrolls to the right.
|
|
|
|
*
|
|
|
|
* Use `scrollToEnd({animated: true})` for smooth animated scrolling,
|
|
|
|
* `scrollToEnd({animated: false})` for immediate scrolling.
|
|
|
|
* If no options are passed, `animated` defaults to true.
|
|
|
|
*
|
|
|
|
* See `ScrollView#scrollToEnd`.
|
|
|
|
*/
|
Better ListView - FlatList
Summary:
We really need a better list view - so here it is!
Main changes from existing `ListView`:
* Items are "virtualized" to limit memory - that is, items outside of the render window are unmounted and their memory is reclaimed. This means that instance state is not preserved when items scroll out of the render window.
* No `DataSource` - just a simple `data` prop of shape `Array<any>`. By default, they are expected to be of the shape `{key: string}` but a custom `rowExtractor` function can be provided for different shapes, e.g. graphql data where you want to map `id` to `key`. Note the underlying `VirtualizedList` is much more flexible.
* Fancy `scrollTo` functionality: `scrollToEnd`, `scrollToIndex`, and `scrollToItem` in addition to the normal `scrollToOffset`.
* Built-in pull to refresh support - set set the `onRefresh` and `refreshing` props.
* Rendering additional rows is usually done with low priority, after any interactions/animations complete, unless we're about to run out of rendered content. This should help apps feel more responsive.
* Component props replace render functions, e.g. `ItemComponent: ReactClass<{item: Item, index: number}>` replaces `renderRow: (...) => React.Element<*>`
* Supports dynamic items automatically by using `onLayout`, or `getItemLayout` can be provided for a perf boost and smoother `scrollToIndex` and scroll bar behavior.
* Visibility callback replaced with more powerful viewability callback and works in vertical and horizontal mode on at least Android and iOS, but probably other platforms as well. Extra power comes from the `viewablePercentThreshold` that lets the client decide when an item should be considered viewable.
Demo:
https://www.facebook.com/groups/576288835853049/permalink/753923058089625/
Reviewed By: yungsters
Differential Revision: D4412469
fbshipit-source-id: e2d891490bf76fe14df49294ecddf78a58adcf23
2017-02-04 18:25:32 +00:00
|
|
|
scrollToEnd: function(options?: ?{ animated?: ?boolean }) {
|
2017-01-27 18:09:20 +00:00
|
|
|
if (this._scrollComponent) {
|
|
|
|
if (this._scrollComponent.scrollToEnd) {
|
|
|
|
this._scrollComponent.scrollToEnd(options);
|
|
|
|
} else {
|
|
|
|
console.warn(
|
|
|
|
'The scroll component used by the ListView does not support ' +
|
|
|
|
'scrollToEnd. Check the renderScrollComponent prop of your ListView.'
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
setNativeProps: function(props: Object) {
|
2016-04-14 13:40:54 +00:00
|
|
|
if (this._scrollComponent) {
|
|
|
|
this._scrollComponent.setNativeProps(props);
|
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* React life cycle hooks.
|
|
|
|
*/
|
|
|
|
|
|
|
|
getDefaultProps: function() {
|
|
|
|
return {
|
|
|
|
initialListSize: DEFAULT_INITIAL_ROWS,
|
|
|
|
pageSize: DEFAULT_PAGE_SIZE,
|
2015-07-01 16:02:38 +00:00
|
|
|
renderScrollComponent: props => <ScrollView {...props} />,
|
2015-01-30 01:10:49 +00:00
|
|
|
scrollRenderAheadDistance: DEFAULT_SCROLL_RENDER_AHEAD,
|
|
|
|
onEndReachedThreshold: DEFAULT_END_REACHED_THRESHOLD,
|
2017-03-03 23:26:17 +00:00
|
|
|
stickySectionHeadersEnabled: Platform.OS === 'ios',
|
2016-01-06 17:16:40 +00:00
|
|
|
stickyHeaderIndices: [],
|
2015-01-30 01:10:49 +00:00
|
|
|
};
|
|
|
|
},
|
|
|
|
|
|
|
|
getInitialState: function() {
|
|
|
|
return {
|
|
|
|
curRenderedRowsCount: this.props.initialListSize,
|
2016-06-23 16:23:09 +00:00
|
|
|
highlightedRow: ({} : Object),
|
2015-01-30 01:10:49 +00:00
|
|
|
};
|
|
|
|
},
|
|
|
|
|
2015-07-24 00:57:42 +00:00
|
|
|
getInnerViewNode: function() {
|
2016-04-14 13:40:54 +00:00
|
|
|
return this._scrollComponent.getInnerViewNode();
|
2015-07-24 00:57:42 +00:00
|
|
|
},
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
componentWillMount: function() {
|
|
|
|
// this data should never trigger a render pass, so don't put in state
|
|
|
|
this.scrollProperties = {
|
2015-07-15 17:05:13 +00:00
|
|
|
visibleLength: null,
|
|
|
|
contentLength: null,
|
|
|
|
offset: 0
|
2015-01-30 01:10:49 +00:00
|
|
|
};
|
|
|
|
this._childFrames = [];
|
|
|
|
this._visibleRows = {};
|
2015-12-20 01:12:56 +00:00
|
|
|
this._prevRenderedRowsCount = 0;
|
2015-12-21 16:40:52 +00:00
|
|
|
this._sentEndForContentLength = null;
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
componentDidMount: function() {
|
|
|
|
// do this in animation frame until componentDidMount actually runs after
|
|
|
|
// the component is laid out
|
|
|
|
this.requestAnimationFrame(() => {
|
|
|
|
this._measureAndUpdateScrollProps();
|
|
|
|
});
|
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
componentWillReceiveProps: function(nextProps: Object) {
|
2016-02-05 19:08:59 +00:00
|
|
|
if (this.props.dataSource !== nextProps.dataSource ||
|
|
|
|
this.props.initialListSize !== nextProps.initialListSize) {
|
2015-06-15 20:29:02 +00:00
|
|
|
this.setState((state, props) => {
|
2015-12-20 01:12:56 +00:00
|
|
|
this._prevRenderedRowsCount = 0;
|
2015-06-15 20:29:02 +00:00
|
|
|
return {
|
2016-01-07 03:15:16 +00:00
|
|
|
curRenderedRowsCount: Math.min(
|
2016-02-05 19:08:59 +00:00
|
|
|
Math.max(
|
|
|
|
state.curRenderedRowsCount,
|
|
|
|
props.initialListSize
|
|
|
|
),
|
2016-03-15 19:13:34 +00:00
|
|
|
props.enableEmptySections ? props.dataSource.getRowAndSectionCount() : props.dataSource.getRowCount()
|
2016-01-07 03:15:16 +00:00
|
|
|
),
|
|
|
|
};
|
2016-02-05 19:08:59 +00:00
|
|
|
}, () => this._renderMoreRowsIfNeeded());
|
2015-01-30 01:10:49 +00:00
|
|
|
}
|
|
|
|
},
|
|
|
|
|
2015-06-22 20:37:25 +00:00
|
|
|
componentDidUpdate: function() {
|
2015-06-26 17:25:54 +00:00
|
|
|
this.requestAnimationFrame(() => {
|
|
|
|
this._measureAndUpdateScrollProps();
|
|
|
|
});
|
2015-06-22 20:37:25 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_onRowHighlighted: function(sectionID: string, rowID: string) {
|
2015-05-26 22:16:42 +00:00
|
|
|
this.setState({highlightedRow: {sectionID, rowID}});
|
|
|
|
},
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
render: function() {
|
|
|
|
var bodyComponents = [];
|
|
|
|
|
|
|
|
var dataSource = this.props.dataSource;
|
|
|
|
var allRowIDs = dataSource.rowIdentities;
|
|
|
|
var rowCount = 0;
|
2017-01-09 11:08:05 +00:00
|
|
|
var stickySectionHeaderIndices = [];
|
2015-01-30 01:10:49 +00:00
|
|
|
|
2017-03-04 04:05:50 +00:00
|
|
|
const {renderSectionHeader} = this.props;
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
var header = this.props.renderHeader && this.props.renderHeader();
|
|
|
|
var footer = this.props.renderFooter && this.props.renderFooter();
|
|
|
|
var totalIndex = header ? 1 : 0;
|
|
|
|
|
|
|
|
for (var sectionIdx = 0; sectionIdx < allRowIDs.length; sectionIdx++) {
|
|
|
|
var sectionID = dataSource.sectionIdentities[sectionIdx];
|
|
|
|
var rowIDs = allRowIDs[sectionIdx];
|
|
|
|
if (rowIDs.length === 0) {
|
2016-03-15 19:13:34 +00:00
|
|
|
if (this.props.enableEmptySections === undefined) {
|
|
|
|
var warning = require('fbjs/lib/warning');
|
|
|
|
warning(false, 'In next release empty section headers will be rendered.'
|
|
|
|
+ ' In this release you can use \'enableEmptySections\' flag to render empty section headers.');
|
|
|
|
continue;
|
|
|
|
} else {
|
|
|
|
var invariant = require('fbjs/lib/invariant');
|
|
|
|
invariant(
|
|
|
|
this.props.enableEmptySections,
|
|
|
|
'In next release \'enableEmptySections\' flag will be deprecated, empty section headers will always be rendered.'
|
|
|
|
+ ' If empty section headers are not desirable their indices should be excluded from sectionIDs object.'
|
|
|
|
+ ' In this release \'enableEmptySections\' may only have value \'true\' to allow empty section headers rendering.');
|
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
}
|
|
|
|
|
2017-03-04 04:05:50 +00:00
|
|
|
if (renderSectionHeader) {
|
|
|
|
bodyComponents.push(React.cloneElement(
|
|
|
|
renderSectionHeader(
|
|
|
|
dataSource.getSectionHeaderData(sectionIdx),
|
|
|
|
sectionID
|
|
|
|
),
|
|
|
|
{key: 's_' + sectionID},
|
|
|
|
));
|
2017-01-09 11:08:05 +00:00
|
|
|
if (this.props.stickySectionHeadersEnabled) {
|
|
|
|
stickySectionHeaderIndices.push(totalIndex++);
|
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
for (var rowIdx = 0; rowIdx < rowIDs.length; rowIdx++) {
|
|
|
|
var rowID = rowIDs[rowIdx];
|
Ensure row key uniqueness for listview with sections
Summary: I encounter issues when using ListView with multiple Sections.
```
...
var ds = new ListView.DataSource({
rowHasChanged : (row1, row2) => row1 !== row2,
sectionHeaderHasChanged : (s1, s2) => s1 !== s2
});
...
getInitialState: function() {
var sectionIDs = [0,1,2]
var rowIDs = [
[0,1,2],
[0,1,2],
[0,1,2]
]
var dataBlob = [
[blob0,blob1,blob2],
[blob3,blob4,blob5],
[blob6,blob7,blob8],
]
return {
dataSource : ds.cloneWithRowsAndSections(dataBlob, sectionIDs, rowIDs),
};
```
the code above would throw error because of duplicate key, as ''sectionID0 + rowID0 === sectionID1 + rowID1'. And I have to do:
```
...
sectionIDs.map((id)=>{
return id+'';
});
rowIDs.map((sec)=>{
return sec,map((id)=>{
return id+'';
});
});
...
```
ListView with sections does not seem to be documented yet, so I am not sure if this is the intended behaviour or am I missing anything. Co
Closes https://github.com/facebook/react-native/pull/4082
Reviewed By: svcscm
Differential Revision: D2652028
Pulled By: mkonicek
fb-gh-sync-id: a9933bac1a1ae2d6cbc73a11ef6aefde6fcdb35f
2015-11-13 16:12:43 +00:00
|
|
|
var comboID = sectionID + '_' + rowID;
|
2015-12-20 01:12:56 +00:00
|
|
|
var shouldUpdateRow = rowCount >= this._prevRenderedRowsCount &&
|
2015-01-30 01:10:49 +00:00
|
|
|
dataSource.rowShouldUpdate(sectionIdx, rowIdx);
|
|
|
|
var row =
|
|
|
|
<StaticRenderer
|
|
|
|
key={'r_' + comboID}
|
|
|
|
shouldUpdate={!!shouldUpdateRow}
|
|
|
|
render={this.props.renderRow.bind(
|
|
|
|
null,
|
|
|
|
dataSource.getRowData(sectionIdx, rowIdx),
|
|
|
|
sectionID,
|
2015-05-26 22:16:42 +00:00
|
|
|
rowID,
|
2016-04-09 18:12:46 +00:00
|
|
|
this._onRowHighlighted
|
2015-01-30 01:10:49 +00:00
|
|
|
)}
|
|
|
|
/>;
|
|
|
|
bodyComponents.push(row);
|
|
|
|
totalIndex++;
|
2015-05-26 22:16:42 +00:00
|
|
|
|
|
|
|
if (this.props.renderSeparator &&
|
2017-02-07 02:32:52 +00:00
|
|
|
(rowIdx !== rowIDs.length - 1 || sectionIdx === allRowIDs.length - 1)) {
|
2015-05-26 22:16:42 +00:00
|
|
|
var adjacentRowHighlighted =
|
|
|
|
this.state.highlightedRow.sectionID === sectionID && (
|
|
|
|
this.state.highlightedRow.rowID === rowID ||
|
|
|
|
this.state.highlightedRow.rowID === rowIDs[rowIdx + 1]
|
|
|
|
);
|
|
|
|
var separator = this.props.renderSeparator(
|
|
|
|
sectionID,
|
|
|
|
rowID,
|
|
|
|
adjacentRowHighlighted
|
|
|
|
);
|
2016-02-26 01:07:37 +00:00
|
|
|
if (separator) {
|
2017-02-03 03:50:04 +00:00
|
|
|
bodyComponents.push(
|
|
|
|
<View key={'s_' + comboID}>
|
|
|
|
{separator}
|
|
|
|
</View>
|
|
|
|
);
|
2016-02-26 01:07:37 +00:00
|
|
|
totalIndex++;
|
|
|
|
}
|
2015-05-26 22:16:42 +00:00
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
if (++rowCount === this.state.curRenderedRowsCount) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (rowCount >= this.state.curRenderedRowsCount) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-07-01 16:02:38 +00:00
|
|
|
var {
|
|
|
|
renderScrollComponent,
|
2016-10-05 11:41:32 +00:00
|
|
|
...props
|
2015-07-01 16:02:38 +00:00
|
|
|
} = this.props;
|
2015-03-31 03:12:32 +00:00
|
|
|
if (!props.scrollEventThrottle) {
|
|
|
|
props.scrollEventThrottle = DEFAULT_SCROLL_CALLBACK_THROTTLE;
|
2015-01-30 01:10:49 +00:00
|
|
|
}
|
2015-10-13 15:04:34 +00:00
|
|
|
if (props.removeClippedSubviews === undefined) {
|
|
|
|
props.removeClippedSubviews = true;
|
|
|
|
}
|
2015-07-01 16:02:38 +00:00
|
|
|
Object.assign(props, {
|
|
|
|
onScroll: this._onScroll,
|
2017-01-09 11:08:05 +00:00
|
|
|
stickyHeaderIndices: this.props.stickyHeaderIndices.concat(stickySectionHeaderIndices),
|
2015-07-27 18:11:59 +00:00
|
|
|
|
|
|
|
// Do not pass these events downstream to ScrollView since they will be
|
|
|
|
// registered in ListView's own ScrollResponder.Mixin
|
|
|
|
onKeyboardWillShow: undefined,
|
|
|
|
onKeyboardWillHide: undefined,
|
|
|
|
onKeyboardDidShow: undefined,
|
|
|
|
onKeyboardDidHide: undefined,
|
2015-07-01 16:02:38 +00:00
|
|
|
});
|
|
|
|
|
2016-04-14 13:40:54 +00:00
|
|
|
return cloneReferencedElement(renderScrollComponent(props), {
|
|
|
|
ref: this._setScrollComponentRef,
|
2015-11-20 15:36:23 +00:00
|
|
|
onContentSizeChange: this._onContentSizeChange,
|
|
|
|
onLayout: this._onLayout,
|
2015-07-24 00:50:16 +00:00
|
|
|
}, header, bodyComponents, footer);
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Private methods
|
|
|
|
*/
|
|
|
|
|
|
|
|
_measureAndUpdateScrollProps: function() {
|
2015-07-13 19:26:57 +00:00
|
|
|
var scrollComponent = this.getScrollResponder();
|
2015-07-13 19:27:02 +00:00
|
|
|
if (!scrollComponent || !scrollComponent.getInnerViewNode) {
|
|
|
|
return;
|
|
|
|
}
|
2015-07-20 19:32:14 +00:00
|
|
|
|
|
|
|
// RCTScrollViewManager.calculateChildFrames is not available on
|
|
|
|
// every platform
|
|
|
|
RCTScrollViewManager && RCTScrollViewManager.calculateChildFrames &&
|
|
|
|
RCTScrollViewManager.calculateChildFrames(
|
2016-04-08 02:43:49 +00:00
|
|
|
ReactNative.findNodeHandle(scrollComponent),
|
2015-12-20 01:12:56 +00:00
|
|
|
this._updateVisibleRows,
|
2015-07-20 19:32:14 +00:00
|
|
|
);
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_setScrollComponentRef: function(scrollComponent: Object) {
|
2016-04-14 13:40:54 +00:00
|
|
|
this._scrollComponent = scrollComponent;
|
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_onContentSizeChange: function(width: number, height: number) {
|
2015-12-30 12:52:34 +00:00
|
|
|
var contentLength = !this.props.horizontal ? height : width;
|
|
|
|
if (contentLength !== this.scrollProperties.contentLength) {
|
|
|
|
this.scrollProperties.contentLength = contentLength;
|
|
|
|
this._updateVisibleRows();
|
|
|
|
this._renderMoreRowsIfNeeded();
|
2015-12-10 20:42:22 +00:00
|
|
|
}
|
2015-12-30 12:52:34 +00:00
|
|
|
this.props.onContentSizeChange && this.props.onContentSizeChange(width, height);
|
2015-11-20 15:36:23 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_onLayout: function(event: Object) {
|
2015-11-20 15:36:23 +00:00
|
|
|
var {width, height} = event.nativeEvent.layout;
|
2015-12-30 12:52:34 +00:00
|
|
|
var visibleLength = !this.props.horizontal ? height : width;
|
|
|
|
if (visibleLength !== this.scrollProperties.visibleLength) {
|
|
|
|
this.scrollProperties.visibleLength = visibleLength;
|
|
|
|
this._updateVisibleRows();
|
|
|
|
this._renderMoreRowsIfNeeded();
|
2016-02-01 22:52:33 +00:00
|
|
|
}
|
2015-12-30 12:52:34 +00:00
|
|
|
this.props.onLayout && this.props.onLayout(event);
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_maybeCallOnEndReached: function(event?: Object) {
|
2015-10-05 20:42:25 +00:00
|
|
|
if (this.props.onEndReached &&
|
|
|
|
this.scrollProperties.contentLength !== this._sentEndForContentLength &&
|
|
|
|
this._getDistanceFromEnd(this.scrollProperties) < this.props.onEndReachedThreshold &&
|
2016-03-15 19:13:34 +00:00
|
|
|
this.state.curRenderedRowsCount === (this.props.enableEmptySections ? this.props.dataSource.getRowAndSectionCount() : this.props.dataSource.getRowCount())) {
|
2015-10-05 20:42:25 +00:00
|
|
|
this._sentEndForContentLength = this.scrollProperties.contentLength;
|
|
|
|
this.props.onEndReached(event);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
},
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
_renderMoreRowsIfNeeded: function() {
|
2015-07-15 17:05:13 +00:00
|
|
|
if (this.scrollProperties.contentLength === null ||
|
|
|
|
this.scrollProperties.visibleLength === null ||
|
2016-03-15 19:13:34 +00:00
|
|
|
this.state.curRenderedRowsCount === (this.props.enableEmptySections ? this.props.dataSource.getRowAndSectionCount() : this.props.dataSource.getRowCount())) {
|
2015-10-05 20:42:25 +00:00
|
|
|
this._maybeCallOnEndReached();
|
2015-01-30 01:10:49 +00:00
|
|
|
return;
|
|
|
|
}
|
2016-02-01 22:52:33 +00:00
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
var distanceFromEnd = this._getDistanceFromEnd(this.scrollProperties);
|
|
|
|
if (distanceFromEnd < this.props.scrollRenderAheadDistance) {
|
|
|
|
this._pageInNewRows();
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
_pageInNewRows: function() {
|
2015-06-15 20:29:02 +00:00
|
|
|
this.setState((state, props) => {
|
|
|
|
var rowsToRender = Math.min(
|
|
|
|
state.curRenderedRowsCount + props.pageSize,
|
2016-03-17 19:10:35 +00:00
|
|
|
(props.enableEmptySections ? props.dataSource.getRowAndSectionCount() : props.dataSource.getRowCount())
|
2015-06-15 20:29:02 +00:00
|
|
|
);
|
2015-12-20 01:12:56 +00:00
|
|
|
this._prevRenderedRowsCount = state.curRenderedRowsCount;
|
2015-06-15 20:29:02 +00:00
|
|
|
return {
|
2015-01-30 01:10:49 +00:00
|
|
|
curRenderedRowsCount: rowsToRender
|
2015-06-15 20:29:02 +00:00
|
|
|
};
|
|
|
|
}, () => {
|
|
|
|
this._measureAndUpdateScrollProps();
|
2015-12-20 01:12:56 +00:00
|
|
|
this._prevRenderedRowsCount = this.state.curRenderedRowsCount;
|
2015-06-15 20:29:02 +00:00
|
|
|
});
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_getDistanceFromEnd: function(scrollProperties: Object) {
|
Fixed missing rows on UIExplorer <ListView> - Grid Layout example
Summary:
public
I was looking into the missing panels at the bottom of the <ListView> - Grid Layout example, and found that it was caused by several problems, some in the example and some in ListView itself.
The first problem seemed to be a bug in the `_getDistanceFromEnd()` method, which calculates whether the ListView needs to load more content based on the distance of the visible content from the bottom of the scrollview. This was previously using the function
Math.max(scrollProperties.contentLength, scrollProperties.visibleLength) - scrollProperties.visibleLength - scrollProperties.offset
to calculate the amount the user could scroll before they run out of content. This sort-of works in most cases because `scrollProperties.contentLength` is usually longer than `scrollProperties.visibleLength`, so this would generally evaluate to
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
which meant that it would be positive as long as there was content still to be displayed offscreen, and negative when you reached the end of the content. This logic breaks down if `contentLength` is less than `visibleLength`, however. For example, if you have 300pts of content loaded, and your scrollView is 500pts tall, and your scroll position is zero, this evaluates to
Math.max(300, 500) - 500 - 0 = 0
In other words, the algorithm is saying that you have zero pts of scroll content remaining before you need to reload. But actually, the bottom 200pts of the screen are empty, so you're really 200pts in debt, and need to load extra rows to fill that space. The correct algorithm is simply to get rid of the `Math.max` and just use
scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset
I originally thought that this was the cause of the gap, but it isn't, because ListView has `DEFAULT_SCROLL_RENDER_AHEAD = 1000`, which means that it tries to load at least 1000pts more content than is currently visible, to avoid gaps. This masked the bug, so in practice it wasn't causing an issue.
The next problem I found was that there is an implict assumption in ListView that the first page of content you load is sufficient to cover the screen, or rather, that the first _ second page is sufficient. The constants `DEFAULT_INITIAL_ROWS = 10` and `DEFAULT_PAGE_SIZE = 1`, mean that when the ListView first loads, the following happens:
1. It loads 10 rows of content.
2. It checks if `_getDistanceFromEnd() < DEFAULT_SCROLL_RENDER_AHEAD` (1000).
3. If it is, it loads another `DEFAULT_PAGE_SIZE` rows of content, then stops.
In the case of the ListView Grid Layout example, this meant that it first loaded 10 cells, then loaded another 1, for a total of 11. The problem was that going from 10 to 11 cells isn't sufficient to fill the visible scroll area, and it doesn't change the `contentSize` (since the cells wrap onto the same line), and since ListView doesn't try to load any more until the `contentSize` or `scrollOffset ` changes, it stops loading new rows at that point.
I tried fixing this by calling `_renderMoreRowsIfNeeded()` after `_pageInNewRows()` so that it will continue to fetch new rows until the `_getDistanceFromEnd()` is less than the threshold, rather than stopping after the first page and waiting until the `contentSize` or `scrollOffset` change, but although this solves the problem for the Grid Layout example, it leads to over-fetching in the more common case of a standard row-based ListView.
In the end, I just increased the `pageSize` to 3 for the Grid Layout example, which makes more sense anyway since loading a page that is not a multiple of the number of cells per row confuses the `_renderMoreRowsIfNeeded` algorithm, and leads to gaps at the bottom of the view.
This solved the problem, however there was still a "pop-in" effect, where the additional rows were paged in after the ListView appeared. This was simply a misconfiguration in the example itself: The default of 10 rows was insufficient to fill the screen, so I changed the `initialListSize` prop to `20`.
Reviewed By: javache
Differential Revision: D2911690
fb-gh-sync-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
shipit-source-id: 8d6bd78843335fb091e7e24f7c2e6a416b0321d3
2016-02-10 16:36:15 +00:00
|
|
|
return scrollProperties.contentLength - scrollProperties.visibleLength - scrollProperties.offset;
|
2015-01-30 01:10:49 +00:00
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_updateVisibleRows: function(updatedFrames?: Array<Object>) {
|
2015-01-30 01:10:49 +00:00
|
|
|
if (!this.props.onChangeVisibleRows) {
|
|
|
|
return; // No need to compute visible rows if there is no callback
|
|
|
|
}
|
|
|
|
if (updatedFrames) {
|
2015-06-01 20:27:21 +00:00
|
|
|
updatedFrames.forEach((newFrame) => {
|
|
|
|
this._childFrames[newFrame.index] = merge(newFrame);
|
2015-01-30 01:10:49 +00:00
|
|
|
});
|
|
|
|
}
|
2015-07-15 17:05:13 +00:00
|
|
|
var isVertical = !this.props.horizontal;
|
2015-01-30 01:10:49 +00:00
|
|
|
var dataSource = this.props.dataSource;
|
2015-07-15 17:05:13 +00:00
|
|
|
var visibleMin = this.scrollProperties.offset;
|
|
|
|
var visibleMax = visibleMin + this.scrollProperties.visibleLength;
|
2015-01-30 01:10:49 +00:00
|
|
|
var allRowIDs = dataSource.rowIdentities;
|
|
|
|
|
|
|
|
var header = this.props.renderHeader && this.props.renderHeader();
|
|
|
|
var totalIndex = header ? 1 : 0;
|
|
|
|
var visibilityChanged = false;
|
2015-03-12 19:51:44 +00:00
|
|
|
var changedRows = {};
|
|
|
|
for (var sectionIdx = 0; sectionIdx < allRowIDs.length; sectionIdx++) {
|
2015-01-30 01:10:49 +00:00
|
|
|
var rowIDs = allRowIDs[sectionIdx];
|
|
|
|
if (rowIDs.length === 0) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
var sectionID = dataSource.sectionIdentities[sectionIdx];
|
|
|
|
if (this.props.renderSectionHeader) {
|
|
|
|
totalIndex++;
|
|
|
|
}
|
|
|
|
var visibleSection = this._visibleRows[sectionID];
|
|
|
|
if (!visibleSection) {
|
|
|
|
visibleSection = {};
|
|
|
|
}
|
|
|
|
for (var rowIdx = 0; rowIdx < rowIDs.length; rowIdx++) {
|
|
|
|
var rowID = rowIDs[rowIdx];
|
|
|
|
var frame = this._childFrames[totalIndex];
|
|
|
|
totalIndex++;
|
2016-06-23 16:23:09 +00:00
|
|
|
if (this.props.renderSeparator &&
|
2016-05-20 15:04:10 +00:00
|
|
|
(rowIdx !== rowIDs.length - 1 || sectionIdx === allRowIDs.length - 1)){
|
|
|
|
totalIndex++;
|
|
|
|
}
|
2015-01-30 01:10:49 +00:00
|
|
|
if (!frame) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
var rowVisible = visibleSection[rowID];
|
2015-07-15 17:05:13 +00:00
|
|
|
var min = isVertical ? frame.y : frame.x;
|
|
|
|
var max = min + (isVertical ? frame.height : frame.width);
|
2016-05-17 01:18:58 +00:00
|
|
|
if ((!min && !max) || (min === max)) {
|
|
|
|
break;
|
|
|
|
}
|
2015-07-15 17:05:13 +00:00
|
|
|
if (min > visibleMax || max < visibleMin) {
|
2015-01-30 01:10:49 +00:00
|
|
|
if (rowVisible) {
|
|
|
|
visibilityChanged = true;
|
|
|
|
delete visibleSection[rowID];
|
|
|
|
if (!changedRows[sectionID]) {
|
|
|
|
changedRows[sectionID] = {};
|
|
|
|
}
|
|
|
|
changedRows[sectionID][rowID] = false;
|
|
|
|
}
|
|
|
|
} else if (!rowVisible) {
|
|
|
|
visibilityChanged = true;
|
|
|
|
visibleSection[rowID] = true;
|
|
|
|
if (!changedRows[sectionID]) {
|
|
|
|
changedRows[sectionID] = {};
|
|
|
|
}
|
|
|
|
changedRows[sectionID][rowID] = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (!isEmpty(visibleSection)) {
|
|
|
|
this._visibleRows[sectionID] = visibleSection;
|
|
|
|
} else if (this._visibleRows[sectionID]) {
|
|
|
|
delete this._visibleRows[sectionID];
|
|
|
|
}
|
|
|
|
}
|
|
|
|
visibilityChanged && this.props.onChangeVisibleRows(this._visibleRows, changedRows);
|
|
|
|
},
|
|
|
|
|
2016-06-23 16:23:09 +00:00
|
|
|
_onScroll: function(e: Object) {
|
2015-07-15 17:05:13 +00:00
|
|
|
var isVertical = !this.props.horizontal;
|
|
|
|
this.scrollProperties.visibleLength = e.nativeEvent.layoutMeasurement[
|
|
|
|
isVertical ? 'height' : 'width'
|
|
|
|
];
|
|
|
|
this.scrollProperties.contentLength = e.nativeEvent.contentSize[
|
|
|
|
isVertical ? 'height' : 'width'
|
|
|
|
];
|
|
|
|
this.scrollProperties.offset = e.nativeEvent.contentOffset[
|
|
|
|
isVertical ? 'y' : 'x'
|
|
|
|
];
|
2015-07-07 14:38:24 +00:00
|
|
|
this._updateVisibleRows(e.nativeEvent.updatedChildFrames);
|
2015-10-05 20:42:25 +00:00
|
|
|
if (!this._maybeCallOnEndReached(e)) {
|
2015-01-30 01:10:49 +00:00
|
|
|
this._renderMoreRowsIfNeeded();
|
|
|
|
}
|
|
|
|
|
2015-11-04 19:25:47 +00:00
|
|
|
if (this.props.onEndReached &&
|
|
|
|
this._getDistanceFromEnd(this.scrollProperties) > this.props.onEndReachedThreshold) {
|
|
|
|
// Scrolled out of the end zone, so it should be able to trigger again.
|
|
|
|
this._sentEndForContentLength = null;
|
|
|
|
}
|
|
|
|
|
2015-01-30 01:10:49 +00:00
|
|
|
this.props.onScroll && this.props.onScroll(e);
|
|
|
|
},
|
|
|
|
});
|
|
|
|
|
|
|
|
module.exports = ListView;
|