React Responsive Carousel Show Powerful, lightweight and fully customizable carousel component for React apps. ImportantI 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. Features
Important links:
Demohttp://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:
Installing as a packageyarn add react-responsive-carousel Usageimport React, { Component } from 'react';
import ReactDOM from 'react-dom';
import "react-responsive-carousel/lib/styles/carousel.min.css"; // requires a loader
import { Carousel } from 'react-responsive-carousel';
class DemoCarousel extends Component {
render() {
return (
<Carousel>
<div>
<img src="assets/1.jpeg" />
<p className="legend">Legend 1</p>
</div>
<div>
<img src="assets/2.jpeg" />
<p className="legend">Legend 2</p>
</div>
<div>
<img src="assets/3.jpeg" />
<p className="legend">Legend 3</p>
</div>
</Carousel>
);
}
});
ReactDOM.render(<DemoCarousel />, document.querySelector('.demo-carousel'));
// Don't forget to include the css in your page
// Using webpack or parcel with a style loader
// import styles from 'react-responsive-carousel/lib/styles/carousel.min.css';
// Using html tag:
// <link rel="stylesheet" href="<NODE_MODULES_FOLDER>/react-responsive-carousel/lib/styles/carousel.min.css"/> Props
CustomizingItems (Slides)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;ThumbsBy 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[]ArrowsBy 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;IndicatorsBy 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;Take full control of the carouselIf 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 Custom AnimationsBy 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: const fadeAnimationHandler: AnimationHandler = (props, state): AnimationHandlerResponse => {
const transitionTime = props.transitionTime + 'ms';
const transitionTimingFunction = 'ease-in-out';
let slideStyle: React.CSSProperties = {
position: 'absolute',
display: 'block',
zIndex: -2,
minHeight: '100%',
opacity: 0,
top: 0,
right: 0,
left: 0,
bottom: 0,
transitionTimingFunction: transitionTimingFunction,
msTransitionTimingFunction: transitionTimingFunction,
MozTransitionTimingFunction: transitionTimingFunction,
WebkitTransitionTimingFunction: transitionTimingFunction,
OTransitionTimingFunction: transitionTimingFunction,
};
if (!state.swiping) {
slideStyle = {
...slideStyle,
WebkitTransitionDuration: transitionTime,
MozTransitionDuration: transitionTime,
OTransitionDuration: transitionTime,
transitionDuration: transitionTime,
msTransitionDuration: transitionTime,
};
}
return {
slideStyle,
selectedStyle: { ...slideStyle, opacity: 1, position: 'relative' },
prevStyle: { ...slideStyle },
};
}; VideosIf 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 ======================= ContributingThe contributing guide contains details on how to create pull requests and setup your dev environment. Please read it before contributing! ======================= Raising issuesWhen 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.
======================= License |