react-slick

The is a fork of react-slick. The purpose of this fork is to

• slim down API surface,
• reduce technical debt / complexity of the original project,
• convert code to more recent ES2015/next style
• rearchitect code to make it more unit-testable
• use Travis && Code Coverage && semantic-release

It doesn't support bower anymore, arrow / dots elements are not provided.

This is a work in progress and not really ready for general production use.

Installation

  npm install react-slick

Example

const React = require('react');
const Slider = require('react-slick');
require('react-slick/slick.css');

const SimpleSlider = () => {
    const props = {
      dots: true,
      infinite: true,
      speed: 500,
      slidesToShow: 1,
      slidesToScroll: 1
    };
    return (
      <Slider {...props}>
        <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>
    );
  }

** Note: This part of the README has not yet been updated after the fork. It's probably not really accurate right now. **

| Property | Type | Description | Working | | ------------- | ---- | ----------- | ------- | | 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 Component | Use this component for the next arrow button | Yes | | prevArrow | React Component | Use this component 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 | | | | | 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 | | | | infinite | bool | should the gallery wrap around it's contents | Yes | | initialSlide | int | which item should be the first to be displayed | Yes | | lazyLoad | bool | Loads images or renders components on demands | 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 smalles 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 ||| | touchMove | bool ||| | touchThreshold | int ||| | variableWidth | bool ||| | useCSS | bool | Enable/Disable CSS Transitions | Yes | | vertical | bool ||| | 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