Sha256: d7808d971854b265eff59860d27d38529f35c3b0e065c61aaa5e8fd5142a6504

Contents?: true

Size: 1.63 KB

Versions: 2

Compression:

Stored size: 1.63 KB

Contents

# Chosen for rails asset pipeline

[Chosen](https://github.com/harvesthq/chosen) is a library for making long, unwieldy select boxes more user friendly.

The `chosen-rails` gem integrates the `Chosen` with the Rails asset pipeline.

## Usage

### Install chosen-rails gem

Include `chosen-rails` in Gemefile

    gem 'chosen-rails'

Then run `bundle install`

### Include chosen javascript assets

Add to your `app/assets/javascripts/application.js` if use with jQuery

    //= require chosen-jquery

Or with Prototype

    //= require chosen-prototype

### Include chosen stylesheet assets

Add to your `app/assets/stylesheets/application.css`

    *= require chosen

### Enable chosen javascript by specific css class

Add to one coffee script file, like `scaffold.js.coffee`

    $ ->
      # enable chosen js
      $('.chzn-select').chosen
        allow_single_deselect: true
        no_results_text: 'No results matched'
        width: '200px'

Notice: `width` option is required since `Chosen 0.9.15`.

And this file must be included in `application.js`

    //= require chosen-jquery
    //= require scaffold

Also add the class to your form field

    <%= f.select :author,
      User.all.map { |u| [u.name, u.id] },
      { include_blank: true },
      { class: 'chzn-select' }
    %>

If you use simple form as form builder

    <%= f.association :author,
      collection: User.all,
      include_blank: true,
      input_html: { class: 'chzn-select' }
    %>

## Gem maintenance

Maintain `chosen-rails` gem with `Rake` commands.

Update origin chosen source files.

    rake update-chosen

Publish gem.

    rake release

## License

use MIT license.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
chosen-rails-0.12.0 README.md
chosen-rails-0.10.0 README.md