Skip to content

Commit

Permalink
chore(package): bump to 3.1.0, update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bd-arc committed Aug 24, 2017
1 parent 63a63d4 commit 2d7b557
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
## v3.1.0
* `Pagination` component: add new props for advanced customization

## v3.0.0
###WARNING
* **Do not use this version as some temporary code was pushed to `npm` by mistake. Make sure to use version `3.1.0` instead.**
### Breaking changes
* Plugin is now built on top of `FlatList`, which allows for huge performance optimizations. From now on, items must be rendered using props `data` and `renderItem`.
### General
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ animationFunc | Animated animation to use; you must provide the name of the meth
animationOptions | Animation options to be merged with the default ones. Can be used without `animationFunc`. Note that opacity's easing will be kept linear. | Object | `{ duration: 600, easing: Easing.elastic(1) }`
containerCustomStyle | Optional styles for Scrollview's global wrapper | View Style Object | `{}`
contentContainerCustomStyle | Optional styles for Scrollview's items container | View Style Object | `{}`
inactiveSlideOpacity | Value of the opacity effect applied to inactive slides | Number | `1`
inactiveSlideOpacity | Value of the opacity effect applied to inactive slides | Number | `0.7`
inactiveSlideScale | Value of the 'scale' transform applied to inactive slides | Number | `0.9`
slideStyle | Optional style for each item's container (the one whose scale and opacity are animated) | Animated View Style Object | {}

Expand All @@ -211,7 +211,7 @@ The component is built on top of the `FlatList` component, meaning it inherits f

You can use almost all props from this three components, but some of them can't be overriden because it would mess with our implementation's logic.

Here are a few useful props regarding carousel's **style and "feeling"**: `showsHorizontalScrollIndicator`, `scrollEnabled` (if you want to scroll only programmatically), `overScrollMode` (android), `bounces` (ios), `decelerationRate` (ios), `scrollEventThrottle` (ios).
Here are a few useful props regarding carousel's **style and "feeling"**: `scrollEnabled` (if you want to disable user scrolling while still being able to use `Carousel`'s methods), `showsHorizontalScrollIndicator`, `overScrollMode` (android), `bounces` (ios), `decelerationRate` (ios), `scrollEventThrottle` (ios).

And here are some useful ones for **performance optimizations and rendering**: `initialNumToRender`, `maxToRenderPerBatch`, `windowSize`, `updateCellsBatchingPeriod`, `extraData`, `removeClippedSubviews` (the latter may have bugs, as stated in [RN's doc](https://facebook.github.io/react-native/docs/flatlist.html#removeclippedsubviews)). The first three are already implemented with default parameters, but you can override them if they don't suit your needs.

Expand Down Expand Up @@ -273,7 +273,7 @@ Version `3.0.0` introduced a `<ParallaxImage />` component, an image component a

![react-native-snap-carousel parallax image](http://i.imgur.com/6iIb4SR.gif)

You can find the documentation for this component [here](https://github.com/archriss/react-native-snap-carousel/blob/flatlist/src/parallaximage/README.md).
You can find the documentation for this component [here](https://github.com/archriss/react-native-snap-carousel/blob/master/src/parallaximage/README.md).

## `Pagination` component

Expand Down
6 changes: 3 additions & 3 deletions example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
},
"dependencies": {
"react": "16.0.0-alpha.12",
"react-native": "~0.47.1",
"react-native-linear-gradient": "^2.1.0",
"react-native": "~0.47.2",
"react-native-linear-gradient": "^2.3.0",
"react-native-snap-carousel": "file:../"
},
"devDependencies": {
"babel-preset-react-native": "1.9.1"
"babel-preset-react-native": "3.0.1"
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-native-snap-carousel",
"version": "3.0.0",
"version": "3.1.0",
"description": "Swiper component for React Native with previews, snapping effect, parallax images, performant handling of huge numbers of items, and RTL support. Compatible with Android & iOS.",
"main": "src/index.js",
"repository": {
Expand Down

0 comments on commit 2d7b557

Please sign in to comment.