Skip to content

Commit 808f855

Browse files
author
Bas Pellis
committed
Updated readme
1 parent 45029e6 commit 808f855

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# react-native-infinite-scrollview
1+
## react-native-infinite-scrollview
22
ScrollView with infinte paged scrolling (no looping). The number of pages rendered before and after current page can be customized. Pages are rendered when user scrolled.
3+
4+
### Content
5+
- [Installation](#installation)
6+
- [Examples](#examples)
7+
- [API](#api)
8+
- [Questions?](#questions)
9+
10+
### Installation
11+
```bash
12+
npm i react-native-infinite-scrollview --save
13+
```
14+
15+
### Examples
16+
Simple Calendar example included.
17+
![react-native-infinite-scrollview demo](https://raw.githubusercontent.com/baspellis/react-native-infinite-scrollview/master/example/video/demo.gif)
18+
19+
### API
20+
- **renderPage** - Required - (Function) - Must return a component representing the page for the provided index.
21+
- **horizontal** - Optional - (Boolean) - Scroll horizontal instead of vertical (default).
22+
- **offScreenPages** - Optional - (Integer) - Number of pages to render before and after the current page. Default is 1 (total 3 pages are rendered).
23+
24+
### Questions?
25+
Feel free to contact me via
26+
- [Twitter](https://twitter.com/baspellis)
27+
28+
If you want to report a bug, please [submit an issue!](https://github.com/baspellis/react-native-infinite-scrollview/issues/new)

0 commit comments

Comments
 (0)