Skip to content

Commit

Permalink
doc(PROPS): add description for prop lockScrollTimeoutDuration
Browse files Browse the repository at this point in the history
  • Loading branch information
bd-arc committed Apr 12, 2018
1 parent 59b1d90 commit c8d4132
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/PROPS_METHODS_AND_GETTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,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`
`lockScrollTimeoutDuration` | This prop works in conjunction with `lockScrollWhileSnapping`. When scroll is locked, a timer is created in order to release the scroll if something goes wrong with the regular callback handling. **Normally, you shouldn't have to use this prop.** | Number | `1000`
`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`
Expand Down

0 comments on commit c8d4132

Please sign in to comment.