Update documentation to lead with ajax param `event.detail` #30881

dimroc · 2017-10-13T13:09:10Z

Fixes issue #30880

Summary

Using rails-ujs, not jquery-ujs

The following remote form

= link_to "an article", @article, remote: true

can no longer be handled with the documented javascript as shown here http://edgeguides.rubyonrails.org/working_with_javascript_in_rails.html#form-with:

  $("a[data-remote]").on("ajax:success", function(e, data, status, xhr) {
    console.log(data, status, xhr) // undefined
  }));

This fixes the documentation and code snippets.

rails-bot · 2017-10-13T13:09:13Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @eileencodes (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

eileencodes · 2017-10-15T13:53:19Z

guides/source/working_with_javascript_in_rails.md

-browser to submit the form via normal means (i.e. non-Ajax submission) will be
-canceled and the form will not be submitted at all. This is useful for
-implementing your own Ajax file upload workaround.
-


Why is this documentation no longer relevant?

It is relevant. It was moved, not removed, below the table of events:
https://github.com/dimroc/rails/blob/master/guides/source/working_with_javascript_in_rails.md#rails-ujs-event-handlers

guilleiguaran · 2017-10-22T13:09:31Z

guides/source/working_with_javascript_in_rails.md

-| `ajax:error`        | xhr, status, err | After completion, if the response was an error.             |
-| `ajax:complete`     | xhr, status      | After the request has been completed, no matter the outcome.|
-| `ajax:aborted:file` | elements         | If there are non-blank file inputs, aborts if stopped.      |
-


Why were this whole section removed?

Because it is repeated below with the correct extra parameters here:
https://github.com/dimroc/rails/blob/master/guides/source/working_with_javascript_in_rails.md#rails-ujs-event-handlers

Another, more accurate table, exists below. Screenshot:

Ok!! Maybe we should add a link to old version of table for jquery-ujs users?

http://guides.rubyonrails.org/v5.1/working_with_javascript_in_rails.html#dealing-with-ajax-events

Sure. How does having a note mentioning the old jquery-ujs with a link to jquery-ujs wiki sound? https://github.com/rails/jquery-ujs/wiki/ajax

Yes, lets change to that. That used to(is still) the official old events doc.

vipulnsward · 2017-11-20T12:04:58Z

guides/source/working_with_javascript_in_rails.md

    $("#new_article").append "<p>ERROR</p>"
 ```

 Obviously, you'll want to be a bit more sophisticated than that, but it's a
 start.

+NOTE: As of Rails 5.1 and the new `rails-ujs`, the parameters `e, data, status, xhr`
+have been bundled into `event.detail`.


Lets add the same wiki link here as well. e, data, status, xhr don't mean anything otherwise in future.

vipulnsward · 2017-11-20T13:55:50Z

guides/source/working_with_javascript_in_rails.md

+
+If you stop `ajax:before` or `ajax:beforeSend` by returning false from the
+handler method, the Ajax request will never take place. The `ajax:before` event
+is also useful for manipulating form data before serialization. The


can we remove the is also useful here.

dimroc · 2017-11-23T18:00:08Z

Alright, I've updated the PR with the suggested feedback. Let me know @vipulnsward @guilleiguaran if we're good to go.

vipulnsward · 2017-11-24T18:08:01Z

guides/source/working_with_javascript_in_rails.md

    $("#new_article").append "<p>ERROR</p>"
 ```

 Obviously, you'll want to be a bit more sophisticated than that, but it's a
 start.

+NOTE: As of Rails 5.1 and the new `rails-ujs`, the parameters `e, data, status, xhr`


the parameters data, status, xhr not e

vipulnsward · 2017-11-24T18:08:48Z

guides/source/working_with_javascript_in_rails.md

@@ -405,6 +377,22 @@ document.body.addEventListener('ajax:success', function(event) {
 })
 ```

+NOTE: As of Rails 5.1 and the new `rails-ujs`, the parameters `e, data, status, xhr`


Update documentation to lead with ajax param event.detail

d06a1ee

rails-bot assigned eileencodes Oct 13, 2017

eileencodes reviewed Oct 15, 2017

View reviewed changes

guilleiguaran reviewed Oct 22, 2017

View reviewed changes

dimroc mentioned this pull request Oct 22, 2017

Rails remote form js handler no longer returns extra parameters for rails-ujs #30880

Closed

vipulnsward added the docs label Nov 20, 2017

vipulnsward reviewed Nov 20, 2017

View reviewed changes

vipulnsward reviewed Nov 24, 2017

View reviewed changes

Update documentation to lead with ajax param event.detail

a6b0930

dimroc force-pushed the master branch from fddf480 to a6b0930 Compare November 24, 2017 19:22

vipulnsward merged commit 1debdb0 into rails:master Nov 24, 2017

kamipo mentioned this pull request Apr 22, 2018

Update working_with_javascript_in_rails.md to fix incorrect information and example #32683

Closed

francisco-rojas mentioned this pull request Apr 29, 2018

Incorrect documentation in "Working with Javascript" Rails Guide for 5.1 #32662

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation to lead with ajax param `event.detail` #30881

Update documentation to lead with ajax param `event.detail` #30881

dimroc commented Oct 13, 2017

rails-bot commented Oct 13, 2017

eileencodes Oct 15, 2017

dimroc Oct 22, 2017 •

edited

guilleiguaran Oct 22, 2017 •

edited

dimroc Oct 22, 2017

dimroc Oct 22, 2017

guilleiguaran Oct 22, 2017

dimroc Oct 22, 2017 •

edited

vipulnsward Nov 20, 2017

vipulnsward Nov 20, 2017

vipulnsward Nov 20, 2017

dimroc commented Nov 23, 2017

vipulnsward Nov 24, 2017

dimroc Nov 24, 2017

vipulnsward Nov 24, 2017

dimroc Nov 24, 2017

Update documentation to lead with ajax param event.detail #30881

Update documentation to lead with ajax param event.detail #30881

Conversation

dimroc commented Oct 13, 2017

Summary

rails-bot commented Oct 13, 2017

Choose a reason for hiding this comment

dimroc Oct 22, 2017 • edited

Choose a reason for hiding this comment

guilleiguaran Oct 22, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dimroc Oct 22, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dimroc commented Nov 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Update documentation to lead with ajax param `event.detail` #30881

Update documentation to lead with ajax param `event.detail` #30881

dimroc Oct 22, 2017 •

edited

guilleiguaran Oct 22, 2017 •

edited

dimroc Oct 22, 2017 •

edited