From e5b78bc397a8202b6618db2ff053692e5a812413 Mon Sep 17 00:00:00 2001 From: bd-arc Date: Mon, 16 Oct 2017 15:11:13 +0200 Subject: [PATCH] doc(README): update documentation for version 3.3.4 --- README.md | 2 +- example/README.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index de63963b8..e6f63e658 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ Prop | Description | Type | Default `enableSnap` | If enabled, releasing the touch will scroll to the center of the nearest/active item | Boolean | `true` `firstItem` | Index of the first item to display | Number | `0` `hasParallaxImages` | Whether the carousel contains `` components or not. Required for specific data to be passed to children. | Boolean | `false` -`lockScrollWhileSnapping` | Prevent the user from swiping again while the carousel is snapping to a position. This prevents miscellaneous minor issues (inadvertently tapping an item while scrolling, stopping the scrolling animation if the carousel is tapped in the middle of a snap, clunky behavior on Android when short snapping quickly in opposite directions). On iOS, it will also make the carousel snaps to the immediate previous or next item as soon as it becomes active. The only drawback is that enabling the prop hinders the ability to swipe quickly between items as a little pause between swipes is needed. **Note that the prop won't have any effect if `enableMomentum` is set to `true`, since it would otherwise impede the natural and expected behavior.** | Boolean | `false` +`lockScrollWhileSnapping` | Prevent the user from swiping again while the carousel is snapping to a position. This prevents miscellaneous minor issues (inadvertently tapping an item while scrolling, stopping the scrolling animation if the carousel is tapped in the middle of a snap, clunky behavior on Android when short snapping quickly in opposite directions). The only drawback is that enabling the prop hinders the ability to swipe quickly between items as a little pause between swipes is needed. **Note that the prop won't have any effect if `enableMomentum` is set to `true`, since it would otherwise impede the natural and expected behavior.** | Boolean | `false` `shouldOptimizeUpdates` | Whether to implement a `shouldComponentUpdate` strategy to minimize updates | Boolean | `true` `swipeThreshold` | Delta x when swiping to trigger the snap | Number | `20` `vertical` | Layout slides vertically instead of horizontally | Boolean | `false` diff --git a/example/README.md b/example/README.md index 05316aff2..d002b78d4 100644 --- a/example/README.md +++ b/example/README.md @@ -1,8 +1,10 @@ ## Example +:warning: **Before anything, make sure to read [this note](https://github.com/archriss/react-native-snap-carousel/#important-note-regarding-android) regarding Android.** + ![react-native-snap-carousel](http://i.imgur.com/m0297Ys.gif) -The example is a basic React Native app, which means you should follow [the official doc](https://facebook.github.io/react-native/docs/getting-started.html) to get started with it. Make sure to read the instructions found in tab "Building Projects with Native Code". +The example is a basic React Native app, which means you should follow [the official doc](https://facebook.github.io/react-native/docs/getting-started.html) to get started with it. Make sure to read the instructions found in tab "**Building Projects with Native Code**". To sum up: - make sure that everything you need has been properly installed (Node, Watchman, RN command line interface, XCode...)