Skip to content

Commit

Permalink
doc(README): update documentation for version 3.3.4
Browse files Browse the repository at this point in the history
  • Loading branch information
bd-arc committed Oct 16, 2017
1 parent b7b4ed1 commit e5b78bc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<ParallaxImage />` 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`
Expand Down
4 changes: 3 additions & 1 deletion example/README.md
Original file line number Diff line number Diff line change
@@ -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...)
Expand Down

0 comments on commit e5b78bc

Please sign in to comment.