feat(ios): drop support for curl transition style (#343) (#593)

krozniata · web-flow · commit 9f5678d26c36 · 2022-09-06T08:32:24.000+02:00
* fix(ios): drop support for curl transition style

* Update README
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -1,5 +1,8 @@
 ## Migration Guide
 
+# 5.x -> 6.x
+Due to some issues, support for the `transitionStyle` property, which was iOS only, has been dropped. In version **6.x** passing it will not have any effect.
+
 # 5.0.x -> 5.1.x
 Before:
 ```js
diff --git a/README.md b/README.md
@@ -29,6 +29,8 @@ Lazy page loading has been added to the `next` version. If you would like to tes
 
 ## Migration
 
+In version **6.x** support for `transitionStyle` property has been dropped. More information [here](https://github.com/callstack/react-native-pager-view/blob/master/MIGRATION.md).
+
 `"@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](https://github.com/callstack/react-native-pager-view/blob/master/MIGRATION.md)
 
 ## Getting started
@@ -148,7 +150,6 @@ For advanced usage please take a look into our [example project](https://github.
 | `pageMargin: number`                                                 |                                                                                                                Blank space to be shown between pages                                                                                                                |   both   |
 | `keyboardDismissMode: ('none' / 'on-drag')`                          |                                                                                                Determines whether the keyboard gets dismissed in response to a drag                                                                                                 |   both   |
 | `orientation: Orientation`                                           |                                                                                       Set `horizontal` or `vertical` scrolling orientation (it does **not** work dynamically)                                                                                       |   both   |
-| `transitionStyle: TransitionStyle`                                   |                                                                                        Use `scroll` or `curl` to change transition style (it does **not** work dynamically)                                                                                         |   iOS    |
 | `showPageIndicator: boolean`                                         |                                                                                                         Shows the dots indicator at the bottom of the view                                                                                                          |   iOS    |
 | `overScrollMode: OverScollMode`                                      |                                                                              Used to override default value of overScroll mode. Can be `auto`, `always` or `never`. Defaults to `auto`                                                                              | Android  |
 | `offscreenPageLimit: number`                                         | Set the number of pages that should be retained to either side of the currently visible page(s). Pages beyond this limit will be recreated from the adapter when needed. Defaults to RecyclerView's caching strategy. The given value must either be larger than 0. | Android  |
@@ -185,13 +186,9 @@ requestAnimationFrame(() => refPagerView.current?.setPage(index));
 
 ### iOS
 
-|                         horizontal - scroll                          |                         horizontal - curl                          |
-| :------------------------------------------------------------------: | :----------------------------------------------------------------: |
-| <img src="img/ios-viewpager-scroll.gif" alt="ViewPager" width="325"> | <img src="img/ios-viewpager-curl.gif" alt="ViewPager" width="325"> |
-
-|                           vertical - scroll                            |                               vertical - curl                               |
-| :--------------------------------------------------------------------: | :-------------------------------------------------------------------------: |
-| <img src="img/ios-viewpager-vertical.gif" alt="ViewPager" width="325"> | <img src="img/ios-viewpager-vertical-curl.gif" alt="ViewPager" width="325"> |
+|                            horizontal                                |                              vertical                                  |
+| :------------------------------------------------------------------: | :--------------------------------------------------------------------: |
+| <img src="img/ios-viewpager-scroll.gif" alt="ViewPager" width="325"> | <img src="img/ios-viewpager-vertical.gif" alt="ViewPager" width="325"> |
 
 ## Reanimated onPageScroll handler
 
diff --git a/example/src/BasicPagerViewExample.tsx b/example/src/BasicPagerViewExample.tsx
@@ -29,8 +29,6 @@ export function BasicPagerViewExample() {
         pageMargin={10}
         // Lib does not support dynamically orientation change
         orientation="horizontal"
-        // Lib does not support dynamically transitionStyle change
-        transitionStyle="scroll"
         showPageIndicator={navigationPanel.dotsEnabled}
       >
         {useMemo(
diff --git a/example/src/NestPagerView.tsx b/example/src/NestPagerView.tsx
@@ -17,7 +17,6 @@ export function NestPagerView() {
         layoutDirection="ltr"
         pageMargin={10}
         orientation="horizontal"
-        transitionStyle="scroll"
       >
         <View
           key="1"
@@ -37,8 +36,6 @@ export function NestPagerView() {
             pageMargin={10}
             // Lib does not support dynamically orientation change
             orientation="horizontal"
-            // Lib does not support dynamically transitionStyle change
-            transitionStyle="scroll"
           >
             <View
               key="1"
@@ -64,8 +61,6 @@ export function NestPagerView() {
             pageMargin={10}
             // Lib does not support dynamically orientation change
             orientation="vertical"
-            // Lib does not support dynamically transitionStyle change
-            transitionStyle="scroll"
           >
             <View
               key="1"
diff --git a/ios/PagerView.xcodeproj/project.pbxproj b/ios/PagerView.xcodeproj/project.pbxproj
@@ -11,7 +11,6 @@
 		18F5837025F79C300073D7CB /* ReactViewPagerManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836025F79C300073D7CB /* ReactViewPagerManager.m */; };
 		18F5837125F79C300073D7CB /* RCTConvert+UIPageViewControllerNavigationOrientation.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836125F79C300073D7CB /* RCTConvert+UIPageViewControllerNavigationOrientation.m */; };
 		18F5837225F79C300073D7CB /* ReactNativePageView.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836225F79C300073D7CB /* ReactNativePageView.m */; };
-		18F5837325F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836425F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.m */; };
 		18F5837425F79C300073D7CB /* RCTOnPageScrollStateChanged.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836625F79C300073D7CB /* RCTOnPageScrollStateChanged.m */; };
 		18F5837525F79C300073D7CB /* RCTOnPageSelected.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836C25F79C300073D7CB /* RCTOnPageSelected.m */; };
 		18F5837625F79C300073D7CB /* RCTOnPageScrollEvent.m in Sources */ = {isa = PBXBuildFile; fileRef = 18F5836E25F79C300073D7CB /* RCTOnPageScrollEvent.m */; };
@@ -37,7 +36,6 @@
 		18F5836125F79C300073D7CB /* RCTConvert+UIPageViewControllerNavigationOrientation.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "RCTConvert+UIPageViewControllerNavigationOrientation.m"; sourceTree = "<group>"; };
 		18F5836225F79C300073D7CB /* ReactNativePageView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ReactNativePageView.m; sourceTree = "<group>"; };
 		18F5836325F79C300073D7CB /* ReactViewPagerManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ReactViewPagerManager.h; sourceTree = "<group>"; };
-		18F5836425F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "RCTConvert+UIPageViewControllerTransitionStyle.m"; sourceTree = "<group>"; };
 		18F5836525F79C300073D7CB /* ReactNativePageView.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = ReactNativePageView.h; sourceTree = "<group>"; };
 		18F5836625F79C300073D7CB /* RCTOnPageScrollStateChanged.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTOnPageScrollStateChanged.m; sourceTree = "<group>"; };
 		18F5836725F79C300073D7CB /* RCTOnPageSelected.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTOnPageSelected.h; sourceTree = "<group>"; };
@@ -46,7 +44,6 @@
 		18F5836A25F79C300073D7CB /* UIViewController+CreateExtension.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "UIViewController+CreateExtension.h"; sourceTree = "<group>"; };
 		18F5836B25F79C300073D7CB /* RCTOnPageScrollEvent.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = RCTOnPageScrollEvent.h; sourceTree = "<group>"; };
 		18F5836C25F79C300073D7CB /* RCTOnPageSelected.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTOnPageSelected.m; sourceTree = "<group>"; };
-		18F5836D25F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "RCTConvert+UIPageViewControllerTransitionStyle.h"; sourceTree = "<group>"; };
 		18F5836E25F79C300073D7CB /* RCTOnPageScrollEvent.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RCTOnPageScrollEvent.m; sourceTree = "<group>"; };
 		B3E7B5891CC2AC0600A0062D /* PagerView.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = PagerView.m; sourceTree = "<group>"; };
 		F4FF95D5245B92E700C19C63 /* PagerView-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "PagerView-Bridging-Header.h"; sourceTree = "<group>"; };
@@ -77,8 +74,6 @@
 			children = (
 				18F5836925F79C300073D7CB /* RCTConvert+UIPageViewControllerNavigationOrientation.h */,
 				18F5836125F79C300073D7CB /* RCTConvert+UIPageViewControllerNavigationOrientation.m */,
-				18F5836D25F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.h */,
-				18F5836425F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.m */,
 				18F5836B25F79C300073D7CB /* RCTOnPageScrollEvent.h */,
 				18F5836E25F79C300073D7CB /* RCTOnPageScrollEvent.m */,
 				18F5836825F79C300073D7CB /* RCTOnPageScrollStateChanged.h */,
@@ -160,7 +155,6 @@
 				18F5837525F79C300073D7CB /* RCTOnPageSelected.m in Sources */,
 				18F5837225F79C300073D7CB /* ReactNativePageView.m in Sources */,
 				18F5837025F79C300073D7CB /* ReactViewPagerManager.m in Sources */,
-				18F5837325F79C300073D7CB /* RCTConvert+UIPageViewControllerTransitionStyle.m in Sources */,
 				18F5837625F79C300073D7CB /* RCTOnPageScrollEvent.m in Sources */,
 				F4FF95D7245B92E800C19C63 /* PagerView.swift in Sources */,
 				18F5837425F79C300073D7CB /* RCTOnPageScrollStateChanged.m in Sources */,
diff --git a/ios/RCTConvert+UIPageViewControllerTransitionStyle.h b/ios/RCTConvert+UIPageViewControllerTransitionStyle.h
diff --git a/ios/RCTConvert+UIPageViewControllerTransitionStyle.m b/ios/RCTConvert+UIPageViewControllerTransitionStyle.m
diff --git a/ios/ReactNativePageView.h b/ios/ReactNativePageView.h
@@ -16,7 +16,6 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, readonly) BOOL scrollEnabled;
 @property(nonatomic, readonly) BOOL showPageIndicator;
 @property(nonatomic, readonly) UIScrollViewKeyboardDismissMode dismissKeyboard;
-@property(nonatomic) UIPageViewControllerTransitionStyle transitionStyle;
 @property(nonatomic) UIPageViewControllerNavigationOrientation orientation;
 @property(nonatomic, copy) RCTDirectEventBlock onPageSelected;
 @property(nonatomic, copy) RCTDirectEventBlock onPageScroll;
diff --git a/ios/ReactNativePageView.m b/ios/ReactNativePageView.m
@@ -38,7 +38,6 @@ - (instancetype)initWithEventDispatcher:(RCTEventDispatcher *)eventDispatcher {
         _scrollEnabled = YES;
         _pageMargin = 0;
         _lastReportedIndex = -1;
-        _transitionStyle = UIPageViewControllerTransitionStyleScroll;
         _orientation = UIPageViewControllerNavigationOrientationHorizontal;
         _currentIndex = 0;
         _dismissKeyboard = UIScrollViewKeyboardDismissModeNone;
@@ -89,7 +88,7 @@ - (void)didMoveToWindow {
 
 - (void)embed {
     NSDictionary *options = @{ UIPageViewControllerOptionInterPageSpacingKey: @(self.pageMargin) };
-    UIPageViewController *pageViewController = [[UIPageViewController alloc] initWithTransitionStyle:self.transitionStyle
+    UIPageViewController *pageViewController = [[UIPageViewController alloc] initWithTransitionStyle:UIPageViewControllerTransitionStyleScroll
                                                                                navigationOrientation:self.orientation
                                                                                              options:options];
     pageViewController.delegate = self;
diff --git a/ios/ReactViewPagerManager.m b/ios/ReactViewPagerManager.m
@@ -10,7 +10,6 @@ @implementation ReactViewPagerManager
 RCT_EXPORT_VIEW_PROPERTY(initialPage, NSInteger)
 RCT_EXPORT_VIEW_PROPERTY(pageMargin, NSInteger)
 
-RCT_EXPORT_VIEW_PROPERTY(transitionStyle, UIPageViewControllerTransitionStyle)
 RCT_EXPORT_VIEW_PROPERTY(orientation, UIPageViewControllerNavigationOrientation)
 RCT_EXPORT_VIEW_PROPERTY(onPageSelected, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onPageScroll, RCTDirectEventBlock)
diff --git a/src/types.ts b/src/types.ts
@@ -1,7 +1,6 @@
 import type { ReactNode } from 'react';
 import type * as ReactNative from 'react-native';
 
-export type TransitionStyle = 'scroll' | 'curl';
 export type Orientation = 'horizontal' | 'vertical';
 export type OverScrollMode = 'auto' | 'always' | 'never';
 export type PageScrollState = 'idle' | 'dragging' | 'settling';
@@ -126,7 +125,6 @@ export interface PagerViewProps {
    * iOS only
    */
   orientation?: Orientation;
-  transitionStyle?: TransitionStyle;
   showPageIndicator?: boolean;
   /**
    * Android only

Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,6 @@ export function BasicPagerViewExample() {`
`29`	`29`	`pageMargin={10}`
`30`	`30`	`// Lib does not support dynamically orientation change`
`31`	`31`	`orientation="horizontal"`
`32`		`- // Lib does not support dynamically transitionStyle change`
`33`		`- transitionStyle="scroll"`
`34`	`32`	`showPageIndicator={navigationPanel.dotsEnabled}`
`35`	`33`	`>`
`36`	`34`	`{useMemo(`