added title and description to jquery patterns

okuryu · Jan 15, 2012 · 144a0d0 · 144a0d0
1 parent 80ddc10
commit 144a0d0
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 9 deletions.
diff --git a/jquery-patterns/append.html b/jquery-patterns/append.html
@@ -1,11 +1,15 @@
-<!doctype html>
+<!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: append
+   Description: use string concatenate and set innerHTML
+*/
+
 // antipattern
 // appending inside
 $.each(reallyLongArray, function(count, item) {

diff --git a/jquery-patterns/cache-selector.html b/jquery-patterns/cache-selector.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: selector cache
+   Description: using selector cache to avoid requery
+*/
+
 // antipattern
 $('.list-item').click(function () {
   $('.photo').hide();

diff --git a/jquery-patterns/context-and-find.html b/jquery-patterns/context-and-find.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: context and find
+   Description: better to choose `find` over `context`
+*/
+
 // antipattern
 var arms = $('div.robotarm', '#container');
 // preferred

diff --git a/jquery-patterns/data.html b/jquery-patterns/data.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: data
+   Description: pattern and antipattern of using data
+*/
+
 // antipattern
 $(elem).data(key,value);
 

diff --git a/jquery-patterns/decending-from-id.html b/jquery-patterns/decending-from-id.html
@@ -6,8 +6,8 @@
 </head>
 <body>
 <script>
-/*
-better to descend from an id
+/* Title: Decending from id
+   Description: be more specific, better to descend from an id
 */
 
 // antipattern

diff --git a/jquery-patterns/detach.html b/jquery-patterns/detach.html
@@ -6,9 +6,10 @@
 </head>
 <body>
 <script>
-/* 
-take element off the DOM while manipulating them
+/* Title: detach
+   Description: take element off the DOM while manipulating them
 */
+
 var table = $('#some-table');
 var parent = table.parent();
 

diff --git a/jquery-patterns/event-delegation.html b/jquery-patterns/event-delegation.html
@@ -6,11 +6,16 @@
 </head>
 <body>
 <script>
+/* Title: event delegation
+   Description: event delegation pattern and antipattern
+*/
+
 // antipattern
 $('a.trigger', $('#container')[0]).live('click', handlerFn)
 
 // preferred
 $('#container').on('click', 'a.trigger', handlerFn)
+
 // reference
 // http://paulirish.com/2009/perf/
 </script>

diff --git a/jquery-patterns/left-and-right.html b/jquery-patterns/left-and-right.html
@@ -6,8 +6,8 @@
 </head>
 <body>
 <script>
-/*
-specific on the right, light on the left
+/* Title: Left and Right
+   Description: specific on the right, light on the left
 */
 
 // antipattern

diff --git a/jquery-patterns/requery.html b/jquery-patterns/requery.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: requery
+   Description: avoid requery by using jQuery chaining
+*/
+
 // antipattern
 // create and append your element
 $(document.body).append("<div class='baaron' />");

diff --git a/jquery-patterns/specific-when-needed.html b/jquery-patterns/specific-when-needed.html
@@ -6,8 +6,8 @@
 </head>
 <body>
 <script>
-/*
-no need to be over-specific
+/* Title: Be Specific when Needed
+   Description: no need to be over-specific
 */
 
 // antipattern

diff --git a/jquery-patterns/universal-selector.html b/jquery-patterns/universal-selector.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Universal Selector
+   Description: better use of universal selector
+*/
+
 // antipattern
 $('.buttons > *')
 // preferred

diff --git a/jquery-patterns/window-scroll-event.html b/jquery-patterns/window-scroll-event.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: window scroll event
+   Description: avoid attaching handlers to the window scroll event
+*/
+
 // antipattern 
 $(window).scroll(function() {
   $('.foo').something();