* @constructor
* @private
* @name jQuery
+ * @param String|Function|Element|Array<Element>|jQuery a selector
+ * @param jQuery|Element|Array<Element> c context
* @cat Core
*/
var jQuery = function(a,c) {
* current HTML document.
*
* @example $("div > p")
- * @desc This finds all p elements that are children of a div element.
+ * @desc Finds all p elements that are children of a div element.
* @before <p>one</p> <div><p>two</p></div> <p>three</p>
* @result [ <p>two</p> ]
*
*
* @name $
* @param String expr An expression to search with
- * @param Element context (optional) A DOM Element, or Document, representing the base context.
+ * @param Element|jQuery context (optional) A DOM Element, Document or jQuery to use as context
* @cat Core
* @type jQuery
* @see $(Element)
*/
/**
- * This function accepts a string of raw HTML.
- *
- * 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.
+ * Create DOM elements on-the-fly from the provided String of raw HTML.
*
* @example $("<div><p>Hello</p></div>").appendTo("#body")
* @desc Creates a div element (and all of its contents) dynamically,
* @param String html A string of HTML to create on the fly.
* @cat Core
* @type jQuery
+ * @see appendTo(String)
*/
/**
- * Wrap jQuery functionality around a specific DOM Element.
+ * Wrap jQuery functionality around a single or multiple DOM Element(s).
+ *
* 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 <p>one</p> <div><p>two</p></div> <p>three</p>
* @result [ <p>two</p> ]
+ * @desc Same as $("div > p") because the document
*
* @example $(document.body).background( "black" );
* @desc Sets the background color of the page to black.
*
- * @name $
- * @param Element 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<Element> elems An array of DOM elements to be encapsulated by a jQuery object.
+ * @param Element|Array<Element> elems DOM element(s) to be encapsulated by a jQuery object.
* @cat Core
* @type jQuery
*/
* @example $("img").get();
* @before <img src="test1.jpg"/> <img src="test2.jpg"/>
* @result [ <img src="test1.jpg"/> <img src="test2.jpg"/> ]
+ * @desc Selects all images in the document and returns the DOM Elements as an Array
*
* @name get
* @type Array<Element>
* Access a single matched element. num is used to access the
* Nth element matched.
*
- * @example $("img").get(1);
+ * @example $("img").get(0);
* @before <img src="test1.jpg"/> <img src="test2.jpg"/>
* @result [ <img src="test1.jpg"/> ]
+ * @desc Selects all images in the document and returns the first one
*
* @name get
* @type Element
* @example $("img").each(function(i){
* this.src = "test" + i + ".jpg";
* });
- * @before <img/> <img/>
- * @result <img src="test0.jpg"/> <img src="test1.jpg"/>
+ * @before <img/><img/>
+ * @result <img src="test0.jpg"/><img src="test1.jpg"/>
* @desc Iterates over two images and sets their src property
*
* @name each
* the index of the element, if found, starting with zero.
* Returns -1 if the object wasn't found.
*
- * @example $("*").index(document.getElementById('foobar'))
+ * @example $("*").index( $('#foobar')[0] )
* @before <div id="foobar"></div><b></b><span id="foo"></span>
* @result 0
+ * @desc Returns the index for the element with ID foobar
*
- * @example $("*").index(document.getElementById('foo'))
+ * @example $("*").index( $('#foo'))
* @before <div id="foobar"></div><b></b><span id="foo"></span>
* @result 2
+ * @desc Returns the index for the element with ID foo
*
- * @example $("*").index(document.getElementById('bar'))
+ * @example $("*").index( $('#bar'))
* @before <div id="foobar"></div><b></b><span id="foo"></span>
* @result -1
+ * @desc Returns -1, as there is no element with ID bar
*
* @name index
* @type Number
- * @param Object obj Object to search for
+ * @param Element subject Object to search for
* @cat Core
*/
index: function( obj ) {
* @example $("img").attr("src");
* @before <img src="test.jpg"/>
* @result test.jpg
+ * @desc Returns the src attribute from the first image in the document.
*
* @name attr
* @type Object
* @param String name The name of the property to access.
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
- * Set a hash of key/value object properties to all matched elements.
+ * Set a key/value object as properties to all matched elements.
+ *
* This serves as the best way to set a large number of properties
* on all matched elements.
*
* @example $("img").attr({ src: "test.jpg", alt: "Test Image" });
* @before <img/>
* @result <img src="test.jpg" alt="Test Image"/>
+ * @desc Sets src and alt attributes to all images.
*
* @name attr
* @type jQuery
- * @param Hash prop A set of key/value pairs to set as object properties.
- * @cat DOM
+ * @param Map properties Key/value pairs to set as object properties.
+ * @cat DOM/Attributes
*/
/**
* Set a single property to a value, on all matched elements.
*
* 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
+ * Use $(html) or .append(html) or .html(html) to create elements
* on the fly including the name property.
*
* @example $("img").attr("src","test.jpg");
* @before <img/>
* @result <img src="test.jpg"/>
+ * @desc Sets src attribute to all images.
*
* @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
*/
attr: function( key, value, type ) {
// Check to see if we're setting style values
*
* @example $("p").css("color");
* @before <p style="color:red;">Test Paragraph.</p>
- * @result red
+ * @result "red"
* @desc Retrieves the color style of the first paragraph
*
- * @example $("p").css("fontWeight");
+ * @example $("p").css("font-weight");
* @before <p style="font-weight: bold;">Test Paragraph.</p>
- * @result bold
+ * @result "bold"
* @desc Retrieves the font-weight style of the first paragraph.
- * Note that for all style properties with a dash (like 'font-weight'), you have to
- * write it in camelCase. In other words: Every time you have a '-' in a
- * property, remove it and replace the next character with an uppercase
- * representation of itself. Eg. fontWeight, fontSize, fontFamily, borderWidth,
- * borderStyle, borderBottomWidth etc.
*
* @name css
- * @type Object
+ * @type String
* @param String name The name of the property to access.
* @cat CSS
*/
/**
- * Set a hash of key/value style properties to all matched elements.
+ * Set a key/value object as style properties to all matched elements.
+ *
* This serves as the best way to set a large number of style properties
* on all matched elements.
*
* @example $("p").css({ color: "red", background: "blue" });
* @before <p>Test Paragraph.</p>
* @result <p style="color:red; background:blue;">Test Paragraph.</p>
+ * @desc Sets color and background styles to all p elements.
*
* @name css
* @type jQuery
- * @param Hash prop A set of key/value pairs to set as style properties.
+ * @param Map properties Key/value pairs to set as style properties.
* @cat CSS
*/
},
/**
- * Retrieve the text contents of all matched elements. The result is
+ * Get the text contents of all matched elements. The result is
* a string that contains the combined text contents of all matched
* elements. This method works on both HTML and XML documents.
*
* @example $("p").text();
- * @before <p>Test Paragraph.</p>
- * @result Test Paragraph.
+ * @before <p><b>Test</b> Paragraph.</p><p>Paraparagraph</p>
+ * @result Test Paragraph.Paraparagraph
+ * @desc Gets the concatenated text of all paragraphs
*
* @name text
* @type String
- * @cat DOM
+ * @cat DOM/Attributes
*/
/**
* Set the text contents of all matched elements. This has the same
- * effect as calling .html() with your specified string.
+ * effect as html().
*
* @example $("p").text("Some new text.");
* @before <p>Test Paragraph.</p>
* @result <p>Some new text.</p>
- *
- * @param String val The text value to set the contents of the element to.
+ * @desc Sets the text of all paragraphs.
*
* @name text
* @type String
- * @cat DOM
+ * @param String val The text value to set the contents of the element to.
+ * @cat DOM/Attributes
*/
text: function(e) {
// A surprisingly high number of people expect the
*
* @name wrap
* @type jQuery
- * @param Element elem A DOM element that will be wrapped.
+ * @param Element elem A DOM element that will be wrapped around the target.
* @cat DOM/Manipulation
*/
wrap: function() {
* @example $("p").append("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <p>I would like to say: <b>Hello</b></p>
+ * @desc Appends some HTML to all paragraphs.
*
* @example $("p").append( $("#foo")[0] );
* @before <p>I would like to say: </p><b id="foo">Hello</b>
* @result <p>I would like to say: <b id="foo">Hello</b></p>
+ * @desc Appends an Element to all paragraphs.
*
* @example $("p").append( $("b") );
* @before <p>I would like to say: </p><b>Hello</b>
* @result <p>I would like to say: <b>Hello</b></p>
+ * @desc Appends a jQuery object (similar to an Array of DOM Elements) to all paragraphs.
*
* @name append
* @type jQuery
* @example $("p").prepend("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <p><b>Hello</b>I would like to say: </p>
+ * @desc Prepends some HTML to all paragraphs.
*
* @example $("p").prepend( $("#foo")[0] );
* @before <p>I would like to say: </p><b id="foo">Hello</b>
* @result <p><b id="foo">Hello</b>I would like to say: </p>
+ * @desc Prepends an Element to all paragraphs.
*
* @example $("p").prepend( $("b") );
* @before <p>I would like to say: </p><b>Hello</b>
* @result <p><b>Hello</b>I would like to say: </p>
+ * @desc Prepends a jQuery object (similar to an Array of DOM Elements) to all paragraphs.
*
* @name prepend
* @type jQuery
* @example $("p").before("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <b>Hello</b><p>I would like to say: </p>
+ * @desc Inserts some HTML before all paragraphs.
*
* @example $("p").before( $("#foo")[0] );
* @before <p>I would like to say: </p><b id="foo">Hello</b>
* @result <b id="foo">Hello</b><p>I would like to say: </p>
+ * @desc Inserts an Element before all paragraphs.
*
* @example $("p").before( $("b") );
* @before <p>I would like to say: </p><b>Hello</b>
* @result <b>Hello</b><p>I would like to say: </p>
+ * @desc Inserts a jQuery object (similar to an Array of DOM Elements) before all paragraphs.
*
* @name before
* @type jQuery
* @example $("p").after("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <p>I would like to say: </p><b>Hello</b>
+ * @desc Inserts some HTML after all paragraphs.
*
* @example $("p").after( $("#foo")[0] );
* @before <b id="foo">Hello</b><p>I would like to say: </p>
* @result <p>I would like to say: </p><b id="foo">Hello</b>
+ * @desc Inserts an Element after all paragraphs.
*
* @example $("p").after( $("b") );
* @before <b>Hello</b><p>I would like to say: </p>
* @result <p>I would like to say: </p><b>Hello</b>
+ * @desc Inserts a jQuery object (similar to an Array of DOM Elements) after all paragraphs.
*
* @name after
* @type jQuery
*
* @example $("p").find("span").end();
* @before <p><span>Hello</span>, how are you?</p>
- * @result $("p").find("span").end() == [ <p>...</p> ]
+ * @result [ <p>...</p> ]
+ * desc Selects all paragraphs, finds span elements inside these, and reverts the
+ * selection back to the paragraphs.
*
* @name end
* @type jQuery
/**
* Searches for all elements that match the specified expression.
- * This method is the optimal way of finding additional descendant
+
+ * This method is a good way to find additional descendant
* elements with which to process.
*
* All searching is done using a jQuery expression. The expression can be
*
* @example $("p").find("span");
* @before <p><span>Hello</span>, how are you?</p>
- * @result $("p").find("span") == [ <span>Hello</span> ]
+ * @result [ <span>Hello</span> ]
+ * @desc Starts with all paragraphs and searches for descendant span
+ * elements, same as $("p span")
*
* @name find
* @type jQuery
},
/**
- * Create cloned copies of all matched DOM Elements. This does
- * not create a cloned copy of this particular jQuery object,
- * instead it creates duplicate copies of all DOM Elements.
+ * Clone matched DOM Elements and select the clones.
+ *
* This is useful for moving copies of the elements to another
* location in the DOM.
*
* @example $("b").clone().prependTo("p");
* @before <b>Hello</b><p>, how are you?</p>
* @result <b>Hello</b><p><b>Hello</b>, how are you?</p>
+ * @desc Clones all b elements (and selects the clones) and prepends them to all paragraphs.
*
* @name clone
* @type jQuery
/**
* Removes all elements from the set of matched elements that do not
- * match the specified expression. This method is used to narrow down
+ * match the specified expression(s). This method is used to narrow down
* the results of a search.
*
- * All searching is done using a jQuery expression. The expression
- * can be written using CSS 1-3 Selector syntax, or basic XPath.
+ * Provide a String array of expressions to apply multiple filters at once.
*
* @example $("p").filter(".selected")
* @before <p class="selected">Hello</p><p>How are you?</p>
* @result [ <p class="selected">Hello</p> ]
+ * @desc Selects all paragraphs and removes those without a class "selected".
+ *
+ * @example $("p").filter([".selected", ":first"])
+ * @before <p>Hello</p><p>Hello Again</p><p class="selected">And Again</p>
+ * @result [ <p>Hello</p>, <p class="selected">And Again</p> ]
+ * @desc Selects all paragraphs and removes those without class "selected" and being the first one.
*
* @name filter
* @type jQuery
- * @param String expr An expression to search with.
+ * @param String|Array<String> expression Expression(s) to search with.
* @cat DOM/Traversing
*/
* pass the specified filter. This method is used to narrow down
* the results of a search.
*
- * The elements to filter are passed as the first argument, their
- * index inside the set as the second.
- *
- * @example $("p").filter(function(element, index) {
- * return $("ol", element).length == 0;
+ * @example $("p").filter(function(index) {
+ * return $("ol", this).length == 0;
* })
* @before <p><ol><li>Hello</li></ol></p><p>How are you?</p>
* @result [ <p>How are you?</p> ]
* @param Function filter A function to use for filtering
* @cat DOM/Traversing
*/
-
- /**
- * Removes all elements from the set of matched elements that do not
- * match at least one of the expressions passed to the function. This
- * method is used when you want to filter the set of matched elements
- * through more than one expression.
- *
- * Elements will be retained in the jQuery object if they match at
- * least one of the expressions passed.
- *
- * @example $("p").filter([".selected", ":first"])
- * @before <p>Hello</p><p>Hello Again</p><p class="selected">And Again</p>
- * @result [ <p>Hello</p>, <p class="selected">And Again</p> ]
- *
- * @name filter
- * @type jQuery
- * @param Array<String> exprs A set of expressions to evaluate against
- * @cat DOM/Traversing
- */
filter: function(t) {
return this.set(
t.constructor == Array &&
( t ? this.get() : [] ) ||
typeof t == "function" &&
- jQuery.grep( this, t ) ||
+ jQuery.grep( this, function(el, index) { return t.apply(el, [index]) }) ||
jQuery.filter(t,this).r );
},
* Removes the specified Element from the set of matched elements. This
* method is used to remove a single Element from a jQuery object.
*
- * @example $("p").not( document.getElementById("selected") )
+ * @example $("p").not( $("#selected")[0] )
* @before <p>Hello</p><p id="selected">Hello Again</p>
* @result [ <p>Hello</p> ]
+ * @desc Removes the element with the ID "selected" from the set of all paragraphs.
*
* @name not
* @type jQuery
* @example $("p").not("#selected")
* @before <p>Hello</p><p id="selected">Hello Again</p>
* @result [ <p>Hello</p> ]
+ * @desc Removes the element with the ID "selected" from the set of all paragraphs.
*
* @name not
* @type jQuery
*/
/**
- * Adds each of the Elements in the array to the set of matched elements.
- * This is used to add a set of Elements to a jQuery object.
+ * Adds one or more Elements to the set of matched elements.
*
- * @example $("p").add([document.getElementById("a"), document.getElementById("b")])
- * @before <p>Hello</p><p><span id="a">Hello Again</span><span id="b">And Again</span></p>
- * @result [ <p>Hello</p>, <span id="a">Hello Again</span>, <span id="b">And Again</span> ]
- *
- * @name add
- * @type jQuery
- * @param Array<Element> els An array of Elements to add
- * @cat DOM/Traversing
- */
-
- /**
- * Adds a single Element to the set of matched elements. This is used to
- * add a single Element to a jQuery object.
+ * This is used to add a set of Elements to a jQuery object.
*
* @example $("p").add( document.getElementById("a") )
* @before <p>Hello</p><p><span id="a">Hello Again</span></p>
* @result [ <p>Hello</p>, <span id="a">Hello Again</span> ]
*
+ * @example $("p").add([document.getElementById("a"), document.getElementById("b")])
+ * @before <p>Hello</p><p><span id="a">Hello Again</span><span id="b">And Again</span></p>
+ * @result [ <p>Hello</p>, <span id="a">Hello Again</span>, <span id="b">And Again</span> ]
+ *
* @name add
* @type jQuery
- * @param Element el An Element to add
+ * @param Element|Array<Element> elements One or more Elements to add
* @cat DOM/Traversing
*/
add: function(t) {
/**
* Checks the current selection against an expression and returns true,
* if at least one element of the selection fits the given expression.
+ *
* Does return false, if no element fits or the expression is not valid.
*
+ * filter(String) is used internally, therefore all rules that apply there
+ * apply here, too.
+ *
* @example $("input[@type='checkbox']").parent().is("form")
* @before <form><input type="checkbox" /></form>
* @result true
* @result false
* @desc Returns false, because the parent of the input is a p element
*
- * @example $("form").is(null)
- * @before <form></form>
- * @result false
- * @desc An invalid expression always returns false.
- *
* @name is
* @type Boolean
* @param String expr The expression with which to filter
},
/**
+ * Get the current value of the first matched element.
+ *
+ * @example $("input").val();
+ * @before <input type="text" value="some text"/>
+ * @result "some text"
+ *
+ * @name val
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the value of every matched element.
+ *
+ * @example $("input").val("test");
+ * @before <input type="text" value="some text"/>
+ * @result <input type="text" value="test"/>
+ *
+ * @name val
+ * @type jQuery
+ * @param String val Set the property to the specified value.
+ * @cat DOM/Attributes
+ */
+ val: function( val ) {
+ return val == undefined ?\r ( this.length ? this[0].value : null ) :\r this.attr( "value", val );
+ },
+
+ /**
+ * Get the html contents of the first matched element.
+ * This property is not available on XML documents.
+ *
+ * @example $("div").html();
+ * @before <div><input/></div>
+ * @result <input/>
+ *
+ * @name html
+ * @type String
+ * @cat DOM/Attributes
+ */
+
+ /**
+ * Set the html contents of every matched element.
+ * This property is not available on XML documents.
+ *
+ * @example $("div").html("<b>new stuff</b>");
+ * @before <div><input/></div>
+ * @result <div><b>new stuff</b></div>
+ *
+ * @name html
+ * @type jQuery
+ * @param String val Set the html contents to the specified value.
+ * @cat DOM/Attributes
+ */
+ html: function( val ) {
+ return val == undefined ?\r ( this.length ? this[0].innerHTML : null ) :\r this.attr( "innerHTML", val );
+ },
+
+ /**
* @private
* @name domManip
* @param Array args
* @example jQuery.fn.extend({
* check: function() {
* return this.each(function() { this.checked = true; });
- * ),
+ * },
* uncheck: function() {
* return this.each(function() { this.checked = false; });
* }
* @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
jQuery.extend({
/**
- * @private
- * @name init
+ * Run this function to give control of the $ variable back
+ * to whichever library first implemented it. This helps to make
+ * sure that jQuery doesn't conflict with the $ object
+ * of other libraries.
+ *
+ * By using this function, you will only be able to access jQuery
+ * using the 'jQuery' variable. For example, where you used to do
+ * $("div p"), you now must do jQuery("div p").
+ *
+ * @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 jQuery.noConflict();
+ * (function($) {
+ * $(function() {
+ * // more code using $ as alias to jQuery
+ * });
+ * })(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
* @type undefined
- * @cat Core
+ * @cat Core
*/
- init: function(){
- jQuery.initDone = true;
-
- jQuery.each( jQuery.macros.axis, function(i,n){
- jQuery.fn[ i ] = function(a) {
- var ret = jQuery.map(this,n);
- if ( a && typeof a == "string" )
- ret = jQuery.filter(a,ret).r;
- return this.set( ret );
- };
- });
-
- jQuery.each( jQuery.macros.to, function(i,n){
- jQuery.fn[ i ] = function(){
- var a = arguments;
- return this.each(function(){
- for ( var j = 0, al = a.length; j < al; j++ )
- jQuery(a[j])[n]( this );
- });
- };
- });
-
- jQuery.each( jQuery.macros.each, function(i,n){
- jQuery.fn[ i ] = function() {
- return this.each( n, arguments );
- };
- });
-
- jQuery.each( jQuery.macros.filter, function(i,n){
- jQuery.fn[ n ] = function(num,fn) {
- return this.filter( ":" + n + "(" + num + ")", fn );
- };
- });
-
- jQuery.each( jQuery.macros.attr, function(i,n){
- n = n || i;
- jQuery.fn[ i ] = function(h) {
- return h == undefined ?
- this.length ? this[0][n] : null :
- this.attr( n, h );
- };
- });
-
- jQuery.each( jQuery.macros.css, function(i,n){
- jQuery.fn[ n ] = function(h) {
- return h == undefined ?
- ( this.length ? jQuery.css( this[0], n ) : null ) :
- this.css( n, h );
- };
- });
-
+ noConflict: function() {
+ if ( jQuery._$ )
+ $ = jQuery._$;
},
/**
* @example $.each( [0,1,2], function(i){
* alert( "Item #" + i + ": " + this );
* });
- * @desc This is an example of iterating over the items in an array, accessing both the current item and its index.
+ * @desc Iterates 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 );
* });
- * @desc This is an example of iterating over the properties in an Object, accessing both the current item and its key.
+ * @desc Iterates 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 ) {
* @name $.trim
* @type String
* @param String str The string to trim.
- * @cat Javascript
+ * @cat JavaScript
*/
trim: function(t){
return t.replace(/^\s+|\s+$/g, "");
},
/**
- * Merge two arrays together, removing all duplicates. The final order
- * or the new array is: All the results from the first array, followed
+ * Merge two arrays together, removing all duplicates.
+ *
+ * The new array is: All the results from the first array, followed
* by the unique results from the second array.
*
* @example $.merge( [0,1,2], [2,3,4] )
* @result [0,1,2,3,4]
+ * @desc Merges two arrays, removing the duplicate 2
*
* @example $.merge( [3,2,1], [4,3,2] )
* @result [3,2,1,4]
+ * @desc Merges two arrays, removing the duplicates 3 and 2
*
* @name $.merge
* @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 );
/**
* Filter items out of an array, by using a filter function.
+ *
* The specified function will be passed two arguments: The
* current array item and the index of the item in the array. The
- * function should return 'true' if you wish to keep the item in
- * the array, false if it should be removed.
+ * function must return 'true' to keep the item in the array,
+ * false to remove it.
*
* @example $.grep( [0,1,2], function(i){
* return i > 0;
* @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
},
/**
- * Translate all items in an array to another array of items.
+ * Translate all items in an array to another array of items.
+ *
* The translation function that is provided to this method is
* called for each item in the array and is passed one argument:
- * The item to be translated. The function can then return:
- * The translated value, 'null' (to remove the item), or
- * an array of values - which will be flattened into the full array.
+ * The item to be translated.
+ *
+ * The function can then return the translated value, 'null'
+ * (to remove the item), or an array of values - which will
+ * be flattened into the full array.
*
* @example $.map( [0,1,2], function(i){
* return i + 4;
* });
* @result [4, 5, 6]
+ * @desc Maps the original array to a new one and adds 4 to each value.
*
* @example $.map( [0,1,2], function(i){
* return i > 0 ? i + 1 : null;
* });
* @result [2, 3]
+ * @desc Maps the original array to a new one and adds 1 to each
+ * value if it is bigger then zero, otherwise it's removed-
*
* @example $.map( [0,1,2], function(i){
* return [ i, i + 1 ];
* });
* @result [0, 1, 1, 2, 2, 3]
+ * @desc Maps the original array to a new one, each element is added
+ * with it's original value and the value plus one.
*
* @name $.map
* @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
/**
* Contains flags for the useragent, read from navigator.userAgent.
* Available flags are: safari, opera, msie, mozilla
+ *
* This property is available before the DOM is ready, therefore you can
* use it to add ready events only for certain browsers.
*
* @property
* @name $.browser
* @type Boolean
- * @cat Javascript
+ * @cat JavaScript
*/
/*
* @property
* @name $.boxModel
* @type Boolean
- * @cat Javascript
+ * @cat JavaScript
*/
new function() {
var b = navigator.userAgent.toLowerCase();
jQuery.boxModel = !jQuery.browser.msie || document.compatMode == "CSS1Compat";
};
-jQuery.macros = {
- to: {
- /**
- * Append all of the matched elements to another, specified, set of elements.
- * This operation is, essentially, the reverse of doing a regular
- * $(A).append(B), in that instead of appending B to A, you're appending
- * A to B.
- *
- * @example $("p").appendTo("#foo");
- * @before <p>I would like to say: </p><div id="foo"></div>
- * @result <div id="foo"><p>I would like to say: </p></div>
- *
- * @name appendTo
- * @type jQuery
- * @param String expr A jQuery expression of elements to match.
- * @cat DOM/Manipulation
- */
- appendTo: "append",
-
- /**
- * Prepend all of the matched elements to another, specified, set of elements.
- * This operation is, essentially, the reverse of doing a regular
- * $(A).prepend(B), in that instead of prepending B to A, you're prepending
- * A to B.
- *
- * @example $("p").prependTo("#foo");
- * @before <p>I would like to say: </p><div id="foo"><b>Hello</b></div>
- * @result <div id="foo"><p>I would like to say: </p><b>Hello</b></div>
- *
- * @name prependTo
- * @type jQuery
- * @param String expr A jQuery expression of elements to match.
- * @cat DOM/Manipulation
- */
- prependTo: "prepend",
-
- /**
- * Insert all of the matched elements before another, specified, set of elements.
- * This operation is, essentially, the reverse of doing a regular
- * $(A).before(B), in that instead of inserting B before A, you're inserting
- * A before B.
- *
- * @example $("p").insertBefore("#foo");
- * @before <div id="foo">Hello</div><p>I would like to say: </p>
- * @result <p>I would like to say: </p><div id="foo">Hello</div>
- *
- * @name insertBefore
- * @type jQuery
- * @param String expr A jQuery expression of elements to match.
- * @cat DOM/Manipulation
- */
- insertBefore: "before",
-
- /**
- * Insert all of the matched elements after another, specified, set of elements.
- * This operation is, essentially, the reverse of doing a regular
- * $(A).after(B), in that instead of inserting B after A, you're inserting
- * A after B.
- *
- * @example $("p").insertAfter("#foo");
- * @before <p>I would like to say: </p><div id="foo">Hello</div>
- * @result <div id="foo">Hello</div><p>I would like to say: </p>
- *
- * @name insertAfter
- * @type jQuery
- * @param String expr A jQuery expression of elements to match.
- * @cat DOM/Manipulation
- */
- insertAfter: "after"
- },
-
- /**
- * Get the current CSS width of the first matched element.
- *
- * @example $("p").width();
- * @before <p>This is just a test.</p>
- * @result "300px"
- *
- * @name width
- * @type String
- * @cat CSS
- */
-
- /**
- * Set the CSS width of every matched element. Be sure to include
- * the "px" (or other unit of measurement) after the number that you
- * specify, otherwise you might get strange results.
- *
- * @example $("p").width("20px");
- * @before <p>This is just a test.</p>
- * @result <p style="width:20px;">This is just a test.</p>
- *
- * @name width
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
-
- /**
- * Get the current CSS height of the first matched element.
- *
- * @example $("p").height();
- * @before <p>This is just a test.</p>
- * @result "14px"
- *
- * @name height
- * @type String
- * @cat CSS
- */
-
- /**
- * Set the CSS height of every matched element. Be sure to include
- * the "px" (or other unit of measurement) after the number that you
- * specify, otherwise you might get strange results.
- *
- * @example $("p").height("20px");
- * @before <p>This is just a test.</p>
- * @result <p style="height:20px;">This is just a test.</p>
- *
- * @name height
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Get a set of elements containing the unique parents of the matched
+ * set of elements.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("p").parent()
+ * @before <div><p>Hello</p><p>Hello</p></div>
+ * @result [ <div><p>Hello</p><p>Hello</p></div> ]
+ * @desc Find the parent element of each paragraph.
+ *
+ * @example $("p").parent(".selected")
+ * @before <div><p>Hello</p></div><div class="selected"><p>Hello Again</p></div>
+ * @result [ <div class="selected"><p>Hello Again</p></div> ]
+ * @desc Find the parent element of each paragraph with a class "selected".
+ *
+ * @name parent
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the parents with
+ * @cat DOM/Traversing
+ */
- /**
- * Get the current CSS top of the first matched element.
- *
- * @example $("p").top();
- * @before <p>This is just a test.</p>
- * @result "0px"
- *
- * @name top
- * @type String
- * @cat CSS
- */
+/**
+ * Get a set of elements containing the unique ancestors of the matched
+ * set of elements (except for the root element).
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("span").parents()
+ * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
+ * @result [ <body>...</body>, <div>...</div>, <p><span>Hello</span></p> ]
+ * @desc Find all parent elements of each span.
+ *
+ * @example $("span").parents("p")
+ * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
+ * @result [ <p><span>Hello</span></p> ]
+ * @desc Find all parent elements of each span that is a paragraph.
+ *
+ * @name parents
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the ancestors with
+ * @cat DOM/Traversing
+ */
- /**
- * Set the CSS top of every matched element. Be sure to include
- * the "px" (or other unit of measurement) after the number that you
- * specify, otherwise you might get strange results.
- *
- * @example $("p").top("20px");
- * @before <p>This is just a test.</p>
- * @result <p style="top:20px;">This is just a test.</p>
- *
- * @name top
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Get a set of elements containing the unique next siblings of each of the
+ * matched set of elements.
+ *
+ * It only returns the very next sibling, not all next siblings.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("p").next()
+ * @before <p>Hello</p><p>Hello Again</p><div><span>And Again</span></div>
+ * @result [ <p>Hello Again</p>, <div><span>And Again</span></div> ]
+ * @desc Find the very next sibling of each paragraph.
+ *
+ * @example $("p").next(".selected")
+ * @before <p>Hello</p><p class="selected">Hello Again</p><div><span>And Again</span></div>
+ * @result [ <p class="selected">Hello Again</p> ]
+ * @desc Find the very next sibling of each paragraph that has a class "selected".
+ *
+ * @name next
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the next Elements with
+ * @cat DOM/Traversing
+ */
- /**
- * Get the current CSS left of the first matched element.
- *
- * @example $("p").left();
- * @before <p>This is just a test.</p>
- * @result "0px"
- *
- * @name left
- * @type String
- * @cat CSS
- */
+/**
+ * Get a set of elements containing the unique previous siblings of each of the
+ * matched set of elements.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * It only returns the immediately previous sibling, not all previous siblings.
+ *
+ * @example $("p").prev()
+ * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
+ * @result [ <div><span>Hello Again</span></div> ]
+ * @desc Find the very previous sibling of each paragraph.
+ *
+ * @example $("p").prev(".selected")
+ * @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
+ * @result [ <div><span>Hello</span></div> ]
+ * @desc Find the very previous sibling of each paragraph that has a class "selected".
+ *
+ * @name prev
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the previous Elements with
+ * @cat DOM/Traversing
+ */
- /**
- * Set the CSS left of every matched element. Be sure to include
- * the "px" (or other unit of measurement) after the number that you
- * specify, otherwise you might get strange results.
- *
- * @example $("p").left("20px");
- * @before <p>This is just a test.</p>
- * @result <p style="left:20px;">This is just a test.</p>
- *
- * @name left
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Get a set of elements containing all of the unique siblings of each of the
+ * matched set of elements.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("div").siblings()
+ * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
+ * @result [ <p>Hello</p>, <p>And Again</p> ]
+ * @desc Find all siblings of each div.
+ *
+ * @example $("div").siblings(".selected")
+ * @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
+ * @result [ <p class="selected">Hello Again</p> ]
+ * @desc Find all siblings with a class "selected" of each div.
+ *
+ * @name siblings
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the sibling Elements with
+ * @cat DOM/Traversing
+ */
- /**
- * Get the current CSS position of the first matched element.
- *
- * @example $("p").position();
- * @before <p>This is just a test.</p>
- * @result "static"
- *
- * @name position
- * @type String
- * @cat CSS
- */
+/**
+ * Get a set of elements containing all of the unique children of each of the
+ * matched set of elements.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("div").children()
+ * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
+ * @result [ <span>Hello Again</span> ]
+ * @desc Find all children of each div.
+ *
+ * @example $("div").children(".selected")
+ * @before <div><span>Hello</span><p class="selected">Hello Again</p><p>And Again</p></div>
+ * @result [ <p class="selected">Hello Again</p> ]
+ * @desc Find all children with a class "selected" of each div.
+ *
+ * @name children
+ * @type jQuery
+ * @param String expr (optional) An expression to filter the child Elements with
+ * @cat DOM/Traversing
+ */
+jQuery.each({
+ parent: "a.parentNode",
+ parents: jQuery.parents,
+ next: "jQuery.nth(a,1,'nextSibling')",
+ prev: "jQuery.nth(a,1,'previousSibling')",
+ siblings: "jQuery.sibling(a.parentNode.firstChild,a)",
+ children: "jQuery.sibling(a.firstChild)"
+}, function(i,n){
+ jQuery.fn[ i ] = function(a) {
+ var ret = jQuery.map(this,n);
+ if ( a && typeof a == "string" )
+ ret = jQuery.filter(a,ret).r;
+ return this.set( ret );
+ };
+});
- /**
- * Set the CSS position of every matched element.
- *
- * @example $("p").position("relative");
- * @before <p>This is just a test.</p>
- * @result <p style="position:relative;">This is just a test.</p>
- *
- * @name position
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Append all of the matched elements to another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).append(B), in that instead of appending B to A, you're appending
+ * A to B.
+ *
+ * @example $("p").appendTo("#foo");
+ * @before <p>I would like to say: </p><div id="foo"></div>
+ * @result <div id="foo"><p>I would like to say: </p></div>
+ * @desc Appends all paragraphs to the element with the ID "foo"
+ *
+ * @name appendTo
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
- /**
- * Get the current CSS float of the first matched element.
- *
- * @example $("p").float();
- * @before <p>This is just a test.</p>
- * @result "none"
- *
- * @name float
- * @type String
- * @cat CSS
- */
+/**
+ * Prepend all of the matched elements to another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).prepend(B), in that instead of prepending B to A, you're prepending
+ * A to B.
+ *
+ * @example $("p").prependTo("#foo");
+ * @before <p>I would like to say: </p><div id="foo"><b>Hello</b></div>
+ * @result <div id="foo"><p>I would like to say: </p><b>Hello</b></div>
+ * @desc Prepends all paragraphs to the element with the ID "foo"
+ *
+ * @name prependTo
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
- /**
- * Set the CSS float of every matched element.
- *
- * @example $("p").float("left");
- * @before <p>This is just a test.</p>
- * @result <p style="float:left;">This is just a test.</p>
- *
- * @name float
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Insert all of the matched elements before another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).before(B), in that instead of inserting B before A, you're inserting
+ * A before B.
+ *
+ * @example $("p").insertBefore("#foo");
+ * @before <div id="foo">Hello</div><p>I would like to say: </p>
+ * @result <p>I would like to say: </p><div id="foo">Hello</div>
+ * @desc Same as $("#foo").before("p")
+ *
+ * @name insertBefore
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
- /**
- * Get the current CSS overflow of the first matched element.
- *
- * @example $("p").overflow();
- * @before <p>This is just a test.</p>
- * @result "none"
- *
- * @name overflow
- * @type String
- * @cat CSS
- */
+/**
+ * Insert all of the matched elements after another, specified, set of elements.
+ * This operation is, essentially, the reverse of doing a regular
+ * $(A).after(B), in that instead of inserting B after A, you're inserting
+ * A after B.
+ *
+ * @example $("p").insertAfter("#foo");
+ * @before <p>I would like to say: </p><div id="foo">Hello</div>
+ * @result <div id="foo">Hello</div><p>I would like to say: </p>
+ * @desc Same as $("#foo").after("p")
+ *
+ * @name insertAfter
+ * @type jQuery
+ * @param String expr A jQuery expression of elements to match.
+ * @cat DOM/Manipulation
+ */
- /**
- * Set the CSS overflow of every matched element.
- *
- * @example $("p").overflow("auto");
- * @before <p>This is just a test.</p>
- * @result <p style="overflow:auto;">This is just a test.</p>
- *
- * @name overflow
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+jQuery.each({
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after"
+}, function(i,n){
+ jQuery.fn[ i ] = function(){
+ var a = arguments;
+ return this.each(function(){
+ for ( var j = 0, al = a.length; j < al; j++ )
+ jQuery(a[j])[n]( this );
+ });
+ };
+});
- /**
- * Get the current CSS color of the first matched element.
- *
- * @example $("p").color();
- * @before <p>This is just a test.</p>
- * @result "black"
- *
- * @name color
- * @type String
- * @cat CSS
- */
+/**
+ * Remove an attribute from each of the matched elements.
+ *
+ * @example $("input").removeAttr("disabled")
+ * @before <input disabled="disabled"/>
+ * @result <input/>
+ *
+ * @name removeAttr
+ * @type jQuery
+ * @param String name The name of the attribute to remove.
+ * @cat DOM/Attributes
+ */
- /**
- * Set the CSS color of every matched element.
- *
- * @example $("p").color("blue");
- * @before <p>This is just a test.</p>
- * @result <p style="color:blue;">This is just a test.</p>
- *
- * @name color
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Displays each of the set of matched elements if they are hidden.
+ *
+ * @example $("p").show()
+ * @before <p style="display: none">Hello</p>
+ * @result [ <p style="display: block">Hello</p> ]
+ *
+ * @name show
+ * @type jQuery
+ * @cat Effects
+ */
- /**
- * Get the current CSS background of the first matched element.
- *
- * @example $("p").background();
- * @before <p style="background:blue;">This is just a test.</p>
- * @result "blue"
- *
- * @name background
- * @type String
- * @cat CSS
- */
+/**
+ * Hides each of the set of matched elements if they are shown.
+ *
+ * @example $("p").hide()
+ * @before <p>Hello</p>
+ * @result [ <p style="display: none">Hello</p> ]
+ *
+ * var pass = true, div = $("div");
+ * div.hide().each(function(){
+ * if ( this.style.display != "none" ) pass = false;
+ * });
+ * ok( pass, "Hide" );
+ *
+ * @name hide
+ * @type jQuery
+ * @cat Effects
+ */
- /**
- * Set the CSS background of every matched element.
- *
- * @example $("p").background("blue");
- * @before <p>This is just a test.</p>
- * @result <p style="background:blue;">This is just a test.</p>
- *
- * @name background
- * @type jQuery
- * @param String val Set the CSS property to the specified value.
- * @cat CSS
- */
+/**
+ * Toggles each of the set of matched elements. If they are shown,
+ * toggle makes them hidden. If they are hidden, toggle
+ * makes them shown.
+ *
+ * @example $("p").toggle()
+ * @before <p>Hello</p><p style="display: none">Hello Again</p>
+ * @result [ <p style="display: none">Hello</p>, <p style="display: block">Hello Again</p> ]
+ *
+ * @name toggle
+ * @type jQuery
+ * @cat Effects
+ */
- css: "width,height,top,left,position,float,overflow,color,background".split(","),
+/**
+ * Adds the specified class to each of the set of matched elements.
+ *
+ * @example $("p").addClass("selected")
+ * @before <p>Hello</p>
+ * @result [ <p class="selected">Hello</p> ]
+ *
+ * @name addClass
+ * @type jQuery
+ * @param String class A CSS class to add to the elements
+ * @cat DOM/Attributes
+ * @see removeClass(String)
+ */
- /**
- * Reduce the set of matched elements to a single element.
- * The position of the element in the set of matched elements
- * starts at 0 and goes to length - 1.
- *
- * @example $("p").eq(1)
- * @before <p>This is just a test.</p><p>So is this</p>
- * @result [ <p>So is this</p> ]
- *
- * @name eq
- * @type jQuery
- * @param Number pos The index of the element that you wish to limit to.
- * @cat Core
- */
+/**
+ * Removes all or the specified class from the set of matched elements.
+ *
+ * @example $("p").removeClass()
+ * @before <p class="selected">Hello</p>
+ * @result [ <p>Hello</p> ]
+ *
+ * @example $("p").removeClass("selected")
+ * @before <p class="selected first">Hello</p>
+ * @result [ <p class="first">Hello</p> ]
+ *
+ * @name removeClass
+ * @type jQuery
+ * @param String class (optional) A CSS class to remove from the elements
+ * @cat DOM/Attributes
+ * @see addClass(String)
+ */
- /**
- * Reduce the set of matched elements to all elements before a given position.
- * The position of the element in the set of matched elements
- * starts at 0 and goes to length - 1.
- *
- * @example $("p").lt(1)
- * @before <p>This is just a test.</p><p>So is this</p>
- * @result [ <p>This is just a test.</p> ]
- *
- * @name lt
- * @type jQuery
- * @param Number pos Reduce the set to all elements below this position.
- * @cat Core
- */
+/**
+ * Adds the specified class if it is not present, removes it if it is
+ * present.
+ *
+ * @example $("p").toggleClass("selected")
+ * @before <p>Hello</p><p class="selected">Hello Again</p>
+ * @result [ <p class="selected">Hello</p>, <p>Hello Again</p> ]
+ *
+ * @name toggleClass
+ * @type jQuery
+ * @param String class A CSS class with which to toggle the elements
+ * @cat DOM/Attributes
+ */
- /**
- * Reduce the set of matched elements to all elements after a given position.
- * The position of the element in the set of matched elements
- * starts at 0 and goes to length - 1.
- *
- * @example $("p").gt(0)
- * @before <p>This is just a test.</p><p>So is this</p>
- * @result [ <p>So is this</p> ]
- *
- * @name gt
- * @type jQuery
- * @param Number pos Reduce the set to all elements after this position.
- * @cat Core
- */
+/**
+ * Removes all matched elements from the DOM. This does NOT remove them from the
+ * jQuery object, allowing you to use the matched elements further.
+ *
+ * Can be filtered with an optional expressions.
+ *
+ * @example $("p").remove();
+ * @before <p>Hello</p> how are <p>you?</p>
+ * @result how are
+ *
+ * @example $("p").remove(".hello");
+ * @before <p class="hello">Hello</p> how are <p>you?</p>
+ * @result how are <p>you?</p>
+ *
+ * @name remove
+ * @type jQuery
+ * @param String expr (optional) A jQuery expression to filter elements by.
+ * @cat DOM/Manipulation
+ */
- /**
- * Filter the set of elements to those that contain the specified text.
- *
- * @example $("p").contains("test")
- * @before <p>This is just a test.</p><p>So is this</p>
- * @result [ <p>This is just a test.</p> ]
- *
- * @name contains
- * @type jQuery
- * @param String str The string that will be contained within the text of an element.
- * @cat DOM/Traversing
- */
+/**
+ * Removes all child nodes from the set of matched elements.
+ *
+ * @example $("p").empty()
+ * @before <p>Hello, <span>Person</span> <a href="#">and person</a></p>
+ * @result [ <p></p> ]
+ *
+ * @name empty
+ * @type jQuery
+ * @cat DOM/Manipulation
+ */
- filter: [ "eq", "lt", "gt", "contains" ],
-
- attr: {
- /**
- * Get the current value of the first matched element.
- *
- * @example $("input").val();
- * @before <input type="text" value="some text"/>
- * @result "some text"
- *
- * @name val
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the value of every matched element.
- *
- * @example $("input").val("test");
- * @before <input type="text" value="some text"/>
- * @result <input type="text" value="test"/>
- *
- * @name val
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- val: "value",
-
- /**
- * Get the html contents of the first matched element.
- * This property is not available on XML documents.
- *
- * @example $("div").html();
- * @before <div><input/></div>
- * @result <input/>
- *
- * @name html
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the html contents of every matched element.
- * This property is not available on XML documents.
- *
- * @example $("div").html("<b>new stuff</b>");
- * @before <div><input/></div>
- * @result <div><b>new stuff</b></div>
- *
- * @name html
- * @type jQuery
- * @param String val Set the html contents to the specified value.
- * @cat DOM/Attributes
- */
- html: "innerHTML",
-
- /**
- * Get the current id of the first matched element.
- *
- * @example $("input").id();
- * @before <input type="text" id="test" value="some text"/>
- * @result "test"
- *
- * @name id
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the id of every matched element.
- *
- * @example $("input").id("newid");
- * @before <input type="text" id="test" value="some text"/>
- * @result <input type="text" id="newid" value="some text"/>
- *
- * @name id
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- id: null,
-
- /**
- * Get the current title of the first matched element.
- *
- * @example $("img").title();
- * @before <img src="test.jpg" title="my image"/>
- * @result "my image"
- *
- * @name title
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the title of every matched element.
- *
- * @example $("img").title("new title");
- * @before <img src="test.jpg" title="my image"/>
- * @result <img src="test.jpg" title="new image"/>
- *
- * @name title
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- title: null,
-
- /**
- * Get the current name of the first matched element.
- *
- * @example $("input").name();
- * @before <input type="text" name="username"/>
- * @result "username"
- *
- * @name name
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the name of every matched element.
- *
- * @example $("input").name("user");
- * @before <input type="text" name="username"/>
- * @result <input type="text" name="user"/>
- *
- * @name name
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- name: null,
-
- /**
- * Get the current href of the first matched element.
- *
- * @example $("a").href();
- * @before <a href="test.html">my link</a>
- * @result "test.html"
- *
- * @name href
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the href of every matched element.
- *
- * @example $("a").href("test2.html");
- * @before <a href="test.html">my link</a>
- * @result <a href="test2.html">my link</a>
- *
- * @name href
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- href: null,
-
- /**
- * Get the current src of the first matched element.
- *
- * @example $("img").src();
- * @before <img src="test.jpg" title="my image"/>
- * @result "test.jpg"
- *
- * @name src
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the src of every matched element.
- *
- * @example $("img").src("test2.jpg");
- * @before <img src="test.jpg" title="my image"/>
- * @result <img src="test2.jpg" title="my image"/>
- *
- * @name src
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- src: null,
-
- /**
- * Get the current rel of the first matched element.
- *
- * @example $("a").rel();
- * @before <a href="test.html" rel="nofollow">my link</a>
- * @result "nofollow"
- *
- * @name rel
- * @type String
- * @cat DOM/Attributes
- */
-
- /**
- * Set the rel of every matched element.
- *
- * @example $("a").rel("nofollow");
- * @before <a href="test.html">my link</a>
- * @result <a href="test.html" rel="nofollow">my link</a>
- *
- * @name rel
- * @type jQuery
- * @param String val Set the property to the specified value.
- * @cat DOM/Attributes
- */
- rel: null
+jQuery.each( {
+ removeAttr: function( key ) {
+ jQuery.attr( this, key, "" );
+ this.removeAttribute( key );
},
-
- axis: {
- /**
- * Get a set of elements containing the unique parents of the matched
- * set of elements.
- *
- * @example $("p").parent()
- * @before <div><p>Hello</p><p>Hello</p></div>
- * @result [ <div><p>Hello</p><p>Hello</p></div> ]
- *
- * @name parent
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing the unique parents of the matched
- * set of elements, and filtered by an expression.
- *
- * @example $("p").parent(".selected")
- * @before <div><p>Hello</p></div><div class="selected"><p>Hello Again</p></div>
- * @result [ <div class="selected"><p>Hello Again</p></div> ]
- *
- * @name parent
- * @type jQuery
- * @param String expr An expression to filter the parents with
- * @cat DOM/Traversing
- */
- parent: "a.parentNode",
-
- /**
- * Get a set of elements containing the unique ancestors of the matched
- * set of elements (except for the root element).
- *
- * @example $("span").parents()
- * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
- * @result [ <body>...</body>, <div>...</div>, <p><span>Hello</span></p> ]
- *
- * @name parents
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing the unique ancestors of the matched
- * set of elements, and filtered by an expression.
- *
- * @example $("span").parents("p")
- * @before <html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>
- * @result [ <p><span>Hello</span></p> ]
- *
- * @name parents
- * @type jQuery
- * @param String expr An expression to filter the ancestors with
- * @cat DOM/Traversing
- */
- parents: jQuery.parents,
-
- /**
- * Get a set of elements containing the unique next siblings of each of the
- * matched set of elements.
- *
- * It only returns the very next sibling, not all next siblings.
- *
- * @example $("p").next()
- * @before <p>Hello</p><p>Hello Again</p><div><span>And Again</span></div>
- * @result [ <p>Hello Again</p>, <div><span>And Again</span></div> ]
- *
- * @name next
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing the unique next siblings of each of the
- * matched set of elements, and filtered by an expression.
- *
- * It only returns the very next sibling, not all next siblings.
- *
- * @example $("p").next(".selected")
- * @before <p>Hello</p><p class="selected">Hello Again</p><div><span>And Again</span></div>
- * @result [ <p class="selected">Hello Again</p> ]
- *
- * @name next
- * @type jQuery
- * @param String expr An expression to filter the next Elements with
- * @cat DOM/Traversing
- */
- next: "jQuery.nth(a,1,'nextSibling')",
-
- /**
- * Get a set of elements containing the unique previous siblings of each of the
- * matched set of elements.
- *
- * It only returns the immediately previous sibling, not all previous siblings.
- *
- * @example $("p").prev()
- * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
- * @result [ <div><span>Hello Again</span></div> ]
- *
- * @name prev
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing the unique previous siblings of each of the
- * matched set of elements, and filtered by an expression.
- *
- * It only returns the immediately previous sibling, not all previous siblings.
- *
- * @example $("p").prev(".selected")
- * @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
- * @result [ <div><span>Hello</span></div> ]
- *
- * @name prev
- * @type jQuery
- * @param String expr An expression to filter the previous Elements with
- * @cat DOM/Traversing
- */
- prev: "jQuery.nth(a,1,'previousSibling')",
-
- /**
- * Get a set of elements containing all of the unique siblings of each of the
- * matched set of elements.
- *
- * @example $("div").siblings()
- * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
- * @result [ <p>Hello</p>, <p>And Again</p> ]
- *
- * @name siblings
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing all of the unique siblings of each of the
- * matched set of elements, and filtered by an expression.
- *
- * @example $("div").siblings(".selected")
- * @before <div><span>Hello</span></div><p class="selected">Hello Again</p><p>And Again</p>
- * @result [ <p class="selected">Hello Again</p> ]
- *
- * @name siblings
- * @type jQuery
- * @param String expr An expression to filter the sibling Elements with
- * @cat DOM/Traversing
- */
- siblings: "jQuery.sibling(a.parentNode.firstChild,a)",
-
- /**
- * Get a set of elements containing all of the unique children of each of the
- * matched set of elements.
- *
- * @example $("div").children()
- * @before <p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>
- * @result [ <span>Hello Again</span> ]
- *
- * @name children
- * @type jQuery
- * @cat DOM/Traversing
- */
-
- /**
- * Get a set of elements containing all of the unique children of each of the
- * matched set of elements, and filtered by an expression.
- *
- * @example $("div").children(".selected")
- * @before <div><span>Hello</span><p class="selected">Hello Again</p><p>And Again</p></div>
- * @result [ <p class="selected">Hello Again</p> ]
- *
- * @name children
- * @type jQuery
- * @param String expr An expression to filter the child Elements with
- * @cat DOM/Traversing
- */
- children: "jQuery.sibling(a.firstChild)"
+ show: function(){
+ this.style.display = this.oldblock ? this.oldblock : "";
+ if ( jQuery.css(this,"display") == "none" )
+ this.style.display = "block";
},
+ hide: function(){
+ this.oldblock = this.oldblock || jQuery.css(this,"display");
+ if ( this.oldblock == "none" )
+ this.oldblock = "block";
+ this.style.display = "none";
+ },
+ toggle: function(){
+ jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ].apply( jQuery(this), arguments );
+ },
+ addClass: function(c){
+ jQuery.className.add(this,c);
+ },
+ removeClass: function(c){
+ jQuery.className.remove(this,c);
+ },
+ toggleClass: function( c ){
+ jQuery.className[ jQuery.className.has(this,c) ? "remove" : "add" ](this, c);
+ },
+ remove: function(a){
+ if ( !a || jQuery.filter( a, [this] ).r )
+ this.parentNode.removeChild( this );
+ },
+ empty: function() {
+ while ( this.firstChild )
+ this.removeChild( this.firstChild );
+ }
+}, function(i,n){
+ jQuery.fn[ i ] = function() {
+ return this.each( n, arguments );
+ };
+});
- each: {
-
- /**
- * Remove an attribute from each of the matched elements.
- *
- * @example $("input").removeAttr("disabled")
- * @before <input disabled="disabled"/>
- * @result <input/>
- *
- * @name removeAttr
- * @type jQuery
- * @param String name The name of the attribute to remove.
- * @cat DOM
- */
- removeAttr: function( key ) {
- jQuery.attr( this, key, "" );
- this.removeAttribute( key );
- },
-
- /**
- * Displays each of the set of matched elements if they are hidden.
- *
- * @example $("p").show()
- * @before <p style="display: none">Hello</p>
- * @result [ <p style="display: block">Hello</p> ]
- *
- * @name show
- * @type jQuery
- * @cat Effects
- */
- show: function(){
- this.style.display = this.oldblock ? this.oldblock : "";
- if ( jQuery.css(this,"display") == "none" )
- this.style.display = "block";
- },
-
- /**
- * Hides each of the set of matched elements if they are shown.
- *
- * @example $("p").hide()
- * @before <p>Hello</p>
- * @result [ <p style="display: none">Hello</p> ]
- *
- * var pass = true, div = $("div");
- * div.hide().each(function(){
- * if ( this.style.display != "none" ) pass = false;
- * });
- * ok( pass, "Hide" );
- *
- * @name hide
- * @type jQuery
- * @cat Effects
- */
- hide: function(){
- this.oldblock = this.oldblock || jQuery.css(this,"display");
- if ( this.oldblock == "none" )
- this.oldblock = "block";
- this.style.display = "none";
- },
-
- /**
- * Toggles each of the set of matched elements. If they are shown,
- * toggle makes them hidden. If they are hidden, toggle
- * makes them shown.
- *
- * @example $("p").toggle()
- * @before <p>Hello</p><p style="display: none">Hello Again</p>
- * @result [ <p style="display: none">Hello</p>, <p style="display: block">Hello Again</p> ]
- *
- * @name toggle
- * @type jQuery
- * @cat Effects
- */
- toggle: function(){
- jQuery(this)[ jQuery(this).is(":hidden") ? "show" : "hide" ].apply( jQuery(this), arguments );
- },
-
- /**
- * Adds the specified class to each of the set of matched elements.
- *
- * @example $("p").addClass("selected")
- * @before <p>Hello</p>
- * @result [ <p class="selected">Hello</p> ]
- *
- * @name addClass
- * @type jQuery
- * @param String class A CSS class to add to the elements
- * @cat DOM
- */
- addClass: function(c){
- jQuery.className.add(this,c);
- },
-
- /**
- * Removes all or the specified class from the set of matched elements.
- *
- * @example $("p").removeClass()
- * @before <p class="selected">Hello</p>
- * @result [ <p>Hello</p> ]
- *
- * @example $("p").removeClass("selected")
- * @before <p class="selected first">Hello</p>
- * @result [ <p class="first">Hello</p> ]
- *
- * @name removeClass
- * @type jQuery
- * @param String class (optional) A CSS class to remove from the elements
- * @cat DOM
- */
- removeClass: function(c){
- jQuery.className.remove(this,c);
- },
-
- /**
- * Adds the specified class if it is not present, removes it if it is
- * present.
- *
- * @example $("p").toggleClass("selected")
- * @before <p>Hello</p><p class="selected">Hello Again</p>
- * @result [ <p class="selected">Hello</p>, <p>Hello Again</p> ]
- *
- * @name toggleClass
- * @type jQuery
- * @param String class A CSS class with which to toggle the elements
- * @cat DOM
- */
- toggleClass: function( c ){
- jQuery.className[ jQuery.className.has(this,c) ? "remove" : "add" ](this, c);
- },
+/**
+ * Reduce the set of matched elements to a single element.
+ * The position of the element in the set of matched elements
+ * starts at 0 and goes to length - 1.
+ *
+ * @example $("p").eq(1)
+ * @before <p>This is just a test.</p><p>So is this</p>
+ * @result [ <p>So is this</p> ]
+ *
+ * @name eq
+ * @type jQuery
+ * @param Number pos The index of the element that you wish to limit to.
+ * @cat Core
+ */
- /**
- * Removes all matched elements from the DOM. This does NOT remove them from the
- * jQuery object, allowing you to use the matched elements further.
- *
- * @example $("p").remove();
- * @before <p>Hello</p> how are <p>you?</p>
- * @result how are
- *
- * @name remove
- * @type jQuery
- * @cat DOM/Manipulation
- */
-
- /**
- * Removes only elements (out of the list of matched elements) that match
- * the specified jQuery expression. This does NOT remove them from the
- * jQuery object, allowing you to use the matched elements further.
- *
- * @example $("p").remove(".hello");
- * @before <p class="hello">Hello</p> how are <p>you?</p>
- * @result how are <p>you?</p>
- *
- * @name remove
- * @type jQuery
- * @param String expr A jQuery expression to filter elements by.
- * @cat DOM/Manipulation
- */
- remove: function(a){
- if ( !a || jQuery.filter( a, [this] ).r )
- this.parentNode.removeChild( this );
- },
+/**
+ * Reduce the set of matched elements to all elements before a given position.
+ * The position of the element in the set of matched elements
+ * starts at 0 and goes to length - 1.
+ *
+ * @example $("p").lt(1)
+ * @before <p>This is just a test.</p><p>So is this</p>
+ * @result [ <p>This is just a test.</p> ]
+ *
+ * @name lt
+ * @type jQuery
+ * @param Number pos Reduce the set to all elements below this position.
+ * @cat Core
+ */
- /**
- * Removes all child nodes from the set of matched elements.
- *
- * @example $("p").empty()
- * @before <p>Hello, <span>Person</span> <a href="#">and person</a></p>
- * @result [ <p></p> ]
- *
- * @name empty
- * @type jQuery
- * @cat DOM/Manipulation
- */
- empty: function(){
- while ( this.firstChild )
- this.removeChild( this.firstChild );
- }
- }
-};
+/**
+ * Reduce the set of matched elements to all elements after a given position.
+ * The position of the element in the set of matched elements
+ * starts at 0 and goes to length - 1.
+ *
+ * @example $("p").gt(0)
+ * @before <p>This is just a test.</p><p>So is this</p>
+ * @result [ <p>So is this</p> ]
+ *
+ * @name gt
+ * @type jQuery
+ * @param Number pos Reduce the set to all elements after this position.
+ * @cat Core
+ */
-jQuery.init();
\ No newline at end of file
+/**
+ * Filter the set of elements to those that contain the specified text.
+ *
+ * @example $("p").contains("test")
+ * @before <p>This is just a test.</p><p>So is this</p>
+ * @result [ <p>This is just a test.</p> ]
+ *
+ * @name contains
+ * @type jQuery
+ * @param String str The string that will be contained within the text of an element.
+ * @cat DOM/Traversing
+ */
+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
git.asbjorn.biz / jquery.git / blobdiff