Skip to content

Commit

Permalink
Update flatlist apis for facebook#929 (facebook#940)
Browse files Browse the repository at this point in the history
* Update flatlist apis for facebook#929

-alphabetized api list

(incomplete)

* adding missing APIs

Adding missing APIs:

-ListFooterComponentStyle
-ListHeaderComponentStyle

### methods
-getScrollResponder()
-getScrollableNode()
-setNativeProps

FYI, I didn't see a solid description for setNativeProps, so I linked the Direct Manipulation page.

* Update flatlist.md
  • Loading branch information
dayhaysoos authored and cpojer committed May 20, 2019
1 parent 7ef9364 commit 9063207
Showing 1 changed file with 55 additions and 10 deletions.
65 changes: 55 additions & 10 deletions docs/flatlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,42 +98,47 @@ Also inherits [ScrollView Props](scrollview.md#props), unless it is nested in an

### Props

- [`ScrollView` props...](scrollview.md#props)
- [`VirtualizedList` props...](virtualizedlist.md#props)
- [`renderItem`](flatlist.md#renderitem)
- [`data`](flatlist.md#data)
- [`ItemSeparatorComponent`](flatlist.md#itemseparatorcomponent)
- [`ListEmptyComponent`](flatlist.md#listemptycomponent)
- [`ListFooterComponent`](flatlist.md#listfootercomponent)
- [`ListHeaderComponent`](flatlist.md#listheadercomponent)
- [`columnWrapperStyle`](flatlist.md#columnwrapperstyle)
- [`data`](flatlist.md#data)
- [`extraData`](flatlist.md#extradata)
- [`getItemLayout`](flatlist.md#getitemlayout)
- [`horizontal`](flatlist.md#horizontal)
- [`initialNumToRender`](flatlist.md#initialnumtorender)
- [`initialScrollIndex`](flatlist.md#initialscrollindex)
- [`inverted`](flatlist.md#inverted)
- [`ItemSeparatorComponent`](flatlist.md#itemseparatorcomponent)
- [`keyExtractor`](flatlist.md#keyextractor)
- [`legacyImplementation`](flatlist.md#legacyimplementation)
- [`ListEmptyComponent`](flatlist.md#listemptycomponent)
- [`ListFooterComponent`](flatlist.md#listfootercomponent)
- [`ListFooterComponentStyle`](flatlist.md#listfootercomponentstyle)
- [`ListHeaderComponent`](flatlist.md#listheadercomponent)
- [`ListHeaderComponentStyle`](flatlist.md#listheadercomponentstyle)
- [`numColumns`](flatlist.md#numcolumns)
- [`onEndReached`](flatlist.md#onendreached)
- [`onEndReachedThreshold`](flatlist.md#onendreachedthreshold)
- [`onRefresh`](flatlist.md#onrefresh)
- [`onViewableItemsChanged`](flatlist.md#onviewableitemschanged)
- [`progressViewOffset`](flatlist.md#progressviewoffset)
- [`legacyImplementation`](flatlist.md#legacyimplementation)
- [`refreshing`](flatlist.md#refreshing)
- [`renderItem`](flatlist.md#renderitem)
- [`removeClippedSubviews`](flatlist.md#removeclippedsubviews)
- [`ScrollView` props...](scrollview.md#props)
- [`viewabilityConfig`](flatlist.md#viewabilityconfig)
- [`viewabilityConfigCallbackPairs`](flatlist.md#viewabilityconfigcallbackpairs)
- [`VirtualizedList` props...](virtualizedlist.md#props)


### Methods

- [`flashScrollIndicators`](flatlist.md#flashscrollindicators)
- [`getScrollResponder`](flatlist.md#getScrollResponder)
- [`getScrollableNode`](flatlist.md#getScrollableNode)
- [`scrollToEnd`](flatlist.md#scrolltoend)
- [`scrollToIndex`](flatlist.md#scrolltoindex)
- [`scrollToItem`](flatlist.md#scrolltoitem)
- [`scrollToOffset`](flatlist.md#scrolltooffset)
- [`recordInteraction`](flatlist.md#recordinteraction)
- [`flashScrollIndicators`](flatlist.md#flashscrollindicators)

---

Expand Down Expand Up @@ -218,6 +223,16 @@ Rendered at the bottom of all the items. Can be a React Component Class, a rende

---

### `ListFooterComponentStyle`

Styling for internal View for ListFooterComponent

| Type | Required |
| ---------------------------- | -------- |
| style object | No |

---

### `ListHeaderComponent`

Rendered at the top of all the items. Can be a React Component Class, a render function, or a rendered element.
Expand All @@ -228,6 +243,16 @@ Rendered at the top of all the items. Can be a React Component Class, a render f

---

### `ListHeaderComponentStyle`

Styling for internal View for ListHeaderComponent

| Type | Required |
| ---------------------------- | -------- |
| style object | No |

---

### `columnWrapperStyle`

Optional custom style for multi-item rows generated when `numColumns > 1`.
Expand Down Expand Up @@ -606,3 +631,23 @@ flashScrollIndicators();
```

Displays the scroll indicators momentarily.

---

### `getScrollResponder()`

```javascript
getScrollResponder();
```

Provides a handle to the underlying scroll responder.

---

### `getScrollableNode()`

```javascript
getScrollableNode();
```

Provides a handle to the underlying scroll node.

0 comments on commit 9063207

Please sign in to comment.