Module: ActionView::Helpers::PrototypeHelper

Included in:
ActionView::Helpers, JavaScriptHelper
Defined in:
actionpack/lib/action_view/helpers/prototype_helper.rb,
actionpack/lib/action_view/helpers/scriptaculous_helper.rb

Overview

Prototype is a JavaScript library that provides DOM manipulation, Ajax functionality, and more traditional object-oriented facilities for JavaScript. This module provides a set of helpers to make it more convenient to call functions from Prototype using Rails, including functionality to call remote Rails methods (that is, making a background request to a Rails action) using Ajax. This means that you can call actions in your controllers without reloading the page, but still update certain parts of it using injections into the DOM. A common use case is having a form that adds a new element to a list without reloading the page or updating a shopping cart total when a new item is added.

Usage

To be able to use these helpers, you must first include the Prototype JavaScript framework in your pages.

javascript_include_tag 'prototype'

(See the documentation for ActionView::Helpers::JavaScriptHelper for more information on including this and other JavaScript files in your Rails templates.)

Now you're ready to call a remote action either through a link…

link_to_remote "Add to cart",
  :url => { :action => "add", :id => product.id },
  :update => { :success => "cart", :failure => "error" }

…through a form…

<%= form_remote_tag :url => '/shipping' do -%>
  <div><%= submit_tag 'Recalculate Shipping' %></div>
<% end -%>

As you can see, there are numerous ways to use Prototype's Ajax functions (and actually more than are listed here); check out the documentation for each method to find out more about its usage and options.

Common Options

See link_to_remote for documentation of options common to all Ajax helpers; any of the options specified by link_to_remote can be used by the other helpers.

Designing your Rails actions for Ajax

When building your action handlers (that is, the Rails actions that receive your background requests), it's important to remember a few things. First, whatever your action would normally return to the browser, it will return to the Ajax call. As such, you typically don't want to render with a layout. This call will cause the layout to be transmitted back to your page, and, if you have a full HTML/CSS, will likely mess a lot of things up. You can turn the layout off on particular actions by doing the following:

class SiteController < ActionController::Base
  layout "standard", :except => [:ajax_method, :more_ajax, :another_ajax]
end

Optionally, you could do this in the method you wish to lack a layout:

render :layout => false

You can tell the type of request from within your action using the request.xhr? (XmlHttpRequest, the method that Ajax uses to make background requests) method.

def name
  # Is this an XmlHttpRequest request?
  if (request.xhr?)
    render :text => @name.to_s
  else
    # No?  Then render an action.
    render :action => 'view_attribute', :attr => @name
  end
end

The else clause can be left off and the current action will render with full layout and template. An extension to this solution was posted to Ryan Heneise's blog at ArtOfMission.

layout proc{ |c| c.request.xhr? ? false : "application" }

Dropping this in your ApplicationController turns the layout off for every request that is an “xhr” request.

If you are just returning a little data or don't want to build a template for your output, you may opt to simply render text output, like this:

render :text => 'Return this from my method!'

Since whatever the method returns is injected into the DOM, this will simply inject some text (or HTML, if you tell it to). This is usually how small updates, such updating a cart total or a file count, are handled.

Updating multiple elements

See JavaScriptGenerator for information on updating multiple elements on the page in an Ajax response.

Defined Under Namespace

Classes: JavaScriptGenerator

Constant Summary

CALLBACKS =
Set.new([ :create, :uninitialized, :loading, :loaded,
:interactive, :complete, :failure, :success ] +
(100..599).to_a)
AJAX_OPTIONS =
Set.new([ :before, :after, :condition, :url,
:asynchronous, :method, :insertion, :position,
:form, :with, :update, :script, :type ]).merge(CALLBACKS)

Instance Method Summary (collapse)

Instance Method Details

- (Object) remote_function(options)

Returns the JavaScript needed for a remote function. See the link_to_remote documentation at github.com/rails/prototype_legacy_helper as it takes the same arguments.

Example:

# Generates: <select id="options" onchange="new Ajax.Updater('options',
# '/testing/update_options', {asynchronous:true, evalScripts:true})">
<select id="options" onchange="<%= remote_function(:update => "options",
    :url => { :action => :update_options }) %>">
  <option value="0">Hello</option>
  <option value="1">World</option>
</select>


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'actionpack/lib/action_view/helpers/prototype_helper.rb', line 115

def remote_function(options)
  javascript_options = options_for_ajax(options)

  update = ''
  if options[:update] && options[:update].is_a?(Hash)
    update  = []
    update << "success:'#{options[:update][:success]}'" if options[:update][:success]
    update << "failure:'#{options[:update][:failure]}'" if options[:update][:failure]
    update  = '{' + update.join(',') + '}'
  elsif options[:update]
    update << "'#{options[:update]}'"
  end

  function = update.empty? ?
    "new Ajax.Request(" :
    "new Ajax.Updater(#{update}, "

  url_options = options[:url]
  url_options = url_options.merge(:escape => false) if url_options.is_a?(Hash)
  function << "'#{html_escape(escape_javascript(url_for(url_options)))}'"
  function << ", #{javascript_options})"

  function = "#{options[:before]}; #{function}" if options[:before]
  function = "#{function}; #{options[:after]}"  if options[:after]
  function = "if (#{options[:condition]}) { #{function}; }" if options[:condition]
  function = "if (confirm('#{escape_javascript(options[:confirm])}')) { #{function}; }" if options[:confirm]

  return function.html_safe
end

- (Object) update_page(&block)

Yields a JavaScriptGenerator and returns the generated JavaScript code. Use this to update multiple elements on a page in an Ajax response. See JavaScriptGenerator for more information.

Example:

update_page do |page|
  page.hide 'spinner'
end


581
582
583
# File 'actionpack/lib/action_view/helpers/prototype_helper.rb', line 581

def update_page(&block)
  JavaScriptGenerator.new(view_context, &block).to_s.html_safe
end

- (Object) update_page_tag(html_options = {}, &block)

Works like update_page but wraps the generated JavaScript in a <script> tag. Use this to include generated JavaScript in an ERb template. See JavaScriptGenerator for more information.

html_options may be a hash of <script> attributes to be passed to ActionView::Helpers::JavaScriptHelper#javascript_tag.



591
592
593
# File 'actionpack/lib/action_view/helpers/prototype_helper.rb', line 591

def update_page_tag(html_options = {}, &block)
  javascript_tag update_page(&block), html_options
end