Skip to content

Commit 9fc6359

Browse files
chore: updating readme
1 parent 47d4076 commit 9fc6359

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,17 @@
33
[![GitHub Workflow Status](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/GetStream/react-native-bidirectional-infinite-scroll/blob/main/LICENSE)
44
[![Compatibility](https://img.shields.io/badge/react--native%20--%20android%20%7C%20iOS-compatible-brightgreen)](https://reactnative.dev/)
55

6-
Birectional infinite scroll for react-native, with **smooth scrolling**.
7-
86
**[** Built with ♥ at [Stream](https://getstream.io/) **]**
97

8+
[FlatList](https://reactnative.dev/docs/flatlist) by react-native only allows infinite scroll in one direction (using `onEndReached`). This package adds capability on top of FlatList to allow infinite scroll from both directions, and also maintains **smooth scroll** UX.
9+
10+
**Features**
11+
12+
- Accepts prop `onStartReached` & `onEndReached`, which you can use to load more results.
13+
- Calls to onEndReached and onStartReached have been optimized.
14+
- Inline loading Indicators, which can be customized as well.
15+
- Uses [flat-list-mvcp](https://github.com/GetStream/flat-list-mvcp#maintainvisiblecontentposition-prop-support-for-android-react-native) to maintain scroll position or smooth scroll UX.
16+
1017

1118
<table>
1219
<tr>

0 commit comments

Comments
 (0)