react-native-pager-view

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

Migration

In version 6.x support for transitionStyle property has been dropped. More information here.

"@react-native-community/viewpager" library has been changed to react-native-pager-view. Here you can find more information, how to migrate pager view to the latest version

Getting started

Bun:

bun add react-native-pager-view

Yarn:

yarn add react-native-pager-view

Linking

>= 0.60

Autolinking will just do the job.

< 0.60

Mostly automatic

react-native link react-native-pager-view

Manual linking

1pod 'react-native-pager-view', :path => '../node_modules/react-native-pager-view'

1include ':react-native-pager-view'
2project(':react-native-pager-view').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-pager-view/android')

1dependencies {
2   ...
3   implementation project(':react-native-pager-view')
4}

1@Override
2protected List<ReactPackage> getPackages() {
3  return Arrays.<ReactPackage>asList(
4    new MainReactPackage(),
5    new PagerViewPackage()
6  );
7}

Usage

1import React from 'react';
2import { StyleSheet, View, Text } from 'react-native';
3import PagerView from 'react-native-pager-view';
4
5const MyPager = () => {
6  return (
7    <PagerView style={styles.pagerView} initialPage={0}>
8      <View key="1">
9        <Text>First page</Text>
10      </View>
11      <View key="2">
12        <Text>Second page</Text>
13      </View>
14    </PagerView>
15  );
16};
17
18const styles = StyleSheet.create({
19  pagerView: {
20    flex: 1,
21  },
22});

Attention: Note that you can only use View components as children of PagerView (cf. folder /example) . For Android if View has own children, set prop collapsable to false https://reactnative.dev/docs/view#collapsable-android, otherwise react-native might remove those children views and and its children will be rendered as separate pages

Advanced usage

For advanced usage please take a look into our example project

API

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

Known Issues

• flex:1 does not work for child views, please use width: '100%', height: '100%' instead

• [iOS]: In case of UIViewControllerHierarchyInconsistency error, please use below fix:

requestAnimationFrame(() => refPagerView.current?.setPage(index));

Preview

Android

horizontal	vertical

iOS

horizontal	vertical

Reanimated onPageScroll handler

An example can be found here

Instructions

To attach reanimated handler with onPageScroll follow the below steps.

1// 1. Define the handler
2function usePageScrollHandler(handlers, dependencies) {
3  const { context, doDependenciesDiffer } = useHandler(handlers, dependencies);
4  const subscribeForEvents = ['onPageScroll'];
5
6  return useEvent(
7    (event) => {
8      'worklet';
9      const { onPageScroll } = handlers;
10      if (onPageScroll && event.eventName.endsWith('onPageScroll')) {
11        onPageScroll(event, context);
12      }
13    },
14    subscribeForEvents,
15    doDependenciesDiffer
16  );
17}
18
19// 2. Attach the event handler
20import PagerView from 'react-native-pager-view';
21import Animated from 'react-native-reanimated';
22const AnimatedPagerView = Animated.createAnimatedComponent(PagerView);
23
24const pageScrollHandler = usePageScrollHandler({
25  onPageScroll: (e) => {
26    'worklet';
27    offset.value = e.offset;
28    console.log(e.offset, e.position);
29  },
30});
31
32<AnimatedPagerView onPageScroll={pageScrollHandler} />;

usePagerView Hook Usage

The usePagerView hook is a convenient way to manage the state and control the behavior of the <PagerView /> component. It provides functions and variables to interact with the pager, such as navigating between pages and enabling/disabling scrolling.

Below is an example of how to use the usePager hook:

1export function PagerHookExample() {
2  const { AnimatedPagerView, ref, ...rest } = usePagerView({ pagesAmount: 10 });
3  
4  return (
5    <SafeAreaView style={styles.container}>
6      <AnimatedPagerView
7        testID="pager-view"
8        ref={ref}
9        style={styles.PagerView}
10        initialPage={0}
11        layoutDirection="ltr"
12        overdrag={rest.overdragEnabled}
13        scrollEnabled={rest.scrollEnabled}
14        onPageScroll={rest.onPageScroll}
15        onPageSelected={rest.onPageSelected}
16        onPageScrollStateChanged={rest.onPageScrollStateChanged}
17        pageMargin={10}
18        orientation="horizontal"
19      >
20        {useMemo(
21          () =>
22            rest.pages.map((_, index) => (
23              <View
24                testID="pager-view-content"
25                key={index}
26                style={{
27                  flex: 1,
28                  backgroundColor: '#fdc08e',
29                  alignItems: 'center',
30                  padding: 20,
31                }}
32                collapsable={false}
33              >
34                <LikeCount />
35                <Text testID={`pageNumber${index}`}>
36                  {`page number ${index}`}
37                </Text>
38              </View>
39            )),
40          [rest.pages]
41        )}
42      </AnimatedPagerView>
43      <NavigationPanel {...rest} />
44    </SafeAreaView>
45  );
46}

How the Example Works:

• Pager View Setup: The AnimatedPagerView component wraps PagerView in React Native's animation capabilities. It accepts multiple props from the usePager hook, such as overdragEnabled, scrollEnabled, onPageScroll, onPageSelected, and others to manage pager behavior.

• Rendering Pages: The pages are dynamically generated using the rest.pages array (initialized by usePager). The useMemo hook ensures the pages are only recomputed when necessary for performance reasons.

Conclusion

The usePager hook makes it easy to handle pagination with dynamic views. This example demonstrates how to set up a simple paginated interface where users can scroll through pages, interact with page elements, and control the pager with external navigation.

License

MIT