.text( String ) now works as you'd expect it to, plus it's much faster and smaller...
[jquery.git] / src / jquery / jquery.js
index 893a397..f6e2ade 100644 (file)
@@ -23,39 +23,41 @@ window.undefined = window.undefined;
  * @cat Core
  */
 var jQuery = function(a,c) {
+       // If the context is global, return a new object
+       if ( window == this )
+               return new jQuery(a,c);
+
        // Make sure that a selection was provided
        a = a || document;
        
+       // HANDLE: $(function)
        // Shortcut for document ready
        // Safari reports typeof on DOM NodeLists as a function
        if ( typeof a == "function" && !a.nodeType && a[0] == undefined )
-               return jQuery(document)[ jQuery.fn.ready ? "ready" : "load" ]( a );
-
-       // Watch for when a jQuery object is passed as the selector
-       if ( a.jquery )
-               return jQuery( jQuery.makeArray( a ) );
-
-       // Watch for when a jQuery object is passed at the context
-       if ( c && c.jquery )
-               return jQuery( c ).find(a);
-
-       // If the context is global, return a new object
-       if ( window == this )
-               return new jQuery(a,c);
-
+               return new jQuery(document)[ jQuery.fn.ready ? "ready" : "load" ]( a );
+       
        // Handle HTML strings
        if ( typeof a  == "string" ) {
+               // HANDLE: $(html) -> $(array)
                var m = /^[^<]*(<.+>)[^>]*$/.exec(a);
-               if ( m ) a = jQuery.clean( [ m[1] ] );
+               if ( m )
+                       a = jQuery.clean( [ m[1] ] );
+               
+               // HANDLE: $(expr)
+               else
+                       return new jQuery( c ).find( a );
        }
+       
+       return this.setArray(
+               // HANDLE: $(array)
+               a.constructor == Array && a ||
 
-       // Watch for when an array is passed in
-       return this.setArray( a.constructor == Array || a.length && a != window && !a.nodeType && a[0] != undefined && a[0].nodeType ?
-               // Assume that it is an array of DOM Elements
-               jQuery.makeArray( a ) :
+               // HANDLE: $(arraylike)
+               // Watch for when an array-like object is passed as the selector
+               (a.jquery || a.length && a != window && !a.nodeType && a[0] != undefined && a[0].nodeType) && jQuery.makeArray( a ) ||
 
-               // Find the matching elements and save them for later
-               jQuery.find( a, c ) );
+               // HANDLE: $(*)
+               [ a ] );
 };
 
 // Map over the $ in case of overwrite
@@ -365,7 +367,7 @@ jQuery.fn = jQuery.prototype = {
         * @name attr
         * @type Object
         * @param String name The name of the property to access.
-        * @cat DOM
+        * @cat DOM/Attributes
         */
 
        /**
@@ -382,12 +384,14 @@ jQuery.fn = jQuery.prototype = {
         * @name attr
         * @type jQuery
         * @param Map properties Key/value pairs to set as object properties.
-        * @cat DOM
+        * @cat DOM/Attributes
         */
 
        /**
         * Set a single property to a value, on all matched elements.
         *
+        * Can compute values provided as ${formula}, see second example.
+        *
         * Note that you can't set the name property of input elements in IE.
         * Use $(html) or .append(html) or .html(html) to create elements
         * on the fly including the name property.
@@ -397,11 +401,33 @@ jQuery.fn = jQuery.prototype = {
         * @result <img src="test.jpg"/>
         * @desc Sets src attribute to all images.
         *
+        * @example $("img").attr("title", "${this.src}");
+        * @before <img src="test.jpg" />
+        * @result <img src="test.jpg" title="test.jpg" />
+        * @desc Sets title attribute from src attribute, a shortcut for attr(String,Function)
+        *
         * @name attr
         * @type jQuery
         * @param String key The name of the property to set.
         * @param Object value The value to set the property to.
-        * @cat DOM
+        * @cat DOM/Attributes
+        */
+        
+       /**
+        * Set a single property to a computed value, on all matched elements.
+        *
+        * Instead of a value, a function is provided, that computes the value.
+        *
+        * @example $("img").attr("title", function() { return this.src });
+        * @before <img src="test.jpg" />
+        * @result <img src="test.jpg" title="test.jpg" />
+        * @desc Sets title attribute from src attribute.
+        *
+        * @name attr
+        * @type jQuery
+        * @param String key The name of the property to set.
+        * @param Function value A function returning the value to set.
+        * @cat DOM/Attributes
         */
        attr: function( key, value, type ) {
                // Check to see if we're setting style values
@@ -413,14 +439,14 @@ jQuery.fn = jQuery.prototype = {
                                        for ( var prop in key )
                                                jQuery.attr(
                                                        type ? this.style : this,
-                                                       prop, key[prop]
+                                                       prop, jQuery.prop(this, prop, key[prop], type)
                                                );
 
                                // See if we're setting a single key/value style
                                else
                                        jQuery.attr(
                                                type ? this.style : this,
-                                               key, value
+                                               key, jQuery.prop(this, key, value, type)
                                        );
                        }) :
 
@@ -496,14 +522,21 @@ jQuery.fn = jQuery.prototype = {
         *
         * @name text
         * @type String
-        * @cat DOM
+        * @cat DOM/Attributes
         */
 
        /**
-        * Set the text contents of all matched elements. This has the same
-        * effect as html().
+        * Set the text contents of all matched elements.
         *
-        * @example $("p").text("Some new text.");
+        * Similar to html(), but escapes HTML (replace "<" and ">" with their
+        * HTML entities).
+        *
+        * @example $("p").text("<b>Some</b> new text.");
+        * @before <p>Test Paragraph.</p>
+        * @result <p>&lt;b&gt;Some&lt;/b&gt; new text.</p>
+        * @desc Sets the text of all paragraphs.
+        *
+        * @example $("p").text("<b>Some</b> new text.", true);
         * @before <p>Test Paragraph.</p>
         * @result <p>Some new text.</p>
         * @desc Sets the text of all paragraphs.
@@ -511,24 +544,15 @@ jQuery.fn = jQuery.prototype = {
         * @name text
         * @type String
         * @param String val The text value to set the contents of the element to.
-        * @cat DOM
+        * @cat DOM/Attributes
         */
        text: function(e) {
-               // A surprisingly high number of people expect the
-               // .text() method to do this, so lets do it!
-               if ( typeof e == "string" )
-                       return this.html( e );
-
-               e = e || this;
-               var t = "";
-               for ( var j = 0, el = e.length; j < el; j++ ) {
-                       var r = e[j].childNodes;
-                       for ( var i = 0, rl = r.length; i < rl; i++ )
-                               if ( r[i].nodeType != 8 )
-                                       t += r[i].nodeType != 1 ?
-                                               r[i].nodeValue : jQuery.fn.text([ r[i] ]);
-               }
-               return t;
+               var type = this.length && this[0].innerText == undefined ?
+                       "textContent" : "innerText";
+                       
+               return e == undefined ?
+                       this.length && this[0][ type ] :
+                       this.each(function(){ this[ type ] = e; });
        },
 
        /**
@@ -742,7 +766,7 @@ jQuery.fn = jQuery.prototype = {
         * @example $("p").find("span").end();
         * @before <p><span>Hello</span>, how are you?</p>
         * @result [ <p>...</p> ]
-        * desc Selects all paragraphs, finds span elements inside these, and reverts the
+        * @desc Selects all paragraphs, finds span elements inside these, and reverts the
         * selection back to the paragraphs.
         *
         * @name end
@@ -1098,7 +1122,7 @@ jQuery.fn = jQuery.prototype = {
  * @param Object prop1 The object that will be merged into the first.
  * @param Object propN (optional) More objects to merge into the first
  * @type Object
- * @cat Javascript
+ * @cat JavaScript
  */
 jQuery.extend = jQuery.fn.extend = function() {
        // copy reference to target object
@@ -1130,28 +1154,32 @@ jQuery.extend({
         * using the 'jQuery' variable. For example, where you used to do
         * $("div p"), you now must do jQuery("div p").
         *
-        * @example $.noConflict();
+        * @example jQuery.noConflict();
+        * // Do something with jQuery
+        * jQuery("div p").hide();
+        * // Do something with another library's $()
+        * $("content").style.display = 'none';
         * @desc Maps the original object that was referenced by $ back to $
         *
-        * @example $.noConflict();
+        * @example jQuery.noConflict();
         * (function($) { 
         *   $(function() {
         *     // more code using $ as alias to jQuery
         *   });
         * })(jQuery);
-        * // other code using $ as an alias to the original implementation (not jQuery)
+        * // other code using $ as an alias to the other library
         * @desc Reverts the $ alias and then creates and executes a
         * function to provide the $ as a jQuery alias inside the functions
         * scope. Inside the function the original $ object is not available.
         * This works well for most plugins that don't rely on any other library.
         * 
         *
-        * @name noConflict
+        * @name $.noConflict
         * @type undefined
         * @cat Core 
         */
        noConflict: function() {
-               if(jQuery._$)
+               if ( jQuery._$ )
                        $ = jQuery._$;
        },
 
@@ -1161,21 +1189,27 @@ jQuery.extend({
         * as $().each() - which is used to iterate, exclusively, over a jQuery
         * object. This function can be used to iterate over anything.
         *
-        * @example $.each( [0,1,2], function(i){
-        *   alert( "Item #" + i + ": " + this );
+        * The callback has two arguments:the key (objects) or index (arrays) as first
+        * the first, and the value as the second.
+        *
+        * @example $.each( [0,1,2], function(i, n){
+        *   alert( "Item #" + i + ": " + n );
         * });
-        * @desc Iterates over the items in an array, accessing both the current item and its index.
+        * @desc This is an example of iterating over the items in an array,
+        * accessing both the current item and its index.
         *
-        * @example $.each( { name: "John", lang: "JS" }, function(i){
-        *   alert( "Name: " + i + ", Value: " + this );
+        * @example $.each( { name: "John", lang: "JS" }, function(i, n){
+        *   alert( "Name: " + i + ", Value: " + n );
         * });
-        * @desc Iterates over the properties in an Object, accessing both the current item and its key.
+        *
+        * @desc This is an example of iterating over the properties in an
+        * Object, accessing both the current item and its key.
         *
         * @name $.each
         * @param Object obj The object, or array, to iterate over.
         * @param Function fn The function that will be executed on every object.
         * @type Object
-        * @cat Javascript
+        * @cat JavaScript
         */
        // args is for internal usage only
        each: function( obj, fn, args ) {
@@ -1187,6 +1221,12 @@ jQuery.extend({
                                if ( fn.apply( obj[i], args || [i, obj[i]] ) === false ) break;
                return obj;
        },
+       
+       prop: function(elem, key, value){
+               // Handle executable functions
+               return value.constructor == Function &&
+                       value.call( elem ) || value;
+       },
 
        className: {
                add: function( elem, c ){
@@ -1416,7 +1456,7 @@ jQuery.extend({
         * @name $.trim
         * @type String
         * @param String str The string to trim.
-        * @cat Javascript
+        * @cat JavaScript
         */
        trim: function(t){
                return t.replace(/^\s+|\s+$/g, "");
@@ -1459,7 +1499,7 @@ jQuery.extend({
         * @type Array
         * @param Array first The first array to merge.
         * @param Array second The second array to merge.
-        * @cat Javascript
+        * @cat JavaScript
         */
        merge: function(first, second) {
                var r = [].slice.call( first, 0 );
@@ -1494,7 +1534,7 @@ jQuery.extend({
         * @param Array array The Array to find items in.
         * @param Function fn The function to process each item against.
         * @param Boolean inv Invert the selection - select the opposite of the function.
-        * @cat Javascript
+        * @cat JavaScript
         */
        grep: function(elems, fn, inv) {
                // If a string is passed in for the function, make a function
@@ -1548,7 +1588,7 @@ jQuery.extend({
         * @type Array
         * @param Array array The Array to translate.
         * @param Function fn The function to process each item against.
-        * @cat Javascript
+        * @cat JavaScript
         */
        map: function(elems, fn) {
                // If a string is passed in for the function, make a function
@@ -1569,7 +1609,7 @@ jQuery.extend({
                        }
                }
 
-               var r = [ result[0] ];
+               var r = result.length ? [ result[0] ] : [];
 
                check: for ( var i = 1, rl = result.length; i < rl; i++ ) {
                        for ( var j = 0; j < i; j++ )
@@ -1604,7 +1644,7 @@ jQuery.extend({
  * @property
  * @name $.browser
  * @type Boolean
- * @cat Javascript
+ * @cat JavaScript
  */
  
 /*
@@ -1613,7 +1653,7 @@ jQuery.extend({
  * @property
  * @name $.boxModel
  * @type Boolean
- * @cat Javascript
+ * @cat JavaScript
  */
 new function() {
        var b = navigator.userAgent.toLowerCase();
@@ -1874,7 +1914,7 @@ jQuery.each({
  * @name removeAttr
  * @type jQuery
  * @param String name The name of the attribute to remove.
- * @cat DOM
+ * @cat DOM/Attributes
  */
 
 /**
@@ -1931,7 +1971,7 @@ jQuery.each({
  * @name addClass
  * @type jQuery
  * @param String class A CSS class to add to the elements
- * @cat DOM
+ * @cat DOM/Attributes
  * @see removeClass(String)
  */
 
@@ -1949,7 +1989,7 @@ jQuery.each({
  * @name removeClass
  * @type jQuery
  * @param String class (optional) A CSS class to remove from the elements
- * @cat DOM
+ * @cat DOM/Attributes
  * @see addClass(String)
  */
 
@@ -1964,7 +2004,7 @@ jQuery.each({
  * @name toggleClass
  * @type jQuery
  * @param String class A CSS class with which to toggle the elements
- * @cat DOM
+ * @cat DOM/Attributes
  */
 
 /**
@@ -2102,4 +2142,4 @@ jQuery.each( [ "eq", "lt", "gt", "contains" ], function(i,n){
        jQuery.fn[ n ] = function(num,fn) {
                return this.filter( ":" + n + "(" + num + ")", fn );
        };
-});
\ No newline at end of file
+});