react-responsive-carousel
Advanced tools
react-responsive-carousel - npm Package Compare versions
Comparing version 3.2.13 to 3.2.14
@@ -10,2 +10,12 @@ # Changelog | ||
| ## [v3.2.13](https://github.com/leandrowd/react-responsive-carousel/compare/v3.2.12...v3.2.13) - 2021-03-03 | ||
| ### Merged | ||
| - #255 - fade story [`#571`](https://github.com/leandrowd/react-responsive-carousel/pull/571) | ||
| ### Commits | ||
| - #255 - Add storybook for fade animations [`fc5f52e`](https://github.com/leandrowd/react-responsive-carousel/commit/fc5f52e0c54736fe66b54d55976da3715d23ac1e) | ||
| ## [v3.2.12](https://github.com/leandrowd/react-responsive-carousel/compare/v3.2.11...v3.2.12) - 2021-02-12 | ||
@@ -12,0 +22,0 @@ |
| { | ||
| "name": "react-responsive-carousel", | ||
| "version": "3.2.13", | ||
| "version": "3.2.14", | ||
| "description": "React Responsive Carousel", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -10,2 +10,3 @@ # React Responsive Carousel | ||
| ### Important | ||
| I don't have any time available to keep maintaining this package. If you have any request, try to sort it within the comuninity. I'm able to merge pull requests that look safe from time to time but no commitment on timelines here. Feel free to fork it and publish under other name if you are in a hurry or to use another component. | ||
@@ -95,2 +96,43 @@ | ||
| ### Props | ||
| | Name | Value | Description | | ||
| | ---------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | axis | `'horizontal'`, `'vertical'` | Define the direction of the slider, defaults to `'horizontal'`. | | ||
| | autoFocus | `boolean` | Force focus on the carousel when it renders. | | ||
| | autoPlay | `boolean` | Change the slide automatically based on `interval` prop. | | ||
| | centerMode | `boolean` | Center the current item and set the slide width based on `centerSlidePercentage`. | | ||
| | centerSlidePercentage | `number` | Define the width percentage relative to the carousel width when `centerMode` is `true`. | | ||
| | dynamicHeight | `boolean` | The height of the items will not be fixed. | | ||
| | emulateTouch | `boolean` | Enable swipe on non-touch screens when `swipeable` is `true`. | | ||
| | infiniteLoop | `boolean` | Going after the last item will move back to the first slide. | | ||
| | interval | `number` | Interval in milliseconds to automatically go to the next item when `autoPlay` is true, defaults to `3000`. | | ||
| | labels | `object` | Apply `aria-label` on carousel with an `object` with the properties `leftArrow`, `rightArrow` and `item`. The default is `{leftArrow: 'previous slide / item', rightArrow: 'next slide / item', item: 'slide item'}`. | | ||
| | onClickItem | `function` | Callback to handle a click event on a slide, receives the current index and item as arguments. | | ||
| | onClickThumb | `function` | Callback to handle a click event on a thumb, receives the current index and item as arguments. | | ||
| | onChange | `function` | Callback to handle every time the selected item changes, receives the current index and item as arguments. | | ||
| | onSwipeStart | `function` | Callback to handle when the swipe starts, receives a touch event as argument. | | ||
| | onSwipeEnd | `function` | Callback to handle when the swipe ends, receives a touch event as argument. | | ||
| | onSwipeMove | `function` | Callback triggered on every movement while swiping, receives a touch event as argument. | | ||
| | preventMovementUntilSwipeScrollTolerance | `boolean` | Don't let the carousel scroll until the user swipe to the value specified on `swipeScrollTolerance`. | | ||
| | renderArrowPrev | `function` | Render custom previous arrow. Receives a click handler, a `boolean` that shows if there's a previous item, and the accessibility label as arguments. | | ||
| | renderArrowNext | `function` | Render custom previous arrow. Receives a click handler, a `boolean` that shows if there's a next item, and the accessibility label as arguments. | | ||
| | renderIndicator | `function` | Render custom indicator. Receives a click handler, a `boolean` that shows if the item is selected, the item index, and the accessibility label as arguments. | | ||
| | renderItem | `function` | Render a custom item. Receives an item of the carousel, and an `object` with the `isSelected` property as arguments. | | ||
| | renderThumbs | `function` | Render prop to show the thumbs, receives the carousel items as argument. Get the `img` tag of each item of the slider, and render it by default. | | ||
| | selectedItem | `number` | Set the selected item, defaults to `0`. | | ||
| | showArrows | `boolean` | Enable previous and next arrow, defaults to `true`. | | ||
| | showStatus | `boolean` | Enable status of the current item to the total, defaults to `true`. | | ||
| | showIndicators | `boolean` | Enable indicators to select items, defaults to `true`. | | ||
| | showThumbs | `boolean` | Enable thumbs, defaults to `true`. | | ||
| | statusFormatter | `function` | Formatter that returns the status as a `string`, receives the current item and the total count as arguments. Defaults to `{currentItem} of {total}` format. | | ||
| | stopOnHover | `boolean` | The slide will not change by `autoPlay` on hover, defaults to `true`. | | ||
| | swipeable | `boolean` | Enable the user to swipe the carousel, defaults to `true`. | | ||
| | swipeScrollTolerance | `number` | How many pixels it's needed to change the slide when swiping, defaults to `5`. | | ||
| | thumbWidth | `number` | Width of the thumb, defaults to `80`. | | ||
| | transitionTime | `number` | Duration of the animation of changing slides. | | ||
| | useKeyboardArrows | `boolean` | Enable the arrows to move the slider when focused. | | ||
| | verticalSwipe | `'natural'`, `'standard'` | Set the mode of swipe when the axis is `'vertical'`. The default is `'standard'`. | | ||
| | width | `number` or `string` | The width of the carousel, defaults to `100%`. | | ||
| ### Customizing | ||
@@ -97,0 +139,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.21%
283803
- Number of lines in readme file
- increased by25.45%
207
Worsened metrics
- Lines of code
- decreased by-0.02%
4224
No dependency changes