react-responsive-carousel

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.

README

React Responsive Carousel (WIP)

• Note: This version 0.1.1 was updated for use with React 0.13.3. For React < 0.13.0 try the version 0.1.0;

Demo

http://leandrowd.github.io/react-responsive-carousel/

Installing as a package

npm install react-responsive-carousel --save

Running locally

To run it on your local environment just:

• git clone [e-mail]:leandrowd/react-responsive-carousel.git
• npm install
• gulp
• Open your favourite browser on localhost:8000

To generate the npm package run gulp package. It will transpile the jsx to js and copy the css into the lib folder.

Contributing

Please, feel free to contributing. You may file an issue or submit a pull request!

Getting started

Slider with controls

• Javascript / Jsx:

/** @jsx React.DOM */
var React = require('react');
var Carousel = require('./components/Carousel');

var DemoSliderControls = React.createClass({
	render() {
		return (
			<div className="demo-slider">
				<Carousel 
					type="slider" 
					items={ sliderImages } 
					showControls={true} 
					showStatus={true} />
			</div>
		);
	}
});

React.render(<DemoSliderControls />, document.querySelector('.demo-slider-controls'));

• Css:

<link rel="stylesheet" href="carousel.css"/>

• Props:
  • (Array) items
  • (Boolean) showControls
  • (Boolean) showStatus
  • (Function) onChange
    • Triggered when the carousel move
  • (Function) onSelectItem
    • Triggered when an item is selected

Carousel

• Javascript / Jsx:

/** @jsx React.DOM */
var React = require('react');
var Carousel = require('./components/Carousel');

var DemoCarousel = React.createClass({
	render() {
		return (
			<div className="demo-carousel">
				<Carousel items={ carouselImages } />
			</div>
		);
	}
});

React.render(<DemoCarousel />, document.querySelector('.demo-carousel'));

• Css:

<link rel="stylesheet" href="carousel.css"/>

• Props:
  • (Array) items
  • (Boolean) showControls
  • (Boolean) showStatus
  • (Function) onChange
    • Triggered when the carousel move
  • (Function) onSelectItem
    • Triggered when an item is selected

Image Gallery

• Javascript / Jsx:

/** @jsx React.DOM */
var React = require('react');
var ImageGallery = require('./components/ImageGallery');

var DemoGallery = React.createClass({
	render() {
		return (
			<div className="demo-image-gallery">
				<ImageGallery images={ galleryImages } />
			</div>
		);
	}
});

React.render(<DemoGallery />, document.querySelector('.demo-gallery'));

• Css:

<link rel="stylesheet" href="imageGallery.css"/>
<link rel="stylesheet" href="carousel.css"/>

• Props:
  • images

How to build your own gallery

So simple, just add one carousel[type=slider] and another carousel sending the same parameters for both:

• Javascript / Jsx:

/** @jsx React.DOM */
var React = require('react/addons');
var Carousel = require('./Carousel');

module.exports = React.createClass({
	
	propsTypes: {
		images: React.PropTypes.array.isRequired
	},

	getInitialState () {
		return {
			currentImage: 0
		}
	},

	selectItem (selectedItem) {
		this.setState({
			currentImage: selectedItem
		});
	},

	render () {
		var { images } = this.props;
		var { current } = this.state;
		var mainImage = (images && images[current] && images[current].url);

		return (
			<div className="image-gallery">
				<Carousel 
					type="slider" 
					items={ images } 
					selectedItem={this.state.currentImage} 
					onChange={this.selectItem} 
					onSelectItem={ this.selectItem } />

				<Carousel 
					items={ images } 
					selectedItem={this.state.currentImage} 
					onSelectItem={ this.selectItem } />
			</div>
		);
	}
});