Exposed progressViewOffset to VirtualizedList and FlatList

Reviewed By: sahrens Differential Revision: D5204107 fbshipit-source-id: df2928830f84ea012d532f24c776dee8d2b96989
facebook · Jun 8, 2017 · a0a7d97 · a0a7d97
1 parent 5840a90
commit a0a7d97
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 3 deletions.
diff --git a/Libraries/Lists/FlatList.js b/Libraries/Lists/FlatList.js
@@ -163,6 +163,11 @@ type OptionalProps<ItemT> = {
     viewableItems: Array<ViewToken>,
     changed: Array<ViewToken>,
   }) => void,
+  /**
+   * Set this when offset is needed for the loading indicator to show correctly.
+   * @platform android
+   */
+  progressViewOffset?: number,
   legacyImplementation?: ?boolean,
   /**
    * Set this true while waiting for new data from a refresh.
@@ -326,7 +331,7 @@ class FlatList<ItemT> extends React.PureComponent<DefaultProps, Props<ItemT>, vo
 
   /**
    * Scroll to a specific content pixel offset in the list.
-   * 
+   *
    * Check out [scrollToOffset](docs/virtualizedlist.html#scrolltooffset) of VirtualizedList
    */
   scrollToOffset(params: {animated?: ?boolean, offset: number}) {

diff --git a/Libraries/Lists/VirtualizedList.js b/Libraries/Lists/VirtualizedList.js
@@ -121,6 +121,11 @@ type OptionalProps = {
     viewableItems: Array<ViewToken>,
     changed: Array<ViewToken>,
   }) => void,
+  /**
+   * Set this when offset is needed for the loading indicator to show correctly.
+   * @platform android
+   */
+  progressViewOffset?: number,
   /**
    * Set this true while waiting for new data from a refresh.
    */
@@ -240,11 +245,11 @@ class VirtualizedList extends React.PureComponent<OptionalProps, Props, State> {
 
   /**
    * Scroll to a specific content pixel offset in the list.
-   * 
+   *
    * Param `offset` expects the offset to scroll to.
    * In case of `horizontal` is true, the offset is the x-value,
    * in any other case the offset is the y-value.
-   * 
+   *
    * Param `animated` (`true` by default) defines whether the list
    * should do an animation while scrolling.
    */
@@ -303,13 +308,15 @@ class VirtualizedList extends React.PureComponent<OptionalProps, Props, State> {
           '`refreshing` prop must be set as a boolean in order to use `onRefresh`, but got `' +
             JSON.stringify(props.refreshing) + '`',
         );
+
         return (
           <ScrollView
             {...props}
             refreshControl={
               <RefreshControl
                 refreshing={props.refreshing}
                 onRefresh={props.onRefresh}
+                progressViewOffset={props.progressViewOffset}
               />
             }
           />

diff --git a/Libraries/Lists/__tests__/__snapshots__/FlatList-test.js.snap b/Libraries/Lists/__tests__/__snapshots__/FlatList-test.js.snap
@@ -46,6 +46,7 @@ exports[`FlatList renders all the bells and whistles 1`] = `
   refreshControl={
     <RefreshControlMock
       onRefresh={[Function]}
+      progressViewOffset={undefined}
       refreshing={false}
     />
   }

diff --git a/Libraries/Lists/__tests__/__snapshots__/SectionList-test.js.snap b/Libraries/Lists/__tests__/__snapshots__/SectionList-test.js.snap
@@ -281,6 +281,7 @@ exports[`SectionList renders all the bells and whistles 1`] = `
   refreshControl={
     <RefreshControlMock
       onRefresh={[Function]}
+      progressViewOffset={undefined}
       refreshing={false}
     />
   }

diff --git a/Libraries/Lists/__tests__/__snapshots__/VirtualizedList-test.js.snap b/Libraries/Lists/__tests__/__snapshots__/VirtualizedList-test.js.snap
@@ -282,6 +282,7 @@ exports[`VirtualizedList renders all the bells and whistles 1`] = `
   refreshControl={
     <RefreshControlMock
       onRefresh={[Function]}
+      progressViewOffset={undefined}
       refreshing={false}
     />
   }