finist / jquery-slick-rails

Integrates Slick carousel, a jQuery plugin, into your Rails app.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

jQuerySlickRails

Gem Version

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:

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.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

This plugin is licensed under the MIT License.

Copyright (c) 2015 Ilya Bodrov

About

Integrates Slick carousel, a jQuery plugin, into your Rails app.

License:MIT License


Languages

Language:JavaScript 89.7%Language:Ruby 4.3%Language:HTML 3.9%Language:CSS 2.1%