From 02c1dae551b5c1891423ce46a0e4d8b06048b60b Mon Sep 17 00:00:00 2001
From: David Heinemeier Hansson <david@loudthinking.com>
Date: Sun, 17 Jul 2005 09:23:56 +0000
Subject: Docs for JavaScriptHelper#remote_function #1740
 [jon@instance-design.co.uk]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@1847 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
---
 actionpack/lib/action_view/helpers/javascript_helper.rb | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'actionpack/lib/action_view')

diff --git a/actionpack/lib/action_view/helpers/javascript_helper.rb b/actionpack/lib/action_view/helpers/javascript_helper.rb
index 5f450e9e8f..76be539332 100644
--- a/actionpack/lib/action_view/helpers/javascript_helper.rb
+++ b/actionpack/lib/action_view/helpers/javascript_helper.rb
@@ -235,7 +235,15 @@ module ActionView
         "eval(request.responseText)"
       end
 
-      def remote_function(options) #:nodoc: for now
+      # Returns the javascript needed for a remote function.
+      # Takes the same arguments as link_to_remote
+      # 
+      # Example:
+      #   <select id="options" onchange="<%= remote_function(:update => "options", :url => { :action => :update_options }) %>">
+      #     <option value="0">Hello</option>
+      #     <option value="1">World</option>
+      #   </select>
+      def remote_function(options)
         javascript_options = options_for_ajax(options)
 
         update = ''
-- 
cgit v1.2.3