react-slick

Carousel component built with React. It is a react port of slick carousel

Installation

npm install react-slick

Also install slick-carousel for css and font

npm install slick-carousel
@import "~slick-carousel/slick/slick.css";
@import "~slick-carousel/slick/slick-theme.css";

or add cdn link in your html

<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.6.0/slick.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/slick-carousel/1.6.0/slick-theme.min.css" />

Demos

PlayGround

Use jsfiddle template to try react-slick with different settings.

Filing issues

Please replicate your issue with jsfiddle template and post it along with issue to make it easy for me to debug.

Starter Kit

Checkout yeoman generator to quickly get started with react-slick.

Example

var React = require('react');
var Slider = require('react-slick');

class SimpleSlider extends React.Component {
  render: function () {
    var settings = {
      dots: true,
      infinite: true,
      speed: 500,
      slidesToShow: 1,
      slidesToScroll: 1
    };
    return (
      <Slider {...settings}>
        <div><h3>1</h3></div>
        <div><h3>2</h3></div>
        <div><h3>3</h3></div>
        <div><h3>4</h3></div>
        <div><h3>5</h3></div>
        <div><h3>6</h3></div>
      </Slider>
    );
  }
}

Property	Type	Description	Working
accessibility	bool	Enables tabbing and arrow key navigation	Yes
className	String	Additional class name for the inner slider div	Yes
adaptiveHeight	bool	Adjust the slide's height automatically	Yes
arrows	bool	Should we show Left and right nav arrows	Yes
nextArrow	React Element	Use this element for the next arrow button	Yes
prevArrow	React Element	Use this element for the prev arrow button	Yes
autoplay	bool	Should the scroller auto scroll?	Yes
autoplaySpeed	int	delay between each auto scoll. in ms	Yes
centerMode	bool	Should we centre to a single item?	Yes
centerPadding
cssEase
customPaging	func	Custom paging templates. Example	Yes
dots	bool	Should we show the dots at the bottom of the gallery	Yes
dotsClass	string	Class applied to the dots if they are enabled	Yes
draggable	bool	Is the gallery scrollable via dragging on desktop?	Yes
easing	string
fade	bool	Slides use fade for transition	Yes
focusOnSelect	bool	Go to slide on click	Yes
infinite	bool	should the gallery wrap around it's contents	Yes
initialSlide	int | String	which item should be the first to be displayed (Accepts index or css selector)	Yes
lazyLoad	bool	Loads images or renders components on demands	Yes
preLoad	int	loading of components in advance, only if "lazyLoad" (default = 0)	Yes
paginationName	string	The name given to the pagination component (if used)	Yes
pauseOnHover	bool	prevents autoplay while hovering	Yes
responsive	array	Array of objects in the form of { breakpoint: int, settings: { ... } } The breakpoint int is the maxWidth so the settings will be applied when resolution is below this value. Breakpoints in the array should be ordered from smallest to greatest. Use 'unslick' in place of the settings object to disable rendering the carousel at that breakpoint. Example: [ { breakpoint: 768, settings: { slidesToShow: 3 } }, { breakpoint: 1024, settings: { slidesToShow: 5 } }, { breakpoint: 100000, settings: 'unslick' } ]	Yes
rtl	bool	Reverses the slide order	Yes
slide	string
slidesToShow	int	Number of slides to be visible at a time	Yes
slidesToScroll	int	Number of slides to scroll for each navigation item
speed	int
swipe	bool
swipeToSlide	bool	Allow users to drag or swipe directly to a slide irrespective of slidesToScroll	Yes
touchMove	bool
touchThreshold	int
variableWidth	bool
useCSS	bool	Enable/Disable CSS Transitions	Yes
vertical	bool	Vertical slide mode	Yes
afterChange	function	callback function called after the current index changes	Yes
beforeChange	function	callback function called before the current index changes	Yes
slickGoTo	int	go to the specified slide number
offset	int	amount to offset track for left positioning.	Yes

Methods

• slickNext() - function called to change current slide on next slide (Example)
• slickPrev() - function called to change current slide on previous slide (Example)
• slickGoTo(slide) - function called to change current slide to given slide number or css selector (Example)
• slickForward(numberOfSlidesToScroll) - function called to scroll the slider forward n number of items
• slickBackward(numberOfSlidesToScroll) - function called to scroll the slider backward n number of items
• slickNextPage() - function called to scroll the slider forward 1 page (based on visible items)
• slickPreviousPage() - function called to scroll the slider backward 1 page (based on visible items)

Custom next/prev arrows

To customize the next/prev arrow elements, simply create new React components and set them as the values of nextArrow and prevArrow.

class LeftNavButton extends React.Component {
  render() {
    return <button {...this.props}>Next</button>
  }
}

Important: be sure that you pass your component's props to your clickable element like the example above. If you don't, your custom component won't trigger the click handler.

You can also set onClick={this.props.onClick} if you only want to set the click handler.

Pagination

To utilize numerical pagination, import the Pagination component in addition to the slider. The Pagination component requires a unique name property. That value should also be in the slick settings for paginationName. Once that is complete, set up a function to render the pagination and pass it in as the paginationRender property for the slick component. Then place the <Pagination> element wherever you wish to render the component.

import {Slider, Pagination} from 'react-slick';

class PaginationExample extends React.Component {
  static defaultProps = {
    slickSettings: {
      paginationName: 'unique-name',
    }
  }

  paginationRender(currentPage, totalPages) {
    return (<div>{currentPage} / {totalPages}</div>);
  }

  render() {
    return (
      <div>
        <Slider {...slickSettings} paginationRender={this.paginationRender}></Slider>
        <Pagination name='unique-name' />
      </div>
    )
  }
}

Flexbox support

If you have flex property on container div of slider, add below css

* {
  min-height: 0;
  min-width: 0;
}

Test Setup

If you try to run tests with jest in a project that uses react-slick, you my run into this error

matchMedia not present, legacy browsers require a polyfill

To fix this issue add below snippet in test-setup.js

window.matchMedia = window.matchMedia || function() {
    return {
        matches : false,
        addListener : function() {},
        removeListener: function() {}
    };
};

and add below jest config in package.json

"jest": {
    "setupFiles": ["test-setup.js"]
}

Development

Want to run demos locally

git clone https://github.com/akiran/react-slick
npm install
npm start
open http://localhost:8080

Polyfills for old IE support

matchMedia support from media-match