Ruby autocomplete for SimpleForm form fields
Ruby CSS JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
simple_form_autocomplete.gemspec

README.md

SimpleFormAutocomplete

simple_form_autocomplete is a Ruby gem that enables use of jQuery Autocomplete inputs with SimpleForm.

Installation

Add this line to your application's Gemfile:

gem 'simple_form_autocomplete'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_form_autocomplete

Usage

Require the Javascript in your application.js (or other preferred) file via sprockets:

//= require simple_form_autocomplete

Optionally import the CSS in your application.css.scss (or other preferred) file. For sprockets-based apps:

//= require simple_form_autocomplete

For SCSS imports:

@import 'simple_form_autocomplete';

When rendering form via SimpleForm's simple_form_for method, supply the new input via the :as option along with a :source option to specify the data source URL or array of objects:

simple_form_for @ingredient do |f|
  f.input :name, as: :autocomplete, source: autocomplete_ingredients_path
  f.input :unit, as: :autocomplete, source: ['cup', 'tablespoon', 'teaspoon']
  f.input :quantity
end

The value supplied for the :source option should match the format expected per the jQuery autocomplete documentation.

Contributing

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