2.0.3 • Published 2 years ago

react-native-zc-viewpager v2.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-native-viewpager

CircleCI branch npm package Lean Core Extracted License

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.x2.x
iOS support
Android supportAndroid support

Getting started

yarn add @react-native-community/viewpager

Linking

>= 0.60

Autolinking will just do the job.

< 0.60

Mostly automatic

react-native link @react-native-community/viewpager

Manual linking

Follow the instructions in the React Native documentation to manually link the framework or link using Cocoapods by adding this to your Podfile:

pod 'react-native-viewpager', :path => '../node_modules/@react-native-community/viewpager'

android/settings.gradle

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.gradle

dependencies {
   ...
   implementation project(':@react-native-community_viewpager')
}

android/app/src/main/.../MainApplication.java

On top, where imports are:

import com.reactnativecommunity.viewpager.RNCViewPagerPackage;

Add the RNCViewPagerPackage class to your list of exported packages.

@Override
protected List<ReactPackage> getPackages() {
  return Arrays.<ReactPackage>asList(
    new MainReactPackage(),
    new RNCViewPagerPackage()
  );
}

Usage

import React from 'react';
import {StyleSheet, View, Text} from 'react-native';
import ViewPager from '@react-native-community/viewpager';

const MyPager = () => {
  return (
    <ViewPager style={styles.viewPager} initialPage={0}>
      <View key="1">
        <Text>First page</Text>
      </View>
      <View key="2">
        <Text>Second page</Text>
      </View>
    </ViewPager>
  );
};

const styles = StyleSheet.create({
  viewPager: {
    flex: 1,
  },
});

API

PropDescriptionPlatform
initialPageIndex of initial page that should be selectedboth
scrollEnabled: booleanShould viewpager scroll, when scroll enabledboth
onPageScroll: (e: PageScrollEvent) => voidExecuted when transitioning between pages (ether because the animation for the requested page has changed or when the user is swiping/dragging between pages)both
onPageScrollStateChanged: (e: PageScrollStateChangedEvent) => voidFunction called when the page scrolling state has changedboth
onPageSelected: (e: PageSelectedEvent) => voidThis callback will be called once the ViewPager finishes navigating to the selected pageboth
pageMargin: numberBlank space to be shown between pagesboth
keyboardDismissMode: ('none' / 'on-drag')Determines whether the keyboard gets dismissed in response to a dragboth
orientation: OrientationSet horizontal or vertical scrolling orientationiOS
transitionStyle: TransitionStyleUse scroll or curl to change transition styleiOS
showPageIndicator: booleanShows the dots indicator at the bottom of the viewiOS

Preview

Android

iOS

horizontal - scrollhorizontal - curl
vertical - scrollvertical - curl