W3cubDocs

/jQuery

jQuery

jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. If you're new to jQuery, we recommend that you check out the jQuery Learning Center.

If you're updating to a newer version of jQuery, be sure to read the release notes published on our blog. If you're coming from a version prior 1.9, you should check out the 1.9 Upgrade Guide as well.

Note that this is the API documentation for jQuery core. Other projects have API docs in other locations:

.add()

Create a new jQuery object with elements added to the set of matched elements.

.addBack()

Add the previous set of elements on the stack to the current set, optionally filtered by a selector.

.addClass()

Adds the specified class(es) to each element in the set of matched elements.

.after()

Insert content, specified by the parameter, after each element in the set of matched elements.

.ajaxComplete()

Register a handler to be called when Ajax requests complete. This is an AjaxEvent.

.ajaxError()

Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.

.ajaxSend()

Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.

.ajaxStart()

Register a handler to be called when the first Ajax request begins. This is an Ajax Event.

.ajaxStop()

Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.

.ajaxSuccess()

Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.

.andSelf()

Add the previous set of elements on the stack to the current set.

.animate()

Perform a custom animation of a set of CSS properties.

:animated Selector

Select all elements that are in the progress of an animation at the time the selector is run.

.append()

Insert content, specified by the parameter, to the end of each element in the set of matched elements.

.appendTo()

Insert every element in the set of matched elements to the end of the target.

.attr()

Get the value of an attribute for the first element in the set of matched elements or set one or more attributes for every matched element.

.before()

Insert content, specified by the parameter, before each element in the set of matched elements.

.bind()

Attach a handler to an event for the elements.

.blur()

Bind an event handler to the “blur” JavaScript event, or trigger that event on an element.

callbacks.add()

Add a callback or a collection of callbacks to a callback list.

callbacks.fired()

Determine if the callbacks have already been called at least once.

callbacks.has()

Determine whether or not the list has any callbacks attached. If a callback is provided as an argument, determine whether it is in a list.

.change()

Bind an event handler to the “change” JavaScript event, or trigger that event on an element.

.children()

Get the children of each element in the set of matched elements, optionally filtered by a selector.

.clearQueue()

Remove from the queue all items that have not yet been run.

.click()

Bind an event handler to the “click” JavaScript event, or trigger that event on an element.

.clone()

Create a deep copy of the set of matched elements.

.closest()

For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

.contents()

Get the children of each element in the set of matched elements, including text and comment nodes.

.context

The DOM node context originally passed to jQuery(); if none was passed then context will likely be the document.

.contextmenu()

Bind an event handler to the “contextmenu” JavaScript event, or trigger that event on an element.

.css()

Get the value of a computed style property for the first element in the set of matched elements or set one or more CSS properties for every matched element.

.data()

Store arbitrary data associated with the matched elements or return the value at the named data store for the first element in the set of matched elements.

.dblclick()

Bind an event handler to the “dblclick” JavaScript event, or trigger that event on an element.

deferred.always()

Add handlers to be called when the Deferred object is either resolved or rejected.

deferred.catch()

Add handlers to be called when the Deferred object is rejected.

deferred.done()

Add handlers to be called when the Deferred object is resolved.

deferred.fail()

Add handlers to be called when the Deferred object is rejected.

deferred.notify()

Call the progressCallbacks on a Deferred object with the given args.

deferred.progress()

Add handlers to be called when the Deferred object generates progress notifications.

deferred.reject()

Reject a Deferred object and call any failCallbacks with the given args.

deferred.rejectWith()

Reject a Deferred object and call any failCallbacks with the given context and args.

deferred.resolve()

Resolve a Deferred object and call any doneCallbacks with the given args.

deferred.resolveWith()

Resolve a Deferred object and call any doneCallbacks with the given context and args.

deferred.then()

Add handlers to be called when the Deferred object is resolved, rejected, or still in progress.

.delay()

Set a timer to delay execution of subsequent items in the queue.

.delegate()

Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.

.dequeue()

Execute the next function on the queue for the matched elements.

.detach()

Remove the set of matched elements from the DOM.

.die()

Remove event handlers previously attached using .live() from the elements.

.each()

Iterate over a jQuery object, executing a function for each matched element.

.empty()

Remove all child nodes of the set of matched elements from the DOM.

:empty Selector

Select all elements that have no children (including text nodes).

.end()

End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.

.eq()

Reduce the set of matched elements to the one at the specified index.

:eq() Selector

Select the element at index n within the matched set.

.error()

Bind an event handler to the “error” JavaScript event.

.even()

Reduce the set of matched elements to the even ones in the set, numbered from zero.

event.data

An optional object of data passed to an event method when the current executing handler is bound.

event.metaKey

Indicates whether the META key was pressed when the event fired.

event.pageX

The mouse position relative to the left edge of the document.

event.pageY

The mouse position relative to the top edge of the document.

event.result

The last value returned by an event handler that was triggered by this event, unless the value was undefined.

event.stopPropagation()

Prevents the event from bubbling up the DOM tree, preventing any parent handlers from being notified of the event.

event.timeStamp

The difference in milliseconds between the time the browser created the event and January 1, 1970.

event.which

For key or mouse events, this property indicates the specific key or button that was pressed.

.fadeIn()

Display the matched elements by fading them to opaque.

.fadeOut()

Hide the matched elements by fading them to transparent.

.fadeTo()

Adjust the opacity of the matched elements.

.fadeToggle()

Display or hide the matched elements by animating their opacity.

.filter()

Reduce the set of matched elements to those that match the selector or pass the function’s test.

.find()

Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.

.finish()

Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.

.first()

Reduce the set of matched elements to the first in the set.

.focus()

Bind an event handler to the “focus” JavaScript event, or trigger that event on an element.

.focusin()

Bind an event handler to the “focusin” event.

.focusout()

Bind an event handler to the “focusout” JavaScript event.

.get()

Retrieve the DOM elements matched by the jQuery object.

:gt() Selector

Select all elements at an index greater than index within the matched set.

.has()

Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.

:has() Selector

Selects elements which contain at least one element that matches the specified selector.

.hasClass()

Determine whether any of the matched elements are assigned the given class.

:header Selector

Selects all elements that are headers, like h1, h2, h3 and so on.

.height()

Get the current computed height for the first element in the set of matched elements or set the height of every matched element.

.hide()

Hide the matched elements.

.hover()

Bind one or two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.

.html()

Get the HTML contents of the first element in the set of matched elements or set the HTML contents of every matched element.

.index()

Search for a given element from among the matched elements.

.innerHeight()

Get the current computed inner height (including padding but not border) for the first element in the set of matched elements or set the inner height of every matched element.

.innerWidth()

Get the current computed inner width (including padding but not border) for the first element in the set of matched elements or set the inner width of every matched element.

.insertAfter()

Insert every element in the set of matched elements after the target.

.insertBefore()

Insert every element in the set of matched elements before the target.

.is()

Check the current matched set of elements against a selector, element, or jQuery object and return true if at least one of these elements matches the given arguments.

jQuery()

Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.

.jquery

A string containing the jQuery version number.

jQuery.ajaxPrefilter()

Handle custom Ajax options or modify existing options before each request is sent and before they are processed by $.ajax().

jQuery.ajaxSetup()

Set default values for future Ajax requests. Its use is not recommended.

jQuery.boxModel

States if the current page, in the user’s browser, is being rendered using the W3C CSS Box Model.

jQuery.browser

Contains flags for the useragent, read from navigator.userAgent. This property was removed in jQuery 1.9 and is available only through the jQuery.migrate plugin. Please try to use feature detection instead.

jQuery.Callbacks()

A multi-purpose callbacks list object that provides a powerful way to manage callback lists.

jQuery.contains()

Check to see if a DOM element is a descendant of another DOM element.

jQuery.cssHooks

Hook directly into jQuery to override how particular CSS properties are retrieved or set, normalize CSS property naming, or create custom properties.

jQuery.cssNumber

An object containing all CSS properties that may be used without a unit. The .css() method uses this object to see if it may append px to unitless values.

jQuery.data()

Store arbitrary data associated with the specified element and/or return the value that was set.

jQuery.Deferred()

A factory function that returns a chainable utility object with methods to register multiple callbacks into callback queues, invoke callback queues, and relay the success or failure state of any synchronous or asynchronous function.

jQuery.dequeue()

Execute the next function on the queue for the matched element.

jQuery.each()

A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function’s arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties.

jQuery.error()

Takes a string and throws an exception containing it.

jQuery.extend()

Merge the contents of two or more objects together into the first object.

jQuery.fn.extend()

Merge the contents of an object onto the jQuery prototype to provide new jQuery instance methods.

jQuery.get()

Load data from the server using a HTTP GET request.

jQuery.getJSON()

Load JSON-encoded data from the server using a GET HTTP request.

jQuery.getScript()

Load a JavaScript file from the server using a GET HTTP request, then execute it.

jQuery.grep()

Finds the elements of an array which satisfy a filter function. The original array is not affected.

jQuery.hasData()

Determine whether an element has any jQuery data associated with it.

jQuery.inArray()

Search for a specified value within an array and return its index (or -1 if not found).

jQuery.isPlainObject()

Check to see if an object is a plain object (created using “{}” or “new Object”).

jQuery.isXMLDoc()

Check to see if a DOM node is within an XML document (or is an XML document).

jQuery.map()

Translate all items in an array or object to new array of items.

jQuery.merge()

Merge the contents of two arrays together into the first array.

jQuery.now()

Return a number representing the current time.

jQuery.param()

Create a serialized representation of an array, a plain object, or a jQuery object suitable for use in a URL query string or Ajax request. In case a jQuery object is passed, it should contain input elements with name/value properties.

jQuery.parseJSON()

Takes a well-formed JSON string and returns the resulting JavaScript value.

jQuery.post()

Send data to the server using a HTTP POST request.

jQuery.proxy()

Takes a function and returns a new one that will always have a particular context.

jQuery.queue()

Show or manipulate the queue of functions to be executed on the matched element.

jQuery.ready

A Promise-like object (or “thenable”) that resolves when the document is ready.

jQuery.speed

Creates an object containing a set of properties ready to be used in the definition of custom animations.

jQuery.sub()

Creates a new copy of jQuery whose properties and methods can be modified without affecting the original jQuery object.

jQuery.support

A collection of properties that represent the presence of different browser features or bugs. Intended for jQuery’s internal use; specific properties may be removed when they are no longer needed internally to improve page startup performance. For your own project’s feature-detection needs, we strongly recommend the use of an external library such as Modernizr instead of dependency on properties in jQuery.support.

jQuery.trim()

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

jQuery.type()

Determine the internal JavaScript [[Class]] of an object.

jQuery.unique()

Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.

jQuery.uniqueSort()

Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers.

jQuery.when()

Provides a way to execute callback functions based on zero or more Thenable objects, usually Deferred objects that represent asynchronous events.

.keydown()

Bind an event handler to the “keydown” JavaScript event, or trigger that event on an element.

.keypress()

Bind an event handler to the “keypress” JavaScript event, or trigger that event on an element.

.keyup()

Bind an event handler to the “keyup” JavaScript event, or trigger that event on an element.

.last()

Reduce the set of matched elements to the final one in the set.

.length

The number of elements in the jQuery object.

.live()

Attach an event handler for all elements which match the current selector, now and in the future.

.load()

Load data from the server and place the returned HTML into the matched elements.

.load()

Bind an event handler to the “load” JavaScript event.

:lt() Selector

Select all elements at an index less than index within the matched set.

.map()

Pass each element in the current matched set through a function, producing a new jQuery object containing the return values.

.mousedown()

Bind an event handler to the “mousedown” JavaScript event, or trigger that event on an element.

.mouseenter()

Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.

.mouseleave()

Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.

.mousemove()

Bind an event handler to the “mousemove” JavaScript event, or trigger that event on an element.

.mouseout()

Bind an event handler to the “mouseout” JavaScript event, or trigger that event on an element.

.mouseover()

Bind an event handler to the “mouseover” JavaScript event, or trigger that event on an element.

.mouseup()

Bind an event handler to the “mouseup” JavaScript event, or trigger that event on an element.

.next()

Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector.

.nextAll()

Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.

.nextUntil()

Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.

.not()

Remove elements from the set of matched elements.

:not() Selector

Selects all elements that do not match the given selector.

:nth-last-child() Selector

Selects all elements that are the nth-child of their parent, counting from the last element to the first.

:nth-last-of-type() Selector

Selects all the elements that are the nth-child of their parent in relation to siblings with the same element name, counting from the last element to the first.

:nth-of-type() Selector

Selects all elements that are the nth child of their parent in relation to siblings with the same element name.

.odd()

Reduce the set of matched elements to the odd ones in the set, numbered from zero.

:odd Selector

Selects odd elements, zero-indexed. See also :even.

.off()

Remove an event handler.

.offset()

Get the current coordinates of the first element, or set the coordinates of every element, in the set of matched elements, relative to the document.

.on()

Attach an event handler function for one or more events to the selected elements.

.one()

Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

.outerHeight()

Get the current computed outer height (including padding, border, and optionally margin) for the first element in the set of matched elements or set the outer height of every matched element.

.outerWidth()

Get the current computed outer width (including padding, border, and optionally margin) for the first element in the set of matched elements or set the outer width of every matched element.

.parent()

Get the parent of each element in the current set of matched elements, optionally filtered by a selector.

:parent Selector

Select all elements that have at least one child node (either an element or text).

.parents()

Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.

.parentsUntil()

Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector, DOM node, or jQuery object.

.position()

Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.

.prepend()

Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.

.prependTo()

Insert every element in the set of matched elements to the beginning of the target.

.prev()

Get the immediately preceding sibling of each element in the set of matched elements. If a selector is provided, it retrieves the previous sibling only if it matches that selector.

.prevAll()

Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.

.prevUntil()

Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.

.promise()

Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.

.prop()

Get the value of a property for the first element in the set of matched elements or set one or more properties for every matched element.

.pushStack()

Add a collection of DOM elements onto the jQuery stack.

.queue()

Show or manipulate the queue of functions to be executed on the matched elements.

.ready()

Specify a function to execute when the DOM is fully loaded.

.remove()

Remove the set of matched elements from the DOM.

.removeAttr()

Remove an attribute from each element in the set of matched elements.

.removeClass()

Remove a single class, multiple classes, or all classes from each element in the set of matched elements.

.removeProp()

Remove a property for the set of matched elements.

.replaceAll()

Replace each target element with the set of matched elements.

.replaceWith()

Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.

.resize()

Bind an event handler to the “resize” JavaScript event, or trigger that event on an element.

:root Selector

Selects the element that is the root of the document.

.scroll()

Bind an event handler to the “scroll” JavaScript event, or trigger that event on an element.

.scrollLeft()

Get the current horizontal position of the scroll bar for the first element in the set of matched elements or set the horizontal position of the scroll bar for every matched element.

.scrollTop()

Get the current vertical position of the scroll bar for the first element in the set of matched elements or set the vertical position of the scroll bar for every matched element.

.select()

Bind an event handler to the “select” JavaScript event, or trigger that event on an element.

.selector

A selector representing selector passed to jQuery(), if any, when creating the original set.

.serialize()

Encode a set of form elements as a string for submission.

.show()

Display the matched elements.

.siblings()

Get the siblings of each element in the set of matched elements, optionally filtered by a selector.

.size()

Return the number of elements in the jQuery object.

.slice()

Reduce the set of matched elements to a subset specified by a range of indices.

.slideDown()

Display the matched elements with a sliding motion.

.slideToggle()

Display or hide the matched elements with a sliding motion.

.slideUp()

Hide the matched elements with a sliding motion.

.stop()

Stop the currently-running animation on the matched elements.

.submit()

Bind an event handler to the “submit” JavaScript event, or trigger that event on an element.

:target Selector

Selects the target element indicated by the fragment identifier of the document’s URI.

.text()

Get the combined text contents of each element in the set of matched elements, including their descendants, or set the text contents of the matched elements.

.toArray()

Retrieve all the elements contained in the jQuery set, as an array.

.toggle()

Display or hide the matched elements.

.toggle()

Bind two or more handlers to the matched elements, to be executed on alternate clicks.

.toggleClass()

Add or remove one or more classes from each element in the set of matched elements, depending on either the class’s presence or the value of the state argument.

.trigger()

Execute all handlers and behaviors attached to the matched elements for the given event type.

.unbind()

Remove a previously-attached event handler from the elements.

.undelegate()

Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

.unload()

Bind an event handler to the “unload” JavaScript event.

.unwrap()

Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.

.val()

Get the current value of the first element in the set of matched elements or set the value of every matched element.

.width()

Get the current computed width for the first element in the set of matched elements or set the width of every matched element.

.wrap()

Wrap an HTML structure around each element in the set of matched elements.

.wrapAll()

Wrap an HTML structure around all elements in the set of matched elements.

.wrapInner()

Wrap an HTML structure around the content of each element in the set of matched elements.

© The jQuery Foundation and other contributors
Licensed under the MIT License.
https://api.jquery.com/