Ticket #8771: observe_field_examples.diff

actionpack/lib/action_view/helpers/prototype_helper.rb

@@ -269 +269 @@
-      # Required +options+ are either of:
-      # <tt>:url</tt>::       +url_for+-style options for the action to call
-      #                       when the field has changed.
+      #
+      #                       Example
+      #
+      #                       :url => {:controller => 'graph', :action => 'new'}
-      # <tt>:function</tt>::  Instead of making a remote call to a URL, you
-      #                       can specify a function to be called instead.
-      # 
@@ -293 +297 @@
-      #                         :with => "'my_custom_key=' + value"
-      #                         :with => "'person[name]=' + prompt('New name')"
-      #                         :with => "Form.Element.serialize('other-field')"
+      #                         :with => "'id=' + escape(value)"
-      #
-      #                       Finally
-      #                         :with => 'name'
@@ -307 +312 @@
-      #
-      # Additionally, you may specify any of the options documented in
-      # link_to_remote.
+      # 
+      # A typical application updates a <div id='graph'> with the result of an AJAX 
+      # call and also shows a spinner in <div id='spinner'> while loading.
+      #
+      # Example:
+      #   <%= observe_field('id', 
+        #                 :update => "graph", 
+        #                 :url => {:controller => 'graph', :action => 'new'}, 
+        #                 :with => "'id=' + escape(value)",
+        #                 :loading => "Element.hide(\"graph\");Element.show(\"spinner\");",
+        #                 :complete => "Element.hide(\"spinner\");Element.show(\"graph\");") %>
+        #
+        # or alternatively use the <tt>Element.toggle()</tt> javascript
+        #
+      #   <%= observe_field('id', 
+        #                 :update => "graph", 
+        #                 :url => {:controller => 'graph', :action => 'new'}, 
+        #                 :with => "'id=' + escape(value)",
+        #                 :loading => "Element.toggle(\"graph\");Element.toggle(\"spinner\");",
+        #                 :complete => "Element.toggle(\"spinner\");Element.toggle(\"graph\");") %>                                               
-      def observe_field(field_id, options = {})
-        if options[:frequency] && options[:frequency] > 0
-          build_observer('Form.Element.Observer', field_id, options)