What is react-responsive-carousel?
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.
What are react-responsive-carousel's main functionalities?
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>
);
}
Other packages similar to react-responsive-carousel
react-slick
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
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
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.
React Responsive Carousel
Demo
http://leandrowd.github.io/react-responsive-carousel/
Installing as a package
npm install react-responsive-carousel --save
Usage
var React = require('react');
var ReactDOM = require('react-dom');
var Carousel = require('react-responsive-carousel').Carousel;
var DemoCarousel = React.createClass({
render() {
return (
<Carousel axis="horizontal|vertical" showThumbs={true|false} showArrows={true|false} onChange={onChange} onClickItem={onClickItem} onClickThumb={onClickThumb}>
<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'));
Attributes | Type | Default | Description |
---|
showArrows | boolean | true | show prev and next arrows |
showStatus | boolean | true | show index of the current item. i.e: (1/8) |
showIndicators | boolean | true | show little dots at the bottom with links for changing the item |
showThumbs | boolean | true | show thumbnails of the images |
selectedItem | number | 0 | selects an item though props / defines the initial selected item |
axis | string | horizontal | changes orientation - accepts horizontal and vertical |
onChange | function | - | Fired when changing positions |
onClickItem | function | - | Fired when an item is clicked |
onClickThumb | function | - | Fired when a thumb it clicked |
Contributing
Please, feel free to contribute. You may file an issue or submit a pull request!
Setting up development environment
git clone git@github.com:leandrowd/react-responsive-carousel.git
npm install
npm start
- Open your favourite browser on
localhost:8000
- livereload will be enabled
Running tests
Publishing to npm
Pubishing to gh-pages
npm run publish-to-gh-pages