What is react-slick?
The react-slick npm package is a React component that provides a carousel/slider functionality. It is a wrapper around the popular Slick carousel jQuery plugin, offering a way to add carousel features to React applications. It supports a range of options and settings to customize the behavior and appearance of the carousel.
What are react-slick's main functionalities?
Simple Slider
This code sample demonstrates how to create a simple slider with dots, infinite looping, and a set speed for slide transitions.
import React from 'react';
import Slider from 'react-slick';
function SimpleSlider() {
const settings = {
dots: true,
infinite: true,
speed: 500,
slidesToShow: 1,
slidesToScroll: 1
};
return (
<Slider {...settings}>
<div><h3>Slide 1</h3></div>
<div><h3>Slide 2</h3></div>
<div><h3>Slide 3</h3></div>
</Slider>
);
}
export default SimpleSlider;
Responsive Slider
This code sample shows how to create a responsive slider that adjusts the number of slides shown based on the screen width.
import React from 'react';
import Slider from 'react-slick';
function ResponsiveSlider() {
const settings = {
dots: true,
infinite: false,
speed: 500,
slidesToShow: 4,
slidesToScroll: 4,
responsive: [
{
breakpoint: 1024,
settings: {
slidesToShow: 3,
slidesToScroll: 3,
infinite: true,
dots: true
}
},
{
breakpoint: 600,
settings: {
slidesToShow: 2,
slidesToScroll: 2
}
},
{
breakpoint: 480,
settings: {
slidesToShow: 1,
slidesToScroll: 1
}
}
]
};
return (
<Slider {...settings}>
<div><h3>Slide 1</h3></div>
<div><h3>Slide 2</h3></div>
<div><h3>Slide 3</h3></div>
<div><h3>Slide 4</h3></div>
</Slider>
);
}
export default ResponsiveSlider;
Custom Arrows
This code sample illustrates how to create a slider with custom arrow components for navigation.
import React from 'react';
import Slider from 'react-slick';
function CustomArrowsSlider() {
function SampleNextArrow(props) {
const { className, style, onClick } = props;
return (
<div
className={className}
style={{ ...style, display: 'block', background: 'red' }}
onClick={onClick}
/>
);
}
function SamplePrevArrow(props) {
const { className, style, onClick } = props;
return (
<div
className={className}
style={{ ...style, display: 'block', background: 'green' }}
onClick={onClick}
/>
);
}
const settings = {
dots: true,
infinite: true,
speed: 500,
slidesToShow: 1,
slidesToScroll: 1,
nextArrow: <SampleNextArrow />,
prevArrow: <SamplePrevArrow />
};
return (
<Slider {...settings}>
<div><h3>Slide 1</h3></div>
<div><h3>Slide 2</h3></div>
</Slider>
);
}
export default CustomArrowsSlider;
Other packages similar to react-slick
swiper
Swiper is a powerful and modern touch slider with hardware accelerated transitions. It is highly customizable and has a similar set of features to react-slick, such as responsive breakpoints, navigation, pagination, and more. Swiper also supports virtual slides and multi-row slides, which can be an advantage over react-slick.
react-responsive-carousel
This package provides a simple and customizable carousel component for React applications. It is less feature-rich compared to react-slick but offers a lightweight alternative with basic carousel functionalities like auto play, infinite loop, and custom rendering for arrows and indicators.
keen-slider
Keen-slider is a free library agnostic touch slider with native touch/swipe behavior and great performance. It is a lightweight alternative to react-slick and offers a minimalistic approach to sliders with no dependencies. It provides essential features like touch support and responsiveness but lacks some of the more advanced features found in react-slick.
react-slick
Carousel component built with React. It is a react port of slick carousel
Important
Breaking changes in react-slick@0.15
- slickGoTo prop is deprecated in favor of slickGoTo method. Check this slickGoTo usage example.
- dist folder will be removed from the repo to simply PR review process. If you are using bower or relying on the dist files in githib repo, use dist files from unpkg.com
https://unpkg.com/react-slick@0.13.6/dist/react-slick.min.js
Installation
npm install react-slick
Also install slick-carousel for css and font
npm install slick-carousel
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" />
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');
var SimpleSlider = React.createClass({
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 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 | | | |
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 | which item should be the first to be displayed | Yes |
lazyLoad | bool | Loads images or renders components on demands | 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 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 | 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 | |
Methods
- slickNext() - function called to change current slide on next slide (Example)
- slickPrev() - function called to change current slide on previous slide (Example)
- slickGoTo(slideNumber) - function called to change current slide to given slide number (Example)
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.
Flexbox support
If you have flex property on container div of slider, add below css
* {
min-height: 0;
min-width: 0;
}
Development
Want to run demos locally
git clone https://github.com/akiran/react-slick
npm install
npm start
open http://localhost:8000
Polyfills for old IE support
matchMedia
support from media-match
For premium support, contact me on codementor