Writing jQuery that doesn't suck - London jQuery

63
taken by Jeremy Keith - http://www.flickr.com/photos/adactio/ Writing jQuery JavaScript that doesn’t suck Monday, 4 July 2011

description

From my presentation at the London jQuery meetup, 4th July 2011. External links made in the slides can be found at http://bit.ly/ross-london-jquery

Transcript of Writing jQuery that doesn't suck - London jQuery

Page 1: Writing jQuery that doesn't suck - London jQuery

taken by Jeremy Keith - http://www.flickr.com/photos/adactio/

Writing jQuery JavaScript that doesn’t suck

Monday, 4 July 2011

Page 2: Writing jQuery that doesn't suck - London jQuery

Ross Bruniges

Introductions

Monday, 4 July 2011

Page 3: Writing jQuery that doesn't suck - London jQuery

Introductions

taken by Mike Morgan - http://www.flickr.com/photos/morgamic/

Ross Bruniges, Web Developer at Mozilla

Monday, 4 July 2011

Page 4: Writing jQuery that doesn't suck - London jQuery

Introductions

We’re hiring!

careers.mozilla.com

Monday, 4 July 2011

Page 5: Writing jQuery that doesn't suck - London jQuery

Ross Bruniges, Regular drinker at Pub Standards

Introductions

taken by Mike Morgan - http://www.flickr.com/photos/morgamic/

Monday, 4 July 2011

Page 6: Writing jQuery that doesn't suck - London jQuery

taken by Caz Mockett - http://www.flickr.com/photos/rugbymadgirl/

So what am I going to be talking about?

Introductions

Monday, 4 July 2011

Page 7: Writing jQuery that doesn't suck - London jQuery

taken by Julian Burgess - http://www.flickr.com/photos/aubergene/

A JavaScript mixed bag.

Introductions

Monday, 4 July 2011

Page 8: Writing jQuery that doesn't suck - London jQuery

Leaving things as you would like them to be found

Organisation

Monday, 4 July 2011

Page 9: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationLint your JavaScript

Organisation

JSLint is a JavaScript program that looks for problems in JavaScript programs. It is a code quality tool.

More information on the JS Lint at http://www.jslint.com/lint.html

Monday, 4 July 2011

Page 10: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationBeware global variables, they are easy to overwrite

Organisation

application = some large JS app (global)

function eatMe() {

// accessing the global variable

application = false;

}

eatMe();

application.shouldWork();// now returns false

Monday, 4 July 2011

Page 11: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationBeware global variables, they are easy to overwrite

Organisation

application = some large JS app (global)

function eatMe() {

// now accessing a local variable

var application = false;}

eatMe();

application.shouldWork()// now works

Monday, 4 July 2011

Page 12: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationDon’t rely on semi-colon insertion to work

Organisation

return{ javascript : "fantastic"};

Example by Douglas Crockford

Monday, 4 July 2011

Page 13: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationDon’t rely on semi-colon insertion to work

Organisation

return; // Semicolon inserted, believing the statement has finished. Returns undefined{ // Considered to be an anonymous block, doing nothing javascript : "fantastic"};// Semicolon interpreted as an empty dummy line and moved down

Example by Douglas Crockford

Monday, 4 July 2011

Page 14: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationHug your brackets and remember to include your semi-colons

Organisation

return { javascript : "fantastic"};

Example by Douglas Crockford

Monday, 4 July 2011

Page 15: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationAlways use === and !==

Organisation

1 == true // returns true as 1 is a ‘truthy’ value and gets converted to such

1 === true // returns false as no conversion is applied

Monday, 4 July 2011

Page 16: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationDo it for Douglas

Organisation

More Crockford facts at http://crockfordfacts.com/

Monday, 4 July 2011

Page 17: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationAvoid long chained statements - just because you can doesn’t mean that you should.

Organisation

$(‘#foo’).click(function(){console.log(‘please stop this madness’);}).end().filter(‘div.urgghhh’)

Pain for someone down the line

Monday, 4 July 2011

Page 18: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationEveryone likes a nice chain

Organisation

Monday, 4 July 2011

Page 19: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationBut you can end up looking like a douche if you get too much

Organisation

Monday, 4 July 2011

Page 20: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationThis works just fine

Organisation

$(‘#foo’)

.click(function(){

console.log(‘please stop this madness’);

})

.end()

.filter(‘div.urgghhh’);

Monday, 4 July 2011

Page 21: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationMake use of a JS Design Pattern

Organisation

Monday, 4 July 2011

Page 22: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationFree book!

Organisation

http://addyosmani.com/blog/essentialjsdesignpatterns/

Monday, 4 July 2011

Page 23: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationRevealing Module Pattern - clean, tidy and easy to understand

Organisation

var clean = function() {

var debug = false;

var init = function() {

console.log(‘fail’);

};

return {

init : init

};

}();

clean.init();

Monday, 4 July 2011

Page 24: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationModules play well with JS loaders

Organisation

Monday, 4 July 2011

Page 25: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationAvoid over complication

Organisation

Monday, 4 July 2011

Page 26: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationJust because you THINK it might be cool doesn’t mean it will be. Especially if no one has asked for it.

Organisation

Monday, 4 July 2011

Page 27: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationDon’t stuff your functions until they burst

Organisation

function poorlyThoughtOut() { // OK I’m going to get some elements // add a class or two // parse some data from the elements // remove some DOM elements // parse some data from someplace else // fade the background to yellow to highlight the change // update the screenreader buffer}

Monday, 4 July 2011

Page 28: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationSmaller functions are easier to understand and more modular

Organisation

function parseData() {}

function updateBuffer() {}

function betterPlanned() { // OK I’m going to get some elements // add a class or two // parseData() // remove some DOM elements // parseData() // updateBuffer()}

Monday, 4 July 2011

Page 29: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationCustom events to allow for future development

Organisation

In your code trigger an event

$.trigger(‘carousel_move’);

If someone needs it they can use it later

$.bind(‘carousel_move’, function(e) {

console.log(‘event functionality without needing to alter the existing code base’);

});

Monday, 4 July 2011

Page 30: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationComment your code

Organisation

// // Dear maintainer:// // Once you are done trying to 'optimize' this routine,// and have realized what a terrible mistake that was,// please increment the following counter as a warning// to the next guy:// // total_hours_wasted_here = 39//

comment from stackoverflow thread - http://stackoverflow.com/questions/184618/

Monday, 4 July 2011

Page 31: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationJSDocToolkit - comments in, documentation out

Organisation

/** * Change the role of the employee. * @param {integer} employeeId The id of the employee. * @param {string} [newRole] The new role of the employee. */function recast(employeeId, newRole) {}

project homepage at http://code.google.com/p/jsdoc-toolkit/

Monday, 4 July 2011

Page 32: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationDocumentation-Driven Design, document first code second

Organisation

full article by Frances Berriman at http://24ways.org/2010/documentation-driven-design-for-apis

/*@name vehicle.Sled#reindeer@function@description Set the reindeer that will pull Santa's sled.@param {string[]} reindeer A list of the reindeer.@example// specifying some reindeerSled().reindeer(['Dasher', 'Dancer', 'Rudolph', 'Vixen']);*/

Monday, 4 July 2011

Page 33: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationWhatever you choose ensure you do it from the start.

Organisation

// TODO: Fix this. Fix what?

comment from stackoverflow thread - http://stackoverflow.com/questions/184618/

Monday, 4 July 2011

Page 34: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationKeep it up to date

Organisation

/** * Always returns true. */public boolean isAvailable() { return false;}

comment from stackoverflow thread - http://stackoverflow.com/questions/184618/

Monday, 4 July 2011

Page 35: Writing jQuery that doesn't suck - London jQuery

Performance

diagram from http://www.sapdesignguild.org/

Monday, 4 July 2011

Page 36: Writing jQuery that doesn't suck - London jQuery

Don’t prematurely optimise - you’re just ASSuming

Performance

taken by pi.kappa - http://www.flickr.com/photos/27890120@N08/

Monday, 4 July 2011

Page 37: Writing jQuery that doesn't suck - London jQuery

Write good selectors (sizzle parse right to left - in IE6 and 7)

Performance

$(‘#foo div’) = bad, it will search first for ALL divs in the document;

$(‘div.me’) is better it will only search for divs with that specific class

$(‘div#me’) = best, all JS parses will look only for that specific element

Monday, 4 July 2011

Page 38: Writing jQuery that doesn't suck - London jQuery

Cache quicker for reuse

Performance

var expensive-selector = $(“.section:first”), reused-json-object = $.getJSON(‘docs.json’), reusable-regex = /d(b+)d/g;

Monday, 4 July 2011

Page 39: Writing jQuery that doesn't suck - London jQuery

Exit quickly to avoid silent fails

Performance

Monday, 4 July 2011

Page 40: Writing jQuery that doesn't suck - London jQuery

Exit quickly to avoid silent fails

Performance

var elm = $(‘#findMe’);

if (!elm.length) { return false; }

We now know that this code will only be run if the element actually exists.

Monday, 4 July 2011

Page 41: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

Performance

from The Mysteries of JavaScript Fu, Dan Webb - http://www.slideshare.net/danwrong/java-script-fu-

Monday, 4 July 2011

Page 42: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

.live() example - quick and dirty

$('tr').live('click', function(event) { // this == tr element});

Remember to use eventDelegationCode examples from http://brandonaaron.net/blog/2010/03/4/event-delegation-with-jquery

Monday, 4 July 2011

Page 43: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

.delegate() example - also chainable

$('table').delegate('tr', 'click', function(event){ // this == tr element});

Remember to use eventDelegationCode examples from http://brandonaaron.net/blog/2010/03/4/event-delegation-with-jquery

Monday, 4 July 2011

Page 44: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

Handrolled example - maximum control

$('table').bind('click', function(event) { // this == table element var $tr = $(event.target).closest('tr');});

Remember to use eventDelegationCode examples from http://brandonaaron.net/blog/2010/03/4/event-delegation-with-jquery

Monday, 4 July 2011

Page 45: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

Cause minimal reflows and repaints (especially in IE)

Monday, 4 July 2011

Page 46: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

RepaintsQuote from http://dev.opera.com/articles/view/efficient-javascript/?page=all

“Repaint - also known as redraw - is what happens whenever something is made visible when it was not previously visible, or vice versa, without altering the layout of the document.”

Monday, 4 July 2011

Page 47: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationQuote from http://dev.opera.com/articles/view/efficient-javascript/?page=all

PerformancePerformance

Reflows

“whenever the DOM tree is manipulated, whenever a style is changed that affects the layout, whenever the className property of an element is changed, or whenever the browser window size is changed...

In many cases, they are equivalent to laying out the entire page again.”

Monday, 4 July 2011

Page 48: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation

PerformancePerformance

Use the latest version of jQuery!

Monday, 4 July 2011

Page 49: Writing jQuery that doesn't suck - London jQuery

taken by Drew McLellan - http://www.flickr.com/photos/drewm/

Don’t forget your accessibility

Monday, 4 July 2011

Page 50: Writing jQuery that doesn't suck - London jQuery

Don’t forget your accessibility

Don’t forget your focus (and blur)

Monday, 4 July 2011

Page 51: Writing jQuery that doesn't suck - London jQuery

If you use .bind (opposed to .click) you can include multiple events

Don’t forget your accessibility

$(‘#foo’).bind(‘mouseenter focus’, function(e) {code goes here

});

$(‘#foo’).bind(‘mouseleave blur’, function(e) {code goes here

});

Monday, 4 July 2011

Page 52: Writing jQuery that doesn't suck - London jQuery

Invalid mark-up is still invalid mark-up even when inserted via JS

Don’t forget your accessibility

Monday, 4 July 2011

Page 53: Writing jQuery that doesn't suck - London jQuery

Remember to update the screenreader buffer

Don’t forget your accessibility

Monday, 4 July 2011

Page 54: Writing jQuery that doesn't suck - London jQuery

The old(ish) way

Don’t forget your accessibility

1. Update the value of a hidden input field2. Ensure that you have a tabIndex value of -1 on the element that you’ve altered3. .focus() on the newly inserted content

Monday, 4 July 2011

Page 55: Writing jQuery that doesn't suck - London jQuery

The new(ish) way - ARIA live regions

Don’t forget your accessibility

“Live region markup allows web page authors to specify when and how live changes to specific areas of a web page should be spoken or shown on a Braille display by a screen reader.”

Read more at https://developer.mozilla.org/en/AJAX/WAI_ARIA_Live_Regions

Monday, 4 July 2011

Page 56: Writing jQuery that doesn't suck - London jQuery

The new(ish) way - ARIA live regionsRead more at https://developer.mozilla.org/en/AJAX/WAI_ARIA_Live_Regions

Don’t forget your accessibility

aria-live - sets the frequency of updates to AT

aria-controls - associates a control with an area. All actions on that control are announced by AT

aria-relevant - states what changes to the live region are to be announced to AT

Monday, 4 July 2011

Page 57: Writing jQuery that doesn't suck - London jQuery

PerformanceDon’t forget your ‘edge cases’

Monday, 4 July 2011

Page 58: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationIf things can go wrong then normally will

Don’t forget your ‘edge cases’

Monday, 4 July 2011

Page 59: Writing jQuery that doesn't suck - London jQuery

Don’t forget your ‘edge cases’

Remember to code for when the server doesn’t return a value - it might be down or the app might be broken.

The server might take longer to reply than expected and cause a timeout meaning an empty return value.

If things can go wrong then normally will

Monday, 4 July 2011

Page 60: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegation$.ajax to the rescue

Don’t forget your ‘edge cases’

$.ajax is the backbone to all jQuery AJAX methods like $.getScript or $.getJSON and allows for much greater flexibility.

$.ajax({ url : “foo.php”, dataType : “json”, success : function(data) { gets sent the JSON response }, error : function() { gets sent the error type and text }, timeout : 1000});

Monday, 4 July 2011

Page 61: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationjQuery isn’t a 100% magic bullet

Don’t forget your ‘edge cases’ - like other browsers!

Monday, 4 July 2011

Page 62: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationLooking for the links?

Thanks for listening!

http://bit.ly/ross-london-jquery

Monday, 4 July 2011

Page 63: Writing jQuery that doesn't suck - London jQuery

Remember to use eventDelegationCheers!Taken by Mark Klotz - http://www.flickr.com/photos/markklotz/

Monday, 4 July 2011