Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add documentation examples to prototype helper. Closes #7211 [manfred]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@8308 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
commit 7e608af9ffd4fd62d6dca9fd2d4a31d6397f3b4d 1 parent 9ffb632
Marcel Molina authored
View
2  actionpack/CHANGELOG
@@ -1,5 +1,7 @@
*SVN*
+* Add documentation examples to prototype helper. Closes #7211 [manfred]
+
* Enhance documentation coverage for fragment caching. Closes #7315 [bscofield]
* Fix typo in number helper docs. Closes #7582 [josh]
View
25 actionpack/lib/action_view/helpers/prototype_helper.rb
@@ -531,8 +531,23 @@ def remote_function(options)
# you can specify it instead to be "blur" or "focus" or
# any other event.
#
- # Additionally, you may specify any of the options documented in
- # link_to_remote.
+ # Additionally, you may specify any of the options documented in the
+ # <em>Common options</em> section at the top of this document.
+ #
+ # Example:
+ #
+ # # Sends params: {:title => 'Title of the book'} when the book_title input
+ # # field is changed.
+ # observe_field 'book_title',
+ # :url => 'http://example.com/books/edit/1',
+ # :with => 'title'
+ #
+ # # Sends params: {:book_title => 'Title of the book'} when the focus leaves
+ # # the input field.
+ # observe_field 'book_title',
+ # :url => 'http://example.com/books/edit/1',
+ # :on => 'blur'
+ #
def observe_field(field_id, options = {})
if options[:frequency] && options[:frequency] > 0
build_observer('Form.Element.Observer', field_id, options)
@@ -967,6 +982,12 @@ def method_missing(method, *arguments)
# 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
def update_page(&block)
JavaScriptGenerator.new(@template, &block).to_s
end
Please sign in to comment.
Something went wrong with that request. Please try again.