From 805d21c2360a10fa5e7ac85cc593b4403afb6c9f Mon Sep 17 00:00:00 2001 From: John Resig Date: Fri, 1 Sep 2006 02:43:54 +0000 Subject: [PATCH] Fixed two bugs with jQuery: One with height computation, one with .find(expr,fn) not working properly. Also, fixed a bunch of styling with the docs. Finally, added documentation for the $() function. --- build/docs/style/style.css | 11 +++- src/jquery/jquery.js | 106 ++++++++++++++++++++++++++++++++++++- 2 files changed, 113 insertions(+), 4 deletions(-) diff --git a/build/docs/style/style.css b/build/docs/style/style.css index 7c5554ece..f76e87ef9 100644 --- a/build/docs/style/style.css +++ b/build/docs/style/style.css @@ -63,6 +63,7 @@ ul#docs { ul#docs li { margin: 5px 0; + width: 600px; } ul#docs li span.tooltip { @@ -95,6 +96,7 @@ ul#docs li div.short { color: #666; margin-left: 110px; margin-top: 5px; + width: 490px; } ul#docs span.fn { @@ -110,21 +112,26 @@ ul#docs li div.more { display: none; margin-left: 110px; margin-top: 5px; + width: 490px; } ul#docs li div.example { overflow: auto; + border-top: 1px solid #DDD; + margin-top: 15px; } ul#docs li div.example h5 { font-size: 16px; + margin: 10px 0 0 0; } ul#docs li div.example pre { - color: #4F4; - background: #000; + color: #000; + background: #EEE; padding: 5px; overflow: auto; + font-size: 0.8em; } p.raw { diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js index f774658fa..c3975e302 100644 --- a/src/jquery/jquery.js +++ b/src/jquery/jquery.js @@ -71,6 +71,108 @@ function jQuery(a,c) { // Map over the $ in case of overwrite if ( typeof $ != "undefined" ) jQuery._$ = $; + +/** + * This function accepts a string containing a CSS selector, + * basic XPath, or raw HTML, which is then used to match a set of elements. + * The HTML string is different from the traditional selectors in that + * it creates the DOM elements representing that HTML string, on the fly, + * to be (assumedly) inserted into the document later. + * + * The core functionality of jQuery centers around this function. + * Everything in jQuery is based upon this, or uses this in some way. + * The most basic use of this function is to pass in an expression + * (usually consisting of CSS or XPath), which then finds all matching + * elements and remembers them for later use. + * + * By default, $() looks for DOM elements within the context of the + * current HTML document. + * + * @example $("div > p") + * @desc This finds all p elements that are children of a div element. + * @before

one

two

three

+ * @result [

two

] + * + * @example $("

Hello

").appendTo("#body") + * @desc Creates a div element (and all of its contents) dynamically, and appends it to the element with the ID of body. + * + * @name $ + * @param String expr An expression to search with, or a string of HTML to create on the fly. + * @cat Core + * @type jQuery + */ + +/** + * This function accepts a string containing a CSS selector, or + * basic XPath, which is then used to match a set of elements with the + * context of the specified DOM element, or document + * + * @example $("div", xml.responseXML) + * @desc This finds all div elements within the specified XML document. + * + * @name $ + * @param String expr An expression to search with. + * @param DOMElement context A DOM Element, or Document, representing the base context. + * @cat Core + * @type jQuery + */ + +/** + * Wrap jQuery functionality around a specific DOM Element. + * This function also accepts XML Documents and Window objects + * as valid arguments (even though they are not DOM Elements). + * + * @example $(document).find("div > p") + * @before

one

two

three

+ * @result [

two

] + * + * @example $(document).ready( loaded ); + * @desc Executes the "loaded" function when the DOM is ready to + * be manipulated. + * + * @name $ + * @param DOMElement elem A DOM element to be encapsulated by a jQuery object. + * @cat Core + * @type jQuery + */ + +/** + * Wrap jQuery functionality around a set of DOM Elements. + * + * @example $( myForm.elements ).hide() + * @desc Hides all the input elements within a form + * + * @name $ + * @param Array elems An array of DOM elements to be encapsulated by a jQuery object. + * @cat Core + * @type jQuery + */ + +/** + * A shorthand for $(document).ready(), allowing you to bind a function + * to be executed when the DOM document has finished loading. + * + * @example $( loaded ) + * @desc Executes the function "loaded" when the DOM is ready to be used. + * + * @name $ + * @param Function fn The function to execute when the DOM is ready. + * @cat Core + * @type jQuery + */ + +/** + * A means of creating a duplicate copy of a jQuery object. + * + * @example var div = $("div"); + * $( div ).find("p") + * @desc Locates all p elements with all div elements, without disrupting the original jQuery object contained in 'div'. + * + * @name $ + * @param jQuery obj The jQuery object to be cloned. + * @cat Core + * @type jQuery + */ // Map the jQuery namespace to the '$' one var $ = jQuery; @@ -766,7 +868,7 @@ jQuery.fn = jQuery.prototype = { var old = this.get(); this.get( a ); if ( fn.constructor == Function ) - return this.each( fn ); + this.each( fn ); this.get( old ); } @@ -926,7 +1028,7 @@ jQuery.extend({ } else { e = jQuery(e.cloneNode(true)).css({ visibility: "hidden", position: "absolute", display: "block" - }).prependTo("body")[0]; + }).appendTo(e.parentNode)[0]; oHeight = e.clientHeight; oWidth = e.clientWidth; -- 2.39.5