Skip to content
React.js Responsive Carousel (with Swipe)
Branch: master
Clone or download
Latest commit ecd6725 Apr 17, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.storybook Updating storybook + filling in stories Apr 24, 2017
lib Prepare for publishing Apr 17, 2019
src Issue #256: calling onItemClick when Carousel has one child (code rev… Apr 17, 2019
stories issue #303: Fixing autoplay when swipeable is turned off Jan 23, 2019
tasks Remove unused variables noted by Dec 17, 2018
.babelrc #118: Fixing jank swipe on mobile May 22, 2017
.editorconfig Updating editor config properties and reformatting files Sep 10, 2016
.gitignore Ignoring some files Aug 27, 2016
.lgtm.yml Classify /lib as generated code Dec 17, 2018
.npmignore issue-159: Ignoring storybook when publishing to npm Aug 26, 2017
.nvmrc Fixing issue #69 - styles leaking out of carousel Jan 29, 2017
.travis.yml Updating changelog Apr 17, 2019
CNAME Create Oct 2, 2017 Adding license Jun 16, 2017 Fix default interval value to match what is in actual code. Dec 15, 2018 #98: Fixing bug where the Thumbs component would throw an error if a … Apr 29, 2017
gulpfile.js Remove unused variables noted by Dec 17, 2018
index.d.ts Added swipeable in CarouselProps for Typescript, fixes #264 Feb 27, 2019
package.json 3.1.49 Apr 17, 2019
yarn.lock update watchify Apr 17, 2019

React Responsive Carousel

Help wanted

Things here are running very slowly as I have a lot of other stuff to take care at the moment so please don't be upset if I don't answer your question or if a PR sits unreviewed for a few days or weeks. Anyone interested in helping it move faster can help by submitting or reviewing PR's and answering each other's questions. (

npm version Build Status FOSSA Status

Powerful, lightweight and fully customizable carousel component for React apps.


  • Responsive
  • Mobile friendly
  • Swipe to slide
  • Mouse emulating touch
  • Server side rendering
  • Keyboard navigation
  • Custom animation duration
  • Auto play
  • Custom auto play interval
  • Infinite loop
  • Horizontal or Vertical directions
  • Supports images, videos, text content or anything you want. Each direct child represents one slide!
  • Supports any flux library (use selectedItem prop to set from the app state, and onChange callback to get the new position)
  • Show/hide anything (thumbs, indicators, arrows, status)

Important links:


Check it out these cool demos created using storybook. The source code for each example is available here

Customize it yourself:

Installing as a package

npm install react-responsive-carousel --save


import React, { Component } from 'react';
import ReactDOM from 'react-dom';
import "react-responsive-carousel/lib/styles/carousel.min.css";
import { Carousel } from 'react-responsive-carousel';

class DemoCarousel extends Component {
    render() {
        return (
                    <img src="assets/1.jpeg" />
                    <p className="legend">Legend 1</p>
                    <img src="assets/2.jpeg" />
                    <p className="legend">Legend 2</p>
                    <img src="assets/3.jpeg" />
                    <p className="legend">Legend 3</p>

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

// Don't forget to include the css in your page

// Using webpack
// 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"/>
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
thumbWidth number undefined optionally specify pixel width (as an integer) of a thumbnail (including any padding) to avoid calculating values (helps with server-side renders or page cache issues)
infiniteLoop boolean false infinite loop sliding
selectedItem number 0 selects an item though props / defines the initial selected item
axis string horizontal changes orientation - accepts horizontal and vertical
verticalSwipe string standard changes vertical swipe scroll direction - accepts standard and natural
onChange function - Fired when changing positions
onClickItem function - Fired when an item is clicked
onClickThumb function - Fired when a thumb it clicked
width string - Allows to set a fixed width
useKeyboardArrows boolean false Adds support to next and prev through keyboard arrows
autoPlay boolean false Auto play
stopOnHover boolean true Stop auto play while mouse is over the carousel
interval number 3000 Interval of auto play
transitionTime number 350 Duration of slide transitions (in miliseconds)
swipeScrollTolerance number 5 Allows scroll when the swipe movement occurs in a different direction than the carousel axis and within the tolerance - Increase for loose - Decrease for strict
swipeable boolean true Enables swiping gestures
dynamicHeight boolean false Adjusts the carousel height if required. -- Do not work with vertical axis --
emulateTouch boolean false Allows mouse to simulate swipe
statusFormatter func (current, total) => ${current} of ${total} Allows custom formatting of the status indicator
centerMode boolean false Enables centered view with partial prev/next slides. Only works with horizontal axis.
centerSlidePercentage number 80 optionally specify percentage width (as an integer) of the slides in centerMode



Check the contributing guide


Raising issues

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.

  • A new option is to create an example with the code that causes the bug. Fork this example from codesandbox and add your code there. Don't forget to fork, save and add the link for the example to the issue.


Setting up development environment

  • git clone
  • npm install
  • npm start
  • Open your favourite browser on localhost:8000 - livereload will be enabled and tests will run on each change

The fastest dev environment is on node 6. If you have nvm installed, just run nvm use 6. Tests in travis will run on node 4 and 6

Running only tests

  • npm test

Running storybook

  • npm run storybook


Only after merged back to master

Publish to npm

  • npm run publish-to-npm

Pubish to gh-pages

  • npm run publish-to-gh-pages



webpack + es6 setup





FOSSA Status

You can’t perform that action at this time.