Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including slick-carousel with all npm packages installed. Try it out:

require("jquery/package.json"); // jquery is a peer dependency. var slickCarousel = require("slick-carousel")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

slick-carousel v1.8.1

the last carousel you'll ever need

slick

the last carousel you'll ever need

Demo

http://kenwheeler.github.io/slick

CDN

To start working with Slick right away, there's a couple of CDN choices availabile to serve the files as close, and fast as possible to your users:

  • https://cdnjs.com/libraries/slick-carousel
  • https://www.jsdelivr.com/projects/jquery.slick
Example using jsDelivr

Just add a link to the css file in your <head>:

<!-- Add the slick-theme.css if you want default styling -->
<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/gh/kenwheeler/slick@1.8.1/slick/slick.css"/>
<!-- Add the slick-theme.css if you want default styling -->
<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/gh/kenwheeler/slick@1.8.1/slick/slick-theme.css"/>

Then, before your closing <body> tag add:

<script type="text/javascript" src="//cdn.jsdelivr.net/gh/kenwheeler/slick@1.8.1/slick/slick.min.js"></script>

Package Managers

# Bower
bower install --save slick-carousel

# NPM
npm install slick-carousel

Contributing

PLEASE review CONTRIBUTING.markdown prior to requesting a feature, filing a pull request or filing an issue.

Data Attribute Settings

In slick 1.5 you can now add settings using the data-slick attribute. You still need to call $(element).slick() to initialize slick on the element.

Example:

<div data-slick='{"slidesToShow": 4, "slidesToScroll": 4}'>
  <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>
</div>

Settings

OptionTypeDefaultDescription
accessibilitybooleantrueEnables tabbing and arrow key navigation. Unless autoplay: true, sets browser focus to current slide (or first of current slide set, if multiple slidesToShow) after slide change. For full a11y compliance enable focusOnChange in addition to this.
adaptiveHeightbooleanfalseAdapts slider height to the current slide
appendArrowsstring$(element)Change where the navigation arrows are attached (Selector, htmlString, Array, Element, jQuery object)
appendDotsstring$(element)Change where the navigation dots are attached (Selector, htmlString, Array, Element, jQuery object)
arrowsbooleantrueEnable Next/Prev arrows
asNavForstring$(element)Enables syncing of multiple sliders
autoplaybooleanfalseEnables auto play of slides
autoplaySpeedint3000Auto play change interval
centerModebooleanfalseEnables centered view with partial prev/next slides. Use with odd numbered slidesToShow counts.
centerPaddingstring'50px'Side padding when in center mode. (px or %)
cssEasestring'ease'CSS3 easing
customPagingfunctionn/aCustom paging templates. See source for use example.
dotsbooleanfalseCurrent slide indicator dots
dotsClassstring'slick-dots'Class for slide indicator dots container
draggablebooleantrueEnables desktop dragging
easingstring'linear'animate() fallback easing
edgeFrictioninteger0.15Resistance when swiping edges of non-infinite carousels
fadebooleanfalseEnables fade
focusOnSelectbooleanfalseEnable focus on selected element (click)
focusOnChangebooleanfalsePuts focus on slide after change
infinitebooleantrueInfinite looping
initialSlideinteger0Slide to start on
lazyLoadstring'ondemand'Accepts 'ondemand' or 'progressive' for lazy load technique. 'ondemand' will load the image as soon as you slide to it, 'progressive' loads one image after the other when the page loads.
mobileFirstbooleanfalseResponsive settings use mobile first calculation
nextArrowstring (html | jQuery selector) | object (DOM node | jQuery object)<button type="button" class="slick-next">Next</button>Allows you to select a node or customize the HTML for the "Next" arrow.
pauseOnDotsHoverbooleanfalsePauses autoplay when a dot is hovered
pauseOnFocusbooleantruePauses autoplay when slider is focussed
pauseOnHoverbooleantruePauses autoplay on hover
prevArrowstring (html | jQuery selector) | object (DOM node | jQuery object)<button type="button" class="slick-prev">Previous</button>Allows you to select a node or customize the HTML for the "Previous" arrow.
respondTostring'window'Width that responsive object responds to. Can be 'window', 'slider' or 'min' (the smaller of the two).
responsivearraynullArray of objects containing breakpoints and settings objects (see example). Enables settings at given breakpoint. Set settings to "unslick" instead of an object to disable slick at a given breakpoint.
rowsint1Setting this to more than 1 initializes grid mode. Use slidesPerRow to set how many slides should be in each row.
rtlbooleanfalseChange the slider's direction to become right-to-left
slidestring''Slide element query
slidesPerRowint1With grid mode initialized via the rows option, this sets how many slides are in each grid row.
slidesToScrollint1# of slides to scroll at a time
slidesToShowint1# of slides to show at a time
speedint300Transition speed
swipebooleantrueEnables touch swipe
swipeToSlidebooleanfalseSwipe to slide irrespective of slidesToScroll
touchMovebooleantrueEnables slide moving with touch
touchThresholdint5To advance slides, the user must swipe a length of (1/touchThreshold) * the width of the slider.
useCSSbooleantrueEnable/Disable CSS Transitions
useTransformbooleantrueEnable/Disable CSS Transforms
variableWidthbooleanfalseDisables automatic slide width calculation
verticalbooleanfalseVertical slide direction
verticalSwipingbooleanfalseChanges swipe direction to vertical
waitForAnimatebooleantrueIgnores requests to advance the slide while animating
zIndexnumber1000Set the zIndex values for slides, useful for IE9 and lower
Responsive Option Example

The responsive option, and value, is quite unique and powerful. You can use it like so:

$(".slider").slick({

  // normal options...
  infinite: false,

  // the magic
  responsive: [{

      breakpoint: 1024,
      settings: {
        slidesToShow: 3,
        infinite: true
      }

    }, {

      breakpoint: 600,
      settings: {
        slidesToShow: 2,
        dots: true
      }

    }, {

      breakpoint: 300,
      settings: "unslick" // destroys slick

    }]
});

Events

In slick 1.4, callback methods were deprecated and replaced with events. Use them before the initialization of slick as shown below:

// On swipe event
$('.your-element').on('swipe', function(event, slick, direction){
  console.log(direction);
  // left
});

// On edge hit
$('.your-element').on('edge', function(event, slick, direction){
  console.log('edge was hit')
});

// On before slide change
$('.your-element').on('beforeChange', function(event, slick, currentSlide, nextSlide){
  console.log(nextSlide);
});
EventParamsDescription
afterChangeevent, slick, currentSlideAfter slide change callback
beforeChangeevent, slick, currentSlide, nextSlideBefore slide change callback
breakpointevent, slick, breakpointFires after a breakpoint is hit
destroyevent, slickWhen slider is destroyed, or unslicked.
edgeevent, slick, directionFires when an edge is overscrolled in non-infinite mode.
initevent, slickWhen Slick initializes for the first time callback. Note that this event should be defined before initializing the slider.
reInitevent, slickEvery time Slick (re-)initializes callback
setPositionevent, slickEvery time Slick recalculates position
swipeevent, slick, directionFires after swipe/drag
lazyLoadedevent, slick, image, imageSourceFires after image loads lazily
lazyLoadErrorevent, slick, image, imageSourceFires after image fails to load

Methods

Methods are called on slick instances through the slick method itself in version 1.4, see below:

// Add a slide
$('.your-element').slick('slickAdd',"<div></div>");

// Get the current slide
var currentSlide = $('.your-element').slick('slickCurrentSlide');

This new syntax allows you to call any internal slick method as well:

// Manually refresh positioning of slick
$('.your-element').slick('setPosition');
MethodArgumentDescription
slickoptions : objectInitializes Slick
unslickDestroys Slick
slickNextTriggers next slide
slickPrevTriggers previous slide
slickPausePause Autoplay
slickPlayStart Autoplay (_will also set autoplay option to true_)
slickGoToindex : int, dontAnimate : boolGoes to slide by index, skipping animation if second parameter is set to true
slickCurrentSlideReturns the current slide index
slickAddelement : html or DOM object, index: int, addBefore: boolAdd a slide. If an index is provided, will add at that index, or before if addBefore is set. If no index is provided, add to the end or to the beginning if addBefore is set. Accepts HTML String
slickRemoveindex: int, removeBefore: boolRemove slide by index. If removeBefore is set true, remove slide preceding index, or the first slide if no index is specified. If removeBefore is set to false, remove the slide following index, or the last slide if no index is set.
slickFilterfilter : selector or functionFilters slides using jQuery .filter syntax
slickUnfilterRemoves applied filter
slickGetOptionoption : string(option name)Gets an option value.
slickSetOptionchange an option, refresh is always boolean and will update UI changes...
option, value, refreshchange a single option to given value; refresh is optional.
"responsive", [{ breakpoint: n, settings: {} }, ... ], refreshchange or add whole sets of responsive options
{ option: value, option: value, ... }, refreshchange multiple options to corresponding values.

Example

Initialize with:

$(element).slick({
  dots: true,
  speed: 500
});

Change the speed with:

$(element).slick('slickSetOption', 'speed', 5000, true);

Destroy with:

$(element).slick('unslick');

Sass Variables

VariableTypeDefaultDescription
$slick-font-pathstring"./fonts/"Directory path for the slick icon font
$slick-font-familystring"slick"Font-family for slick icon font
$slick-loader-pathstring"./"Directory path for the loader image
$slick-arrow-colorcolorwhiteColor of the left/right arrow icons
$slick-dot-colorcolorblackColor of the navigation dots
$slick-dot-color-activecolor$slick-dot-colorColor of the active navigation dot
$slick-prev-characterstring'\2190'Unicode character code for the previous arrow icon
$slick-next-characterstring'\2192'Unicode character code for the next arrow icon
$slick-dot-characterstring'\2022'Unicode character code for the navigation dot icon
$slick-dot-sizepixels6pxSize of the navigation dots

Browser support

Slick works on IE8+ in addition to other modern browsers such as Chrome, Firefox, and Safari.

Dependencies

jQuery 1.7

License

Copyright (c) 2017 Ken Wheeler

Licensed under the MIT license.

Free as in Bacon.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free