jQuerySlickRails

A ruby gem that uses the Rails asset pipeline to include the jQuery Slick plugin by Ken Wheeler (https://kenwheeler.github.io/slick/).

Installation

Add this line to your application's Gemfile:

gem "jquery-slick-rails"

And then execute:

$ bundle

Or install it yourself as:

$ gem install jquery-slick-rails

NOTE: this is a jQuery plugin so you will also need the jquery-rails gem:

https://github.com/rails/jquery-rails

Usage

You will need to add this line into your application.js:

//= require jquery.slick

Add

@import 'slick';

into application.scss or

/*
[...]
*= require slick
[...]
*/

into application.css.

Starting from version 1.4.0 Slick provides an optional theme, so if you want to employ default styling, include the following line:

@import 'slick-theme';

into application.scss or

/*
[...]
*= require slick-theme
[...]
*/

into application.css.

You may use this simple Rails app as an example (it also shows how to use the plugin with Turbolinks).

Turbolinks Gotcha

If you are using Slick with Turbolinks, you might run into some problems with the browser's "back" button. If that happens, the following solution might help:

$(document).on('turbolinks:load', $('#my-slider').slick({}) 
$(document).on('turbolinks:before-cache', $('#my-slider').slick('unslick'))

Testing

Run

$ bundle install

and then

$ rake test

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Make sure tests are passing
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

This plugin is licensed under the MIT License.