Rails plugin for auto_complete with jQuery instead of Prototype/Scriptaculous
Switch branches/tags
Nothing to show
Pull request Compare This branch is 4 commits ahead of chris:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


This plugin provides a auto-complete method for your controllers to be used
with Dylan Verheul's jquery autocomplete plugin.  This jQuery plugin is not
included, and can be obtained from:


This auto_complete_jquery plugin is just a modified version of the standard
Rails auto_complete plugin.  It provides the same auto_complete_for method
for your controllers, but eliminates the various view helper methods, as
those are not needed when using jQuery and Unobtrusive JavaScript.

To use this, you need to have jQuery and the autocomplete plugin mentioned 
above (as well as appropriate CSS).  Then, there are four aspects of setting 
up an auto-complete field:

1) Create the text field in your view, which is just a regular form text
field as you'd create in a Rails erb view:

  <%= post.text_field :title, :autocomplete =>"off" %>
2) Include the appropriate JS files and CSS in your layout or similar:

  <%= stylesheet_link_tag 'jquery.ui.autocomplete' %>
  <%= javascript_include_tag 'jquery.min', 'jquery.dimensions.min', 'jquery.templating', 'jquery.ui.autocomplete.ext', 'jquery.ui.autocomplete', :cache => 'jquery' %>

3) Use the auto_complete_for controller macro to generate the appropriate
auto-complete method in your controller, such as:

  # Controller
  class BlogController < ApplicationController
    auto_complete_for :post, :title

4) Hook up the text field's autocomplete event in your JavaScript file
using jQuery and the jquery-autocomplete plugin mechanism, for example:

  $(document).ready(function() {

By default, auto_complete_for limits the results to 10 entries,
and sorts by the given field.

auto_complete_for takes a third parameter, an options hash to
the find method used to search for the records:

  auto_complete_for :post, :title, :limit => 15, :order => 'created_at DESC'

For more information, see:
* jQuery site: http://jquery.com
* Dylan Verheul jquery autocomplete plugin site: http://www.dyve.net/jquery/?autocomplete
* Good article on jQuery and Rails (note this mentions a different jquery autocomplete 
  plugin, which was originally used in this plugin): http://errtheblog.com/posts/73-the-jskinny-on-jquery
* Original Rails auto_complete plugin: http://github.com/rails/auto_complete

Copyright (c) 2008 Cobalt Edge LLC, released under the MIT license.