8000 Cleaned up javascript code by flip111 · Pull Request #4376 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

Cleaned up javascript code #4376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Cleaned up javascript code #4376

wants to merge 3 commits into from

Conversation

flip111
Copy link
Contributor
@flip111 flip111 commented Oct 25, 2014
Q A
Doc fix? yes
New docs? no
Applies to 2.3
Fixed tickets n/a
  1. Reused variable emailList which is best practice and easier to read
  2. Removed return false. There is no use for it in this context and many consider it to be bad use as well. For example: http://fuelyourcoding.com/jquery-events-stop-misusing-return-false/

1. Reused variable `emailList` which is best practice and easier to read
2. Removed `return false`. There is no use for it in this context and many consider it to be bad use as well. For example: http://fuelyourcoding.com/jquery-events-stop-misusing-return-false/
@@ -192,9 +192,7 @@ you need is the JavaScript:

// create a new list element and add it to the list
var newLi = jQuery('<li></li>').html(newWidget);
newLi.appendTo(jQuery('#email-fields-list'));

return false;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now you removed return false, you should add e.preventDefault() on line 183 and an argument e in the event listener callback.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well i'm not sure the default does anything since it's an a href with action #. But i added it anyway ^^

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure of the benefit removing the return false since it's more intuitive and easy to read than e.preventDefault() and have in this context the same role... :o

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They do not do the same thing. The PR description contains a link to an article about the differences.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think e.preventDefault() is easier, since its naming is clear about what it is doing: preventing the default behaviour. return false might be intuitive to JS developers, but it clearly isn't if you aren't used to program in JavaScript.

Furthermore, using it is consistent with the jQuery examples in the form collections cookbook (I think we might need to make them even more consistent).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@flip111 to make the review complete, preventing the default is needed. Otherwise, the behavior of href="#" will be to make your browser scroll to the top of the page

@wouterj
Copy link
Member
wouterj commented Oct 26, 2014

Thanks @flip111.

wouterj added a commit that referenced this pull request Oct 26, 2014
This PR was squashed before being merged into the 2.3 branch (closes #4376).

Discussion
----------

Cleaned up javascript code

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | 2.3
| Fixed tickets | n/a

1. Reused variable `emailList` which is best practice and easier to read
2. Removed `return false`. There is no use for it in this context and many consider it to be bad use as well. For example: http://fuelyourcoding.com/jquery-events-stop-misusing-return-false/

Commits
-------

8931249 Cleaned up javascript code
@wouterj wouterj closed this Oct 26, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
0