method

auto_complete_field

v1.0.0 - Show latest stable - 2 notes - Class: ActionView::Helpers::JavaScriptMacrosHelper

1.0.0 (0)
1.1.6 (11)
1.2.6 (5)
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
What's this?

auto_complete_field(field_id, options = {}) public

Adds AJAX autocomplete functionality to the text input field with the DOM ID specified by field_id.

This function expects that the called action returns a HTML <ul> list, or nothing if no entries should be displayed for autocompletion.

You’ll probably want to turn the browser’s built-in autocompletion off, su be sure to include a autocomplete="off" attribute with your text input field.

Required options are:

:url: URL to call for autocompletion results in url_for format.

Addtional options are:

`:update:`	Specifies the DOM ID of the element whose innerHTML should be updated with the autocomplete entries returned by the AJAX request. Defaults to field_id + ‘_auto_complete’
`:with:`	A JavaScript expression specifying the parameters for the XMLHttpRequest. This defaults to ‘fieldname=value’.
`:indicator:`	Specifies the DOM ID of an element which will be displayed while autocomplete is running.
`:tokens:`	A string or an array of strings containing separator tokens for tokenized incremental autocompletion. Example: `:tokens => ','` would allow multiple autocompletion entries, separated by commas.
`:min_chars:`	The minimum number of characters that should be in the input field before an Ajax call is made to the server.
`:on_hide:`	A Javascript expression that is called when the autocompletion div is hidden. The expression should take two variables: element and update. Element is a DOM element for the field, update is a DOM element for the div from which the innerHTML is replaced.
`:on_show:`	Like on_hide, only now the expression is called then the div is shown.

Show source

# File actionpack/lib/action_view/helpers/java_script_macros_helper.rb, line 108
      def auto_complete_field(field_id, options = {})
        function =  "new Ajax.Autocompleter("
        function << "'#{field_id}', "
        function << "'" + (options[:update] || "#{field_id}_auto_complete") + "', "
        function << "'#{url_for(options[:url])}'"
        
        js_options = {}
        js_options[:tokens] = array_or_string_for_javascript(options[:tokens]) if options[:tokens]
        js_options[:callback]   = "function(element, value) { return #{options[:with]} }" if options[:with]
        js_options[:indicator]  = "'#{options[:indicator]}'" if options[:indicator]
        {:on_show => :onShow, :on_hide => :onHide, :min_chars => :min_chars}.each do |k,v|
          js_options[v] = options[k] if options[k]
        end
        function << (', ' + options_for_javascript(js_options) + ')')

        javascript_tag(function)
      end