Skip to content

Commit 42dccbf

Browse files
authored
chore: fix readme (#307)
1 parent e759a46 commit 42dccbf

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Lean Core Extracted](https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg)](https://github.com/facebook/react-native/issues/23313)
66
[![License](https://img.shields.io/github/license/react-native-community/react-native-viewpager?color=blue)](https://github.com/callstack/react-native-viewpager/blob/master/LICENSE)
77

8-
This component allows the user to swipe left and right through pages of data. Under the hood it is using the native [Android ViewPager](https://developer.android.com/reference/android/support/v4/view/ViewPager) and the [iOS UIPageViewController](https://developer.apple.com/documentation/uikit/uipageviewcontroller) implementations. [See it in action!](https://github.com/react-native-community/react-native-viewpager#preview)
8+
This component allows the user to swipe left and right through pages of data. Under the hood it is using the native [Android ViewPager](https://developer.android.com/reference/android/support/v4/view/ViewPager) and the [iOS UIPageViewController](https://developer.apple.com/documentation/uikit/uipageviewcontroller) implementations. [See it in action!](https://github.com/callstack/react-native-pager-view#preview)
99

1010
<br/>
1111
<p align="center">
@@ -127,14 +127,14 @@ const styles = StyleSheet.create({
127127
## Advanced usage
128128

129129
//TODO
130-
For advanced usage please take a look into our [example project](https://github.com/callstack/react-native-viewpager/blob/master/example/src/BasicViewPagerExample.tsx)
130+
For advanced usage please take a look into our [example project](https://github.com/callstack/react-native-pager-view/blob/master/example/src/BasicPagerViewExample.tsx)
131131

132132
## API
133133

134134
|Prop|Description|Platform|
135135
|-|:-----:|:---:|
136136
|`initialPage`|Index of initial page that should be selected|both
137-
|`scrollEnabled: boolean`|Should viewpager scroll, when scroll enabled|both
137+
|`scrollEnabled: boolean`|Should pager view scroll, when scroll enabled|both
138138
|`onPageScroll: (e: PageScrollEvent) => void`|Executed when transitioning between pages (ether because the animation for the requested page has changed or when the user is swiping/dragging between pages)|both
139139
|`onPageScrollStateChanged: (e: PageScrollStateChangedEvent) => void`|Function called when the page scrolling state has changed|both
140140
|`onPageSelected: (e: PageSelectedEvent) => void`|This callback will be called once the ViewPager finishes navigating to the selected page|both
@@ -153,12 +153,12 @@ See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the
153153

154154
## Known Issues
155155

156-
- `flex:1` does not work for child views, please use `width:”100%”, height:”100%” ` [instead](https://github.com/react-native-community/react-native-viewpager/issues/186#issuecomment-675320732)
156+
- `flex:1` does not work for child views, please use `width:”100%”, height:”100%” ` [instead](https://github.com/callstack/react-native-pager-view/issues/186#issuecomment-675320732)
157157

158158
- [iOS]: In case of `UIViewControllerHierarchyInconsistency` error, please use below fix:
159159

160160
```
161-
requestAnimationFrame(() => refViewPager.current?.setPage(index));
161+
requestAnimationFrame(() => refPagerView.current?.setPage(index));
162162
```
163163

164164
## Preview

0 commit comments

Comments
 (0)