Gathering detailed insights and metrics for react-responsive-carousel-2
Gathering detailed insights and metrics for react-responsive-carousel-2
Gathering detailed insights and metrics for react-responsive-carousel-2
Gathering detailed insights and metrics for react-responsive-carousel-2
react-responsive-carousel
React Responsive Carousel
pure-react-carousel
A highly impartial suite of React components that can be assembled by the consumer to create a responsive and aria compliant carousel with almost no limits on DOM structure or CSS styles.
react-elastic-carousel
A flexible and responsive carousel component for react
react-snap-carousel
DOM-first, headless carousel for React, utilizing native browser scrolling & CSS scroll snap points
npm install react-responsive-carousel-2
68.2
Supply Chain
99
Quality
74.9
Maintenance
100
Vulnerability
100
License
Module System
Min. Node Version
Typescript Support
Node Version
NPM Version
2,672 Stars
799 Commits
630 Forks
26 Watching
5 Branches
59 Contributors
Updated on 27 Nov 2024
Minified
Minified + Gzipped
TypeScript (84.38%)
SCSS (8.96%)
HTML (3.84%)
JavaScript (2.82%)
Cumulative downloads
Total Downloads
Last day
260%
18
Compared to previous day
Last week
8.5%
115
Compared to previous week
Last month
10.4%
532
Compared to previous month
Last year
392.4%
1,940
Compared to previous year
3
40
Powerful, lightweight and fully customizable carousel component for React apps.
I don't have any time available to keep maintaining this package. If you have any request, try to sort it within the community. 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.
http://leandrowd.github.io/react-responsive-carousel/
Check it out these cool demos created using storybook. The source code for each example is available here
Customize it yourself:
yarn add react-responsive-carousel
1import React, { Component } from 'react'; 2import ReactDOM from 'react-dom'; 3import "react-responsive-carousel/lib/styles/carousel.min.css"; // requires a loader 4import { Carousel } from 'react-responsive-carousel'; 5 6class DemoCarousel extends Component { 7 render() { 8 return ( 9 <Carousel> 10 <div> 11 <img src="assets/1.jpeg" /> 12 <p className="legend">Legend 1</p> 13 </div> 14 <div> 15 <img src="assets/2.jpeg" /> 16 <p className="legend">Legend 2</p> 17 </div> 18 <div> 19 <img src="assets/3.jpeg" /> 20 <p className="legend">Legend 3</p> 21 </div> 22 </Carousel> 23 ); 24 } 25}); 26 27ReactDOM.render(<DemoCarousel />, document.querySelector('.demo-carousel')); 28 29// Don't forget to include the css in your page 30 31// Using webpack or parcel with a style loader 32// import styles from 'react-responsive-carousel/lib/styles/carousel.min.css'; 33 34// Using html tag: 35// <link rel="stylesheet" href="<NODE_MODULES_FOLDER>/react-responsive-carousel/lib/styles/carousel.min.css"/>
Name | Value | Description |
---|---|---|
ariaLabel | string | Define the aria-label attribute for the root carousel element. The default is undefined , skipping the attribute from markup. |
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% . |
By default, each slide will be rendered as passed as children. If you need to customize them, use the prop renderItem
.
renderItem: (item: React.ReactNode, options?: { isSelected: boolean }) => React.ReactNode;
By default, thumbs are generated extracting the images in each slide. If you don't have images on your slides or if you prefer a different thumbnail, use the method renderThumbs
to return a new list of images to be used as thumbs.
renderThumbs: (children: React.ReactChild[]) => React.ReactChild[]
By default, simple arrows are rendered on each side. If you need to customize them and the css is not enough, use the renderArrowPrev
and renderArrowNext
. The click handler is passed as argument to the prop and needs to be added as click handler in the custom arrow.
renderArrowPrev: (clickHandler: () => void, hasPrev: boolean, label: string) => React.ReactNode;
renderArrowNext: (clickHandler: () => void, hasNext: boolean, label: string) => React.ReactNode;
By default, indicators will be rendered as those small little dots in the bottom part of the carousel. To customize them, use the renderIndicator
prop.
renderIndicator: (
clickHandler: (e: React.MouseEvent | React.KeyboardEvent) => void,
isSelected: boolean,
index: number,
label: string
) => React.ReactNode;
If none of the previous options are enough, you can build your own controls for the carousel. Check an example at http://react-responsive-carousel.js.org/storybook/?path=/story/02-advanced--with-external-controls
By default, the carousel uses the traditional 'slide' style animation. There is also a built in fade animation, which can be used by passing 'fade'
to the animationHandler
prop. *note: the 'fade' animation does not support swiping animations, so you may want to set swipeable
to false
If you would like something completely custom, you can pass custom animation handler functions to animationHandler
, swipeAnimationHandler
, and stopSwipingHandler
. The animation handler functions accept props and state, and return styles for the contain list, default slide style, selected slide style, and previous slide style. Take a look at the fade animation handler for an idea of how they work:
1const fadeAnimationHandler: AnimationHandler = (props, state): AnimationHandlerResponse => { 2 const transitionTime = props.transitionTime + 'ms'; 3 const transitionTimingFunction = 'ease-in-out'; 4 5 let slideStyle: React.CSSProperties = { 6 position: 'absolute', 7 display: 'block', 8 zIndex: -2, 9 minHeight: '100%', 10 opacity: 0, 11 top: 0, 12 right: 0, 13 left: 0, 14 bottom: 0, 15 transitionTimingFunction: transitionTimingFunction, 16 msTransitionTimingFunction: transitionTimingFunction, 17 MozTransitionTimingFunction: transitionTimingFunction, 18 WebkitTransitionTimingFunction: transitionTimingFunction, 19 OTransitionTimingFunction: transitionTimingFunction, 20 }; 21 22 if (!state.swiping) { 23 slideStyle = { 24 ...slideStyle, 25 WebkitTransitionDuration: transitionTime, 26 MozTransitionDuration: transitionTime, 27 OTransitionDuration: transitionTime, 28 transitionDuration: transitionTime, 29 msTransitionDuration: transitionTime, 30 }; 31 } 32 33 return { 34 slideStyle, 35 selectedStyle: { ...slideStyle, opacity: 1, position: 'relative' }, 36 prevStyle: { ...slideStyle }, 37 }; 38};
If your carousel is about videos, keep in mind that it's up to you to control which videos will play. Using the renderItem
prop, you will get information saying if the slide is selected or not and can use that to change the video state. Only play videos on selected slides to avoid issues. Check an example at http://react-responsive-carousel.js.org/storybook/?path=/story/02-advanced--youtube-autoplay-with-custom-thumbs
=======================
The contributing guide contains details on how to create pull requests and setup your dev environment. Please read it before contributing!
=======================
When raising an issue, please add as much details as possible. Screenshots, video recordings, or anything else that can make it easier to reproduce the bug you are reporting.
=======================
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
Found 7/17 approved changesets -- score normalized to 4
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Reason
102 existing vulnerabilities detected
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More