Skip to content

Latest commit

 

History

History
132 lines (95 loc) · 4.12 KB

README.md

File metadata and controls

132 lines (95 loc) · 4.12 KB
Raw

jQuery colorpicker for Rails

Gem Version Build Status Code Climate

This gem embeddes the jQuery colorpicker in the Rails asset pipeline.

Screenshot

See http://labs.abeautifulsite.net/jquery-minicolors/

Installation

Add to Gemfile and run bundle install:

# Gemfile
gem 'jquery-minicolors-rails'

Add to app/assets/javascripts/application.js:

//= require jquery # Not included
//= require jquery.minicolors

Add to app/assets/stylesheets/application.css:

/*
 *= require jquery.minicolors
 */

Usage

Just call minicolors() with any text-input selector:

# With default options:
$ -> $('input[type=text]').minicolors()

# With Bootstrap theme (Bootstrap-3 is supported):
$ -> $('input[type=text]').minicolors theme: 'bootstrap'

SimpleForm

Add to app/assets/javascripts/application.js:

//= require jquery # Not included
//= require jquery.minicolors
//= require jquery.minicolors.simple_form

See https://github.com/plataformatec/simple_form

<%# app/views/balloons/_form.html.erb %>

<%# Basic usage: %>
<%= simple_form_for @balloon do |f| %>
  <%= f.input :color, as: :minicolors %>
<% end %>

<%# With Bootstrap theme and swatch on the right: %>
<%= simple_form_for @balloon do |f| %>
  <%= f.input :color, as: :minicolors, input_html: {data: {
          minicolors: {theme: :bootstrap, position: :right}}} %>
<% end %>

Configuration

As of rails/rails#7968 (Rails > 4.*) the asset pipeline precompile command will ignore the images. Since jquery.minicolors uses an image for backgrounds, the image is by default splitted into chunks of data URLs and embedded into the CSS directly. This results in a slightly bigger compiled CSS (~50k bigger), but avoids unnecessary image request to the server and headache on deployment. You can still instruct JqueryMinicolorsRails to use the original image instead of the data URLs:

# config/initializers/jquery_minicolors_rails.rb
JqueryMinicolorsRails.use_data_urls = false

Additionally you would also have to copy the image to the deployment target:

# config/deploy.rb
after :deploy do
  target = File.join(%W[#{release_path} public assets])
  run "cp -r `cd #{release_path} && bundle show jquery-minicolors-rails`/vendor/assets/images/jquery.minicolors.png #{target}"
end

Testing

bundle exec rspec

Versioning

Gem Version

Gem has the same version as the vendored minicolors library (http://git.io/ZWaGNg) plus an extra minor version number.

MIT-License

Copyright 2012 Kostiantyn Kahanskyi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.