Core
$(html)

$(html)

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.

Returns

jQuery

Parameters

  • html (String): A string of HTML to create on the fly.

Example

Creates a div element (and all of its contents) dynamically, and appends it to the element with the ID of body. Internally, an element is created and it's innerHTML property set to the given markup. It is therefore both quite flexible and limited.

jQuery Code

$("<div><p>Hello</p></div>").appendTo("#body")
$(elem)

$(elem)

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).

Returns

jQuery

Parameters

  • elem (Element): A DOM element to be encapsulated by a jQuery object.

Example

jQuery Code

$(document).find("div > p")

Before

<p>one</p> <div><p>two</p></div> <p>three</p>

Result:

[ <p>two</p> ]

Example

Sets the background color of the page to black.

jQuery Code

$(document.body).background( "black" );
$(elems)

$(elems)

Wrap jQuery functionality around a set of DOM Elements.

Returns

jQuery

Parameters

  • elems (Array<Element>): An array of DOM elements to be encapsulated by a jQuery object.

Example

Hides all the input elements within a form

jQuery Code

$( myForm.elements ).hide()
$(fn)

$(fn)

A shorthand for $(document).ready(), allowing you to bind a function to be executed when the DOM document has finished loading. This function behaves just like $(document).ready(), in that it should be used to wrap all of the other $() operations on your page. While this function is, technically, chainable - there really isn't much use for chaining against it. You can have as many $(document).ready events on your page as you like.

Returns

jQuery

Parameters

  • fn (Function): The function to execute when the DOM is ready.

Example

Executes the function when the DOM is ready to be used.

jQuery Code

$(function(){
  // Document is ready
});
$(obj)

$(obj)

A means of creating a cloned copy of a jQuery object. This function copies the set of matched elements from one jQuery object and creates another, new, jQuery object containing the same elements.

Returns

jQuery

Parameters

  • obj (jQuery): The jQuery object to be cloned.

Example

Locates all p elements with all div elements, without disrupting the original jQuery object contained in 'div' (as would normally be the case if a simple div.find("p") was done).

jQuery Code

var div = $("div");
$( div ).find("p");
$(expr, context)

$(expr, context)

This function accepts a string containing a CSS or basic XPath selector which is then used to match a set of elements.

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.

By default, $() looks for DOM elements within the context of the current HTML document.

Returns

jQuery

Parameters

  • expr (String): An expression to search with
  • context (Element): (optional) A DOM Element, or Document, representing the base context.

Example

This finds all p elements that are children of a div element.

jQuery Code

$("div > p")

Before

<p>one</p> <div><p>two</p></div> <p>three</p>

Result:

[ <p>two</p> ]

Example

Searches for all inputs of type radio within the first form in the document

jQuery Code

$("input:radio", document.forms[0])

Example

This finds all div elements within the specified XML document.

jQuery Code

$("div", xml.responseXML)
$.extend(prop)

$.extend(prop)

Extends the jQuery object itself. Can be used to add functions into the jQuery namespace and to add plugin methods (plugins).

Returns

Object

Parameters

  • prop (Object): The object that will be merged into the jQuery object

Example

Adds two plugin methods.

jQuery Code

jQuery.fn.extend({
  check: function() {
    return this.each(function() { this.checked = true; });
  ),
  uncheck: function() {
    return this.each(function() { this.checked = false; });
  }
});
$("input[@type=checkbox]").check();
$("input[@type=radio]").uncheck();

Example

Adds two functions into the jQuery namespace

jQuery Code

jQuery.extend({
  min: function(a, b) { return a < b ? a : b; },
  max: function(a, b) { return a > b ? a : b; }
});
each(fn)

each(fn)

Execute a function within the context of every matched element. This means that every time the passed-in function is executed (which is once for every element matched) the 'this' keyword points to the specific element.

Additionally, the function, when executed, is passed a single argument representing the position of the element in the matched set.

Returns

jQuery

Parameters

  • fn (Function): A function to execute

Example

Iterates over two images and sets their src property

jQuery Code

$("img").each(function(i){
  this.src = "test" + i + ".jpg";
});

Before

<img/> <img/>

Result:

<img src="test0.jpg"/> <img src="test1.jpg"/>
eq(pos)

eq(pos)

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.

Returns

jQuery

Parameters

  • pos (Number): The index of the element that you wish to limit to.

Example

jQuery Code

$("p").eq(1)

Before

<p>This is just a test.</p><p>So is this</p>

Result:

[ <p>So is this</p> ]
get()

get()

Access all matched elements. This serves as a backwards-compatible way of accessing all matched elements (other than the jQuery object itself, which is, in fact, an array of elements).

Returns

Array<Element>

Example

jQuery Code

$("img").get();

Before

<img src="test1.jpg"/> <img src="test2.jpg"/>

Result:

[ <img src="test1.jpg"/> <img src="test2.jpg"/> ]
get(num)

get(num)

Access a single matched element. num is used to access the Nth element matched.

Returns

Element

Parameters

  • num (Number): Access the element in the Nth position.

Example

jQuery Code

$("img").get(1);

Before

<img src="test1.jpg"/> <img src="test2.jpg"/>

Result:

[ <img src="test1.jpg"/> ]
gt(pos)

gt(pos)

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.

Returns

jQuery

Parameters

  • pos (Number): Reduce the set to all elements after this position.

Example

jQuery Code

$("p").gt(0)

Before

<p>This is just a test.</p><p>So is this</p>

Result:

[ <p>So is this</p> ]
index(obj)

index(obj)

Searches every matched element for the object and returns the index of the element, if found, starting with zero. Returns -1 if the object wasn't found.

Returns

Number

Parameters

  • obj (Object): Object to search for

Example

jQuery Code

$("*").index(document.getElementById('foobar'))

Before

<div id="foobar"></div><b></b><span id="foo"></span>

Result:

0

Example

jQuery Code

$("*").index(document.getElementById('foo'))

Before

<div id="foobar"></div><b></b><span id="foo"></span>

Result:

2

Example

jQuery Code

$("*").index(document.getElementById('bar'))

Before

<div id="foobar"></div><b></b><span id="foo"></span>

Result:

-1
length

length

The number of elements currently matched.

Returns

Number

Example

jQuery Code

$("img").length;

Before

<img src="test1.jpg"/> <img src="test2.jpg"/>

Result:

2
lt(pos)

lt(pos)

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.

Returns

jQuery

Parameters

  • pos (Number): Reduce the set to all elements below this position.

Example

jQuery Code

$("p").lt(1)

Before

<p>This is just a test.</p><p>So is this</p>

Result:

[ <p>This is just a test.</p> ]
size()

size()

The number of elements currently matched.

Returns

Number

Example

jQuery Code

$("img").size();

Before

<img src="test1.jpg"/> <img src="test2.jpg"/>

Result:

2
DOM
Attributes
href()

href()

Get the current href of the first matched element.

Returns

String

Example

jQuery Code

$("a").href();

Before

<a href="test.html">my link</a>

Result:

"test.html"
href(val)

href(val)

Set the href of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("a").href("test2.html");

Before

<a href="test.html">my link</a>

Result:

<a href="test2.html">my link</a>
html()

html()

Get the html contents of the first matched element.

Returns

String

Example

jQuery Code

$("div").html();

Before

<div><input/></div>

Result:

<input/>
html(val)

html(val)

Set the html contents of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the html contents to the specified value.

Example

jQuery Code

$("div").html("<b>new stuff</b>");

Before

<div><input/></div>

Result:

<div><b>new stuff</b></div>
id()

id()

Get the current id of the first matched element.

Returns

String

Example

jQuery Code

$("input").id();

Before

<input type="text" id="test" value="some text"/>

Result:

"test"
id(val)

id(val)

Set the id of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("input").id("newid");

Before

<input type="text" id="test" value="some text"/>

Result:

<input type="text" id="newid" value="some text"/>
name()

name()

Get the current name of the first matched element.

Returns

String

Example

jQuery Code

$("input").name();

Before

<input type="text" name="username"/>

Result:

"username"
name(val)

name(val)

Set the name of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("input").name("user");

Before

<input type="text" name="username"/>

Result:

<input type="text" name="user"/>
rel()

rel()

Get the current rel of the first matched element.

Returns

String

Example

jQuery Code

$("a").rel();

Before

<a href="test.html" rel="nofollow">my link</a>

Result:

"nofollow"
rel(val)

rel(val)

Set the rel of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("a").rel("nofollow");

Before

<a href="test.html">my link</a>

Result:

<a href="test.html" rel="nofollow">my link</a>
src()

src()

Get the current src of the first matched element.

Returns

String

Example

jQuery Code

$("img").src();

Before

<img src="test.jpg" title="my image"/>

Result:

"test.jpg"
src(val)

src(val)

Set the src of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("img").src("test2.jpg");

Before

<img src="test.jpg" title="my image"/>

Result:

<img src="test2.jpg" title="my image"/>
title()

title()

Get the current title of the first matched element.

Returns

String

Example

jQuery Code

$("img").title();

Before

<img src="test.jpg" title="my image"/>

Result:

"my image"
title(val)

title(val)

Set the title of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("img").title("new title");

Before

<img src="test.jpg" title="my image"/>

Result:

<img src="test.jpg" title="new image"/>
val()

val()

Get the current value of the first matched element.

Returns

String

Example

jQuery Code

$("input").val();

Before

<input type="text" value="some text"/>

Result:

"some text"
val(val)

val(val)

Set the value of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the property to the specified value.

Example

jQuery Code

$("input").val("test");

Before

<input type="text" value="some text"/>

Result:

<input type="text" value="test"/>
Manipulation
after(html)

after(html)

Insert any number of dynamically generated elements after each of the matched elements.

Returns

jQuery

Parameters

  • html (String): A string of HTML, that will be created on the fly and appended to the target.

Example

jQuery Code

$("p").after("<b>Hello</b>");

Before

<p>I would like to say: </p>

Result:

<p>I would like to say: </p><b>Hello</b>
after(elem)

after(elem)

Insert an element after each of the matched elements.

Returns

jQuery

Parameters

  • elem (Element): A DOM element that will be appended.

Example

jQuery Code

$("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>
after(elems)

after(elems)

Insert any number of elements after each of the matched elements.

Returns

jQuery

Parameters

  • elems (Array<Element>): An array of elements, all of which will be appended.

Example

jQuery Code

$("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>
append(html)

append(html)

Append any number of elements to the inside of every matched elements, generated from the provided HTML. This operation is similar to doing an appendChild to all the specified elements, adding them into the document.

Returns

jQuery

Parameters

  • html (String): A string of HTML, that will be created on the fly and appended to the target.

Example

jQuery Code

$("p").append("<b>Hello</b>");

Before

<p>I would like to say: </p>

Result:

<p>I would like to say: <b>Hello</b></p>
append(elem)

append(elem)

Append an element to the inside of all matched elements. This operation is similar to doing an appendChild to all the specified elements, adding them into the document.

Returns

jQuery

Parameters

  • elem (Element): A DOM element that will be appended.

Example

jQuery Code

$("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>
append(elems)

append(elems)

Append any number of elements to the inside of all matched elements. This operation is similar to doing an appendChild to all the specified elements, adding them into the document.

Returns

jQuery

Parameters

  • elems (Array<Element>): An array of elements, all of which will be appended.

Example

jQuery Code

$("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>
appendTo(expr)

appendTo(expr)

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.

Returns

jQuery

Parameters

  • expr (String): A jQuery expression of elements to match.

Example

jQuery Code

$("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>
before(html)

before(html)

Insert any number of dynamically generated elements before each of the matched elements.

Returns

jQuery

Parameters

  • html (String): A string of HTML, that will be created on the fly and appended to the target.

Example

jQuery Code

$("p").before("<b>Hello</b>");

Before

<p>I would like to say: </p>

Result:

<b>Hello</b><p>I would like to say: </p>
before(elem)

before(elem)

Insert an element before each of the matched elements.

Returns

jQuery

Parameters

  • elem (Element): A DOM element that will be appended.

Example

jQuery Code

$("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>
before(elems)

before(elems)

Insert any number of elements before each of the matched elements.

Returns

jQuery

Parameters

  • elems (Array<Element>): An array of elements, all of which will be appended.

Example

jQuery Code

$("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>
clone()

clone()

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. This is useful for moving copies of the elements to another location in the DOM.

Returns

jQuery

Example

jQuery Code

$("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>
empty()

empty()

Removes all child nodes from the set of matched elements.

Returns

jQuery

Example

jQuery Code

$("p").empty()

Before

<p>Hello, <span>Person</span> <a href="#">and person</a></p>

Result:

[ <p></p> ]
insertAfter(expr)

insertAfter(expr)

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.

Returns

jQuery

Parameters

  • expr (String): A jQuery expression of elements to match.

Example

jQuery Code

$("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>
insertBefore(expr)

insertBefore(expr)

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.

Returns

jQuery

Parameters

  • expr (String): A jQuery expression of elements to match.

Example

jQuery Code

$("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>
prepend(html)

prepend(html)

Prepend any number of elements to the inside of every matched elements, generated from the provided HTML. This operation is the best way to insert dynamically created elements inside, at the beginning, of all the matched element.

Returns

jQuery

Parameters

  • html (String): A string of HTML, that will be created on the fly and appended to the target.

Example

jQuery Code

$("p").prepend("<b>Hello</b>");

Before

<p>I would like to say: </p>

Result:

<p><b>Hello</b>I would like to say: </p>
prepend(elem)

prepend(elem)

Prepend an element to the inside of all matched elements. This operation is the best way to insert an element inside, at the beginning, of all the matched element.

Returns

jQuery

Parameters

  • elem (Element): A DOM element that will be appended.

Example

jQuery Code

$("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>
prepend(elems)

prepend(elems)

Prepend any number of elements to the inside of all matched elements. This operation is the best way to insert a set of elements inside, at the beginning, of all the matched element.

Returns

jQuery

Parameters

  • elems (Array<Element>): An array of elements, all of which will be appended.

Example

jQuery Code

$("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>
prependTo(expr)

prependTo(expr)

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.

Returns

jQuery

Parameters

  • expr (String): A jQuery expression of elements to match.

Example

jQuery Code

$("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>
remove()

remove()

Removes all matched elements from the DOM. This does NOT remove them from the jQuery object, allowing you to use the matched elements further.

Returns

jQuery

Example

jQuery Code

$("p").remove();

Before

<p>Hello</p> how are <p>you?</p>

Result:

how are
remove(expr)

remove(expr)

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.

Returns

jQuery

Parameters

  • expr (String): A jQuery expression to filter elements by.

Example

jQuery Code

$("p").remove(".hello");

Before

<p class="hello">Hello</p> how are <p>you?</p>

Result:

how are <p>you?</p>
wrap(html)

wrap(html)

Wrap all matched elements with a structure of other elements. This wrapping process is most useful for injecting additional stucture into a document, without ruining the original semantic qualities of a document.

This works by going through the first element provided (which is generated, on the fly, from the provided HTML) and finds the deepest ancestor element within its structure - it is that element that will en-wrap everything else.

This does not work with elements that contain text. Any necessary text must be added after the wrapping is done.

Returns

jQuery

Parameters

  • html (String): A string of HTML, that will be created on the fly and wrapped around the target.

Example

jQuery Code

$("p").wrap("<div class='wrap'></div>");

Before

<p>Test Paragraph.</p>

Result:

<div class='wrap'><p>Test Paragraph.</p></div>
wrap(elem)

wrap(elem)

Wrap all matched elements with a structure of other elements. This wrapping process is most useful for injecting additional stucture into a document, without ruining the original semantic qualities of a document.

This works by going through the first element provided and finding the deepest ancestor element within its structure - it is that element that will en-wrap everything else.

This does not work with elements that contain text. Any necessary text must be added after the wrapping is done.

Returns

jQuery

Parameters

  • elem (Element): A DOM element that will be wrapped.

Example

jQuery Code

$("p").wrap( document.getElementById('content') );

Before

<p>Test Paragraph.</p><div id="content"></div>

Result:

<div id="content"><p>Test Paragraph.</p></div>
Traversing
add(expr)

add(expr)

Adds the elements matched by the expression to the jQuery object. This can be used to concatenate the result sets of two expressions.

Returns

jQuery

Parameters

  • expr (String): An expression whose matched elements are added

Example

jQuery Code

$("p").add("span")

Before

<p>Hello</p><p><span>Hello Again</span></p>

Result:

[ <p>Hello</p>, <span>Hello Again</span> ]
add(els)

add(els)

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.

Returns

jQuery

Parameters

  • els (Array<Element>): An array of Elements to add

Example

jQuery Code

$("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> ]
add(el)

add(el)

Adds a single Element to the set of matched elements. This is used to add a single Element to a jQuery object.

Returns

jQuery

Parameters

  • el (Element): An Element to add

Example

jQuery Code

$("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> ]
ancestors()

ancestors()

Get a set of elements containing the unique ancestors of the matched set of elements (except for the root element).

Returns

jQuery

Example

jQuery Code

$("span").ancestors()

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> ]
ancestors(expr)

ancestors(expr)

Get a set of elements containing the unique ancestors of the matched set of elements, and filtered by an expression.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the ancestors with

Example

jQuery Code

$("span").ancestors("p")

Before

<html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>

Result:

[ <p><span>Hello</span></p> ]
children()

children()

Get a set of elements containing all of the unique children of each of the matched set of elements.

Returns

jQuery

Example

jQuery Code

$("div").children()

Before

<p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>

Result:

[ <span>Hello Again</span> ]
children(expr)

children(expr)

Get a set of elements containing all of the unique children of each of the matched set of elements, and filtered by an expression.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the child Elements with

Example

jQuery Code

$("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> ]
contains(str)

contains(str)

Filter the set of elements to those that contain the specified text.

Returns

jQuery

Parameters

  • str (String): The string that will be contained within the text of an element.

Example

jQuery Code

$("p").contains("test")

Before

<p>This is just a test.</p><p>So is this</p>

Result:

[ <p>This is just a test.</p> ]
end()

end()

End the most recent 'destructive' operation, reverting the list of matched elements back to its previous state. After an end operation, the list of matched elements will revert to the last state of matched elements.

Returns

jQuery

Example

jQuery Code

$("p").find("span").end();

Before

<p><span>Hello</span>, how are you?</p>

Result:

$("p").find("span").end() == [ <p>...</p> ]
filter(expr)

filter(expr)

Removes all elements from the set of matched elements that do not match the specified expression. 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.

Returns

jQuery

Parameters

  • expr (String): An expression to search with.

Example

jQuery Code

$("p").filter(".selected")

Before

<p class="selected">Hello</p><p>How are you?</p>

Result:

$("p").filter(".selected") == [ <p class="selected">Hello</p> ]
filter(exprs)

filter(exprs)

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.

Returns

jQuery

Parameters

  • exprs (Array<String>): A set of expressions to evaluate against

Example

jQuery Code

$("p").filter([".selected", ":first"])

Before

<p>Hello</p><p>Hello Again</p><p class="selected">And Again</p>

Result:

$("p").filter([".selected", ":first"]) == [ <p>Hello</p>, <p class="selected">And Again</p> ]
find(expr)

find(expr)

Searches for all elements that match the specified expression. This method is the optimal way of finding additional descendant elements with which to process.

All searching is done using a jQuery expression. The expression can be written using CSS 1-3 Selector syntax, or basic XPath.

Returns

jQuery

Parameters

  • expr (String): An expression to search with.

Example

jQuery Code

$("p").find("span");

Before

<p><span>Hello</span>, how are you?</p>

Result:

$("p").find("span") == [ <span>Hello</span> ]
is(expr)

is(expr)

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.

Returns

Boolean

Parameters

  • expr (String): The expression with which to filter

Example

Returns true, because the parent of the input is a form element

jQuery Code

$("input[@type='checkbox']").parent().is("form")

Before

<form><input type="checkbox" /></form>

Result:

true

Example

Returns false, because the parent of the input is a p element

jQuery Code

$("input[@type='checkbox']").parent().is("form")

Before

<form><p><input type="checkbox" /></p></form>

Result:

false

Example

An invalid expression always returns false.

jQuery Code

$("form").is(null)

Before

<form></form>

Result:

false
next()

next()

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.

Returns

jQuery

Example

jQuery Code

$("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> ]
next(expr)

next(expr)

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.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the next Elements with

Example

jQuery Code

$("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> ]
not(el)

not(el)

Removes the specified Element from the set of matched elements. This method is used to remove a single Element from a jQuery object.

Returns

jQuery

Parameters

  • el (Element): An element to remove from the set

Example

jQuery Code

$("p").not( document.getElementById("selected") )

Before

<p>Hello</p><p id="selected">Hello Again</p>

Result:

[ <p>Hello</p> ]
not(expr)

not(expr)

Removes elements matching the specified expression from the set of matched elements. This method is used to remove one or more elements from a jQuery object.

Returns

jQuery

Parameters

  • expr (String): An expression with which to remove matching elements

Example

jQuery Code

$("p").not("#selected")

Before

<p>Hello</p><p id="selected">Hello Again</p>

Result:

[ <p>Hello</p> ]
parent()

parent()

Get a set of elements containing the unique parents of the matched set of elements.

Returns

jQuery

Example

jQuery Code

$("p").parent()

Before

<div><p>Hello</p><p>Hello</p></div>

Result:

[ <div><p>Hello</p><p>Hello</p></div> ]
parent(expr)

parent(expr)

Get a set of elements containing the unique parents of the matched set of elements, and filtered by an expression.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the parents with

Example

jQuery Code

$("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> ]
parents()

parents()

Get a set of elements containing the unique ancestors of the matched set of elements (except for the root element).

Returns

jQuery

Example

jQuery Code

$("span").ancestors()

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> ]
parents(expr)

parents(expr)

Get a set of elements containing the unique ancestors of the matched set of elements, and filtered by an expression.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the ancestors with

Example

jQuery Code

$("span").ancestors("p")

Before

<html><body><div><p><span>Hello</span></p><span>Hello Again</span></div></body></html>

Result:

[ <p><span>Hello</span></p> ]
prev()

prev()

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.

Returns

jQuery

Example

jQuery Code

$("p").prev()

Before

<p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>

Result:

[ <div><span>Hello Again</span></div> ]
prev(expr)

prev(expr)

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.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the previous Elements with

Example

jQuery Code

$("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> ]
siblings()

siblings()

Get a set of elements containing all of the unique siblings of each of the matched set of elements.

Returns

jQuery

Example

jQuery Code

$("div").siblings()

Before

<p>Hello</p><div><span>Hello Again</span></div><p>And Again</p>

Result:

[ <p>Hello</p>, <p>And Again</p> ]
siblings(expr)

siblings(expr)

Get a set of elements containing all of the unique siblings of each of the matched set of elements, and filtered by an expression.

Returns

jQuery

Parameters

  • expr (String): An expression to filter the sibling Elements with

Example

jQuery Code

$("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> ]
addClass(class)

addClass(class)

Adds the specified class to each of the set of matched elements.

Returns

jQuery

Parameters

  • class (String): A CSS class to add to the elements

Example

jQuery Code

$("p").addClass("selected")

Before

<p>Hello</p>

Result:

[ <p class="selected">Hello</p> ]
attr(name)

attr(name)

Access a property on the first matched element. This method makes it easy to retrieve a property value from the first matched element.

Returns

Object

Parameters

  • name (String): The name of the property to access.

Example

jQuery Code

$("img").attr("src");

Before

<img src="test.jpg"/>

Result:

test.jpg
attr(prop)

attr(prop)

Set a hash of key/value object properties to all matched elements. This serves as the best way to set a large number of properties on all matched elements.

Returns

jQuery

Parameters

  • prop (Hash): A set of key/value pairs to set as object properties.

Example

jQuery Code

$("img").attr({ src: "test.jpg", alt: "Test Image" });

Before

<img/>

Result:

<img src="test.jpg" alt="Test Image"/>
attr(key, value)

attr(key, value)

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 on the fly including the name property.

Returns

jQuery

Parameters

  • key (String): The name of the property to set.
  • value (Object): The value to set the property to.

Example

jQuery Code

$("img").attr("src","test.jpg");

Before

<img/>

Result:

<img src="test.jpg"/>
removeAttr(name)

removeAttr(name)

Remove an attribute from each of the matched elements.

Returns

jQuery

Parameters

  • name (String): The name of the attribute to remove.

Example

jQuery Code

$("input").removeAttr("disabled")

Before

<input disabled="disabled"/>

Result:

<input/>
removeClass(class)

removeClass(class)

Removes the specified class from the set of matched elements.

Returns

jQuery

Parameters

  • class (String): A CSS class to remove from the elements

Example

jQuery Code

$("p").removeClass("selected")

Before

<p class="selected">Hello</p>

Result:

[ <p>Hello</p> ]
text()

text()

Retrieve 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.

Returns

String

Example

jQuery Code

$("p").text();

Before

<p>Test Paragraph.</p>

Result:

Test Paragraph.
toggleClass(class)

toggleClass(class)

Adds the specified class if it is not present, removes it if it is present.

Returns

jQuery

Parameters

  • class (String): A CSS class with which to toggle the elements

Example

jQuery Code

$("p").toggleClass("selected")

Before

<p>Hello</p><p class="selected">Hello Again</p>

Result:

[ <p class="selected">Hello</p>, <p>Hello Again</p> ]
CSS
background()

background()

Get the current CSS background of the first matched element.

Returns

String

Example

jQuery Code

$("p").background();

Before

<p style="background:blue;">This is just a test.</p>

Result:

"blue"
background(val)

background(val)

Set the CSS background of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").background("blue");

Before

<p>This is just a test.</p>

Result:

<p style="background:blue;">This is just a test.</p>
color()

color()

Get the current CSS color of the first matched element.

Returns

String

Example

jQuery Code

$("p").color();

Before

<p>This is just a test.</p>

Result:

"black"
color(val)

color(val)

Set the CSS color of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").color("blue");

Before

<p>This is just a test.</p>

Result:

<p style="color:blue;">This is just a test.</p>
css(name)

css(name)

Access a style property on the first matched element. This method makes it easy to retrieve a style property value from the first matched element.

Returns

Object

Parameters

  • name (String): The name of the property to access.

Example

Retrieves the color style of the first paragraph

jQuery Code

$("p").css("color");

Before

<p style="color:red;">Test Paragraph.</p>

Result:

red

Example

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.

jQuery Code

$("p").css("fontWeight");

Before

<p style="font-weight: bold;">Test Paragraph.</p>

Result:

bold
css(prop)

css(prop)

Set a hash of key/value style properties to all matched elements. This serves as the best way to set a large number of style properties on all matched elements.

Returns

jQuery

Parameters

  • prop (Hash): A set of key/value pairs to set as style properties.

Example

jQuery Code

$("p").css({ color: "red", background: "blue" });

Before

<p>Test Paragraph.</p>

Result:

<p style="color:red; background:blue;">Test Paragraph.</p>
css(key, value)

css(key, value)

Set a single style property to a value, on all matched elements.

Returns

jQuery

Parameters

  • key (String): The name of the property to set.
  • value (Object): The value to set the property to.

Example

Changes the color of all paragraphs to red

jQuery Code

$("p").css("color","red");

Before

<p>Test Paragraph.</p>

Result:

<p style="color:red;">Test Paragraph.</p>
float()

float()

Get the current CSS float of the first matched element.

Returns

String

Example

jQuery Code

$("p").float();

Before

<p>This is just a test.</p>

Result:

"none"
float(val)

float(val)

Set the CSS float of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").float("left");

Before

<p>This is just a test.</p>

Result:

<p style="float:left;">This is just a test.</p>
height()

height()

Get the current CSS height of the first matched element.

Returns

String

Example

jQuery Code

$("p").height();

Before

<p>This is just a test.</p>

Result:

"14px"
height(val)

height(val)

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.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").height("20px");

Before

<p>This is just a test.</p>

Result:

<p style="height:20px;">This is just a test.</p>
left()

left()

Get the current CSS left of the first matched element.

Returns

String

Example

jQuery Code

$("p").left();

Before

<p>This is just a test.</p>

Result:

"0px"
left(val)

left(val)

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.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").left("20px");

Before

<p>This is just a test.</p>

Result:

<p style="left:20px;">This is just a test.</p>
overflow()

overflow()

Get the current CSS overflow of the first matched element.

Returns

String

Example

jQuery Code

$("p").overflow();

Before

<p>This is just a test.</p>

Result:

"none"
overflow(val)

overflow(val)

Set the CSS overflow of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").overflow("auto");

Before

<p>This is just a test.</p>

Result:

<p style="overflow:auto;">This is just a test.</p>
position()

position()

Get the current CSS position of the first matched element.

Returns

String

Example

jQuery Code

$("p").position();

Before

<p>This is just a test.</p>

Result:

"static"
position(val)

position(val)

Set the CSS position of every matched element.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").position("relative");

Before

<p>This is just a test.</p>

Result:

<p style="position:relative;">This is just a test.</p>
top()

top()

Get the current CSS top of the first matched element.

Returns

String

Example

jQuery Code

$("p").top();

Before

<p>This is just a test.</p>

Result:

"0px"
top(val)

top(val)

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.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").top("20px");

Before

<p>This is just a test.</p>

Result:

<p style="top:20px;">This is just a test.</p>
width()

width()

Get the current CSS width of the first matched element.

Returns

String

Example

jQuery Code

$("p").width();

Before

<p>This is just a test.</p>

Result:

"300px"
width(val)

width(val)

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.

Returns

jQuery

Parameters

  • val (String): Set the CSS property to the specified value.

Example

jQuery Code

$("p").width("20px");

Before

<p>This is just a test.</p>

Result:

<p style="width:20px;">This is just a test.</p>
Javascript
$.browser

$.browser

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.

There are situations where object detections is not reliable enough, in that cases it makes sense to use browser detection. Simply try to avoid both!

A combination of browser and object detection yields quite reliable results.

Returns

Boolean

Example

Returns true if the current useragent is some version of microsoft's internet explorer

jQuery Code

$.browser.msie

Example

Alerts "this is safari!" only for safari browsers

jQuery Code

if($.browser.safari) { $( function() { alert("this is safari!"); } ); }
$.each(obj, fn)

$.each(obj, fn)

A generic iterator function, which can be used to seemlessly iterate over both objects and arrays. This function is not the same as $().each() - which is used to iterate, exclusively, over a jQuery object. This function can be used to iterate over anything.

Returns

Object

Parameters

  • obj (Object): The object, or array, to iterate over.
  • fn (Function): The function that will be executed on every object.

Example

This is an example of iterating over the items in an array, accessing both the current item and its index.

jQuery Code

$.each( [0,1,2], function(i){
  alert( "Item #" + i + ": " + this );
});

Example

This is an example of iterating over the properties in an Object, accessing both the current item and its key.

jQuery Code

$.each( { name: "John", lang: "JS" }, function(i){
  alert( "Name: " + i + ", Value: " + this );
});
$.extend(target, prop1, propN)

$.extend(target, prop1, propN)

Extend one object with one or more others, returning the original, modified, object. This is a great utility for simple inheritance.

Returns

Object

Parameters

  • target (Object): The object to extend
  • prop1 (Object): The object that will be merged into the first.
  • propN (Object): (optional) More objects to merge into the first

Example

Merge settings and options, modifying settings

jQuery Code

var settings = { validate: false, limit: 5, name: "foo" };
var options = { validate: true, name: "bar" };
jQuery.extend(settings, options);

Result:

settings == { validate: true, limit: 5, name: "bar" }

Example

Merge defaults and options, without modifying the defaults

jQuery Code

var defaults = { validate: false, limit: 5, name: "foo" };
var options = { validate: true, name: "bar" };
var settings = jQuery.extend({}, defaults, options);

Result:

settings == { validate: true, limit: 5, name: "bar" }
$.grep(array, fn, inv)

$.grep(array, fn, inv)

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.

Returns

Array

Parameters

  • array (Array): The Array to find items in.
  • fn (Function): The function to process each item against.
  • inv (Boolean): Invert the selection - select the opposite of the function.

Example

jQuery Code

$.grep( [0,1,2], function(i){
  return i > 0;
});

Result:

[1, 2]
$.map(array, fn)

$.map(array, fn)

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.

Returns

Array

Parameters

  • array (Array): The Array to translate.
  • fn (Function): The function to process each item against.

Example

jQuery Code

$.map( [0,1,2], function(i){
  return i + 4;
});

Result:

[4, 5, 6]

Example

jQuery Code

$.map( [0,1,2], function(i){
  return i > 0 ? i + 1 : null;
});

Result:

[2, 3]

Example

jQuery Code

$.map( [0,1,2], function(i){
  return [ i, i + 1 ];
});

Result:

[0, 1, 1, 2, 2, 3]
$.merge(first, second)

$.merge(first, second)

Merge two arrays together, removing all duplicates. The final order or the new array is: All the results from the first array, followed by the unique results from the second array.

Returns

Array

Parameters

  • first (Array): The first array to merge.
  • second (Array): The second array to merge.

Example

jQuery Code

$.merge( [0,1,2], [2,3,4] )

Result:

[0,1,2,3,4]

Example

jQuery Code

$.merge( [3,2,1], [4,3,2] )

Result:

[3,2,1,4]
$.trim(str)

$.trim(str)

Remove the whitespace from the beginning and end of a string.

Returns

String

Parameters

  • str (String): The string to trim.

Example

jQuery Code

$.trim("  hello, how are you?  ");

Result:

"hello, how are you?"
Effects
Animations
animate(params, speed, callback)

animate(params, speed, callback)

A function for making your own, custom, animations. The key aspect of this function is the object of style properties that will be animated, and to what end. Each key within the object represents a style property that will also be animated (for example: "height", "top", or "opacity").

The value associated with the key represents to what end the property will be animated. If a number is provided as the value, then the style property will be transitioned from its current state to that new number. Oterwise if the string "hide", "show", or "toggle" is provided, a default animation will be constructed for that property.

Returns

jQuery

Parameters

  • params (Hash): A set of style attributes that you wish to animate, and to what end.
  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
  • callback (Function): A function to be executed whenever the animation completes.

Example

jQuery Code

$("p").animate({
  height: 'toggle', opacity: 'toggle'
}, "slow");

Example

jQuery Code

$("p").animate({
  left: 50, opacity: 'show'
}, 500);
fadeIn(speed)

fadeIn(speed)

Fade in all matched elements by adjusting their opacity. Only the opacity is adjusted for this animation, meaning that all of the matched elements should already have some form of height and width associated with them.

Returns

jQuery

Parameters

  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).

Example

jQuery Code

$("p").fadeIn("slow");
fadeIn(speed, callback)

fadeIn(speed, callback)

Fade in all matched elements by adjusting their opacity and firing a callback function after completion. Only the opacity is adjusted for this animation, meaning that all of the matched elements should already have some form of height and width associated with them.

Returns

jQuery

Parameters

  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
  • callback (Function): A function to be executed whenever the animation completes.

Example

jQuery Code

$("p").fadeIn("slow",function(){
  alert("Animation Done.");
});
fadeOut(speed)

fadeOut(speed)

Fade out all matched elements by adjusting their opacity. Only the opacity is adjusted for this animation, meaning that all of the matched elements should already have some form of height and width associated with them.

Returns

jQuery

Parameters

  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).

Example

jQuery Code

$("p").fadeOut("slow");
fadeOut(speed, callback)

fadeOut(speed, callback)

Fade out all matched elements by adjusting their opacity and firing a callback function after completion. Only the opacity is adjusted for this animation, meaning that all of the matched elements should already have some form of height and width associated with them.

Returns

jQuery

Parameters

  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
  • callback (Function): A function to be executed whenever the animation completes.

Example

jQuery Code

$("p").fadeOut("slow",function(){
  alert("Animation Done.");
});
fadeTo(speed, opacity)

fadeTo(speed, opacity)

Fade the opacity of all matched elements to a specified opacity. Only the opacity is adjusted for this animation, meaning that all of the matched elements should already have some form of height and width associated with them.

Returns

jQuery

Parameters

  • speed (Object): A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).
  • opacity (Number): The opacity to fade to (a number from 0 to 1).

Example

jQuery Code

$("p").fadeTo("slow", 0.5);
fadeTo(spe