Databases
StackOverflow2013
Postsdbo
POHow to DRY up my jQuery code and make it more readable/maintanable?
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow to DRY up my jQuery code and make it more readable/maintanable?
    primarykey
    data
    text
    <p>I'm starting to do a lot of jQuery programming. I'm finding that my code is becoming a little hard to maintain and is not all that readable. My javascript is being included on every page of our web application, even though it is only used on one page. This has the benefits of having the javascript cached before loading the page, but I'm worried about accidentally creating functions with identical names (created by other programmers on my team). </p> <p>I'm new to javascript, so there may be some basics that I'm missing. What are some techniques that I can apply to the following code, as well as other code in the future to make my jQuery code more maintainable and easy to read?</p> <pre><code>&lt;script type="text/javascript"&gt; $(document).ready(function(){ $('#registration-information .copy-button').click(copyField); }); function copyField(e) { e.preventDefault(); var $tr = $(this).closest('tr'); var originalText = jQuery.trim($tr.find('.contact-data').text()); var newText = jQuery.trim($tr.find('.registration-data').text()); var $button = $tr.find('.copy-button'); var $loadingIcon = $('&lt;span class="loading-icon"&gt;&lt;/span&gt;').hide().insertAfter($button); var $undoLink = $('&lt;a class="undo-link" href="#"&gt;Undo&lt;/a&gt;').hide().insertAfter($button); var field = $button.attr('id'); $undoLink.click(function(e){ e.preventDefault(); undoCopyField($tr, originalText); }); $button.hide(); $loadingIcon.show(); $.ajax({ url: '/registrations/copy-field-to-contact', data: { id: '&lt;?php echo $registration-&gt;ID ?&gt;', field: field, data: newText }, success: function(data){ if (data.success) { $loadingIcon.hide(); $tr.find('.contact-data').html(newText); $tr.find('td.form_field_label').removeClass('mismatched'); $tr.effect('highlight', 1000, function(){ $undoLink.fadeIn(); }); } else { displayErrorMessage(data.error); $loadingIcon.hide(); $button.show(); } }, error: function(){ displayErrorMessage('Unknown reason'); $loadingIcon.hide(); $button.show(); } }); } function undoCopyField($tr, originalText) { var $button = $tr.find('.copy-button'); var $loadingIcon = $tr.find('.loading-icon'); var $undoLink = $tr.find('.undo-link'); var field = $button.attr('id'); $undoLink.hide(); $loadingIcon.show(); $.ajax({ url: '/registrations/copy-field-to-contact', data: { id: '&lt;?php echo $registration-&gt;ID ?&gt;', field: field, data: originalText }, success: function(data){ if (data.success) { $undoLink.remove(); $loadingIcon.hide(); $tr.find('.contact-data').html(originalText); $tr.find('td.form_field_label').addClass('mismatched'); $tr.effect('highlight', 1000, function(){ $tr.find('.copy-button').fadeIn(); }); } else { displayErrorMessage(data.error); $loadingIcon.hide(); $undoLink.show(); } }, error: function(){ displayErrorMessage('Unknown reason'); $loadingIcon.hide(); $undoLink.show(); } }); } function displayErrorMessage(message) { alert('Sorry, there was an error while trying to save your changes: ' + message); } &lt;/script&gt; </code></pre> <p><strong>Update:</strong> There are numerous sections of this code sample with chunks of code that are almost identical. Specifically the AJAX calls. Those two blocks are essentially the same, except for the actions that take place after the call has completed. I'd really like to figure out a way to DRY up those sections.</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PTQuestion
    1. USAndrew
    1. USAndrew
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    3. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. This table or related slice is empty.
      1. VTUpMod
    1. COYou don't need any lessons in code readability; In fact, you could teach a lesson or two to other people in here about code readability. I wish all code I have to review as as readable as yours.
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. USPhilippe Leybaert
    2. COIt would be a good idea to move those global functions to the inside of your "ready" handler.
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. USPointy
    3. COI keep Crockford's "Code Conventions for the JavaScript Programming Language" within easy reach. Not an answer to your Q but a good resource: http://javascript.crockford.com/code.html.
      singulars
      1. POHow to DRY up my jQuery code and make it more readable/maintanable?
      1. USorolo
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload