@ktree/viewpager
v5.0.1TypeScript
React Native wrapper for Android and iOS ViewPager
1/weekUpdated 3 years agoMITUnpacked: 140.6 KB
Published by Ismail
npm install @ktree/viewpagerreact-native-viewpager
This component allows the user to swipe left and right through pages of data. Under the hood it is using the native Android ViewPager and the iOS UIPageViewController implementations. See it in action!
Versions
| 1.x | 2.x | 3.x | 4.x |
| ---------------- | ------------- | ------------- | ------------- |
| | iOS support | iOS support | iOS support |
| Android support | Android support | AndroidX support | ViewPager2 support |
Getting started
yarn add @react-native-community/viewpager
Linking
$3
Autolinking will just do the job.
$3
#### Mostly automatic
react-native link @react-native-community/viewpager
#### Manual linking
Manually link the library on iOS
Follow the instructions in the React Native documentation to manually link the framework or link using Cocoapods by adding this to your Podfile:
``ruby`
pod 'react-native-viewpager', :path => '../node_modules/@react-native-community/viewpager'
Manually link the library on Android
Make the following changes:
#### android/settings.gradlegroovy`
include ':@react-native-community_viewpager'
project(':@react-native-community_viewpager').projectDir = new File(rootProject.projectDir, '../node_modules/@react-native-community/viewpager/android')
#### android/app/build.gradlegroovy`
dependencies {
...
implementation project(':@react-native-community_viewpager')
}
#### android/app/src/main/.../MainApplication.java
On top, where imports are:
`java`
import com.reactnativecommunity.viewpager.RNCViewPagerPackage;
Add the RNCViewPagerPackage class to your list of exported packages.
`java`
@Override
protected List
return Arrays.
new MainReactPackage(),
new RNCViewPagerPackage()
);
}
Usage
`js
import React from 'react';
import {StyleSheet, View, Text} from 'react-native';
import ViewPager from '@react-native-community/viewpager';
const MyPager = () => {
return (
);
};
const styles = StyleSheet.create({
viewPager: {
flex: 1,
},
});
`
API
|Prop|Description|Platform|
|-|:-----:|:---:|
|initialPage|Index of initial page that should be selected|bothscrollEnabled: boolean
||Should viewpager scroll, when scroll enabled|bothonPageScroll: (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)|bothonPageScrollStateChanged: (e: PageScrollStateChangedEvent) => void
||Function called when the page scrolling state has changed|bothonPageSelected: (e: PageSelectedEvent) => void
||This callback will be called once the ViewPager finishes navigating to the selected page|bothpageMargin: number
||Blank space to be shown between pages|bothkeyboardDismissMode: ('none' / 'on-drag')
|| Determines whether the keyboard gets dismissed in response to a drag|bothorientation: Orientation
||Set horizontal or vertical scrolling orientation (it does not work dynamically)|bothtransitionStyle: TransitionStyle
||Use scroll or curl to change transition style (it does not work dynamically)|iOSshowPageIndicator: boolean
||Shows the dots indicator at the bottom of the view|iOSoverScrollMode: OverScollMode
||Used to override default value of overScroll mode. Can be auto, always or never. Defaults to auto`|Android
Preview
$3
horizontal | vertical
:-------------------------:|:-------------------------:
| 
$3
horizontal - scroll | horizontal - curl
:-------------------------:|:-------------------------:
| 
vertical - scroll | vertical - curl
:-------------------------:|:-------------------------:
| 