react-responsive-carousel
Advanced tools
The react-responsive-carousel package is a flexible and responsive carousel component for React applications. It allows developers to create image sliders, carousels, and galleries with ease, providing a variety of customization options and features.
Basic Carousel
This code demonstrates a basic carousel with three images. Each image has an associated legend. The carousel is responsive and will adjust to the size of its container.
import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';
function BasicCarousel() {
return (
<Carousel>
<div>
<img src="image1.jpg" alt="Image 1" />
<p className="legend">Legend 1</p>
</div>
<div>
<img src="image2.jpg" alt="Image 2" />
<p className="legend">Legend 2</p>
</div>
<div>
<img src="image3.jpg" alt="Image 3" />
<p className="legend">Legend 3</p>
</div>
</Carousel>
);
}Custom Controls
This code demonstrates a carousel with custom controls. The carousel will autoplay, loop infinitely, and respond to keyboard arrows and touch gestures. It also includes indicators and arrows for navigation.
import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';
function CustomControlsCarousel() {
return (
<Carousel
showArrows={true}
showStatus={false}
showIndicators={true}
infiniteLoop={true}
useKeyboardArrows={true}
autoPlay={true}
stopOnHover={true}
swipeable={true}
dynamicHeight={true}
emulateTouch={true}
>
<div>
<img src="image1.jpg" alt="Image 1" />
<p className="legend">Legend 1</p>
</div>
<div>
<img src="image2.jpg" alt="Image 2" />
<p className="legend">Legend 2</p>
</div>
<div>
<img src="image3.jpg" alt="Image 3" />
<p className="legend">Legend 3</p>
</div>
</Carousel>
);
}Thumbnail Navigation
This code demonstrates a carousel with thumbnail navigation. Thumbnails of the images are displayed below the main carousel, allowing users to navigate to specific images by clicking on the thumbnails.
import { Carousel } from 'react-responsive-carousel';
import 'react-responsive-carousel/lib/styles/carousel.min.css';
function ThumbnailCarousel() {
return (
<Carousel showThumbs={true}>
<div>
<img src="image1.jpg" alt="Image 1" />
<p className="legend">Legend 1</p>
</div>
<div>
<img src="image2.jpg" alt="Image 2" />
<p className="legend">Legend 2</p>
</div>
<div>
<img src="image3.jpg" alt="Image 3" />
<p className="legend">Legend 3</p>
</div>
</Carousel>
);
}react-slick is a popular carousel component for React that is based on the slick-carousel library. It offers a wide range of features, including responsive design, autoplay, and custom navigation. Compared to react-responsive-carousel, react-slick provides more advanced customization options and a larger community of users.
Swiper is a modern touch slider that is highly customizable and supports a wide range of features, including vertical and horizontal sliders, parallax effects, and lazy loading. It is not limited to React and can be used with other frameworks as well. Swiper is known for its performance and flexibility, making it a strong alternative to react-responsive-carousel.
pure-react-carousel is a lightweight and flexible carousel component for React. It focuses on providing a simple and accessible API while maintaining high performance. Compared to react-responsive-carousel, pure-react-carousel offers a more minimalistic approach with fewer built-in features, but it allows for greater customization through its component-based architecture.
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 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.
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
import 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"/>
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
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.
=======================
FAQs
React Responsive Carousel
The npm package react-responsive-carousel receives a total of 136,883 weekly downloads. As such, react-responsive-carousel popularity was classified as popular.
We found that react-responsive-carousel demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.