The jQuery instance members
The DOM node context originally passed to jQuery(); if none was passed then context will likely be the document. (DEPRECATED from v1.10)
The number of elements in the jQuery object.
A selector representing selector passed to jQuery(), if any, when creating the original set. version deprecated: 1.7, removed: 1.9
Add elements to the set of matched elements.
A string representing a selector expression to find additional elements to add to the set of matched elements.
The point in the document at which the selector should begin matching; similar to the context argument of the $(selector, context) method.
Add elements to the set of matched elements.
One or more elements to add to the set of matched elements.
Add elements to the set of matched elements.
An HTML fragment to add to the set of matched elements.
Add elements to the set of matched elements.
An existing jQuery object to add to the set of matched elements.
Add the previous set of elements on the stack to the current set, optionally filtered by a selector.
Adds the specified class(es) to each of the set of matched elements.
One or more space-separated classes to be added to the class attribute of each matched element.
Adds the specified class(es) to each of the set of matched elements.
Insert content, specified by the parameter, after each element in the set of matched elements.
param content1 HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert after each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert after each element in the set of matched elements.
Insert content, specified by the parameter, after each element in the set of matched elements.
param func A function that returns an HTML string, DOM element(s), or jQuery object to insert after each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.
Register a handler to be called when Ajax requests complete. This is an AjaxEvent.
The function to be invoked.
Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.
The function to be invoked.
Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.
The function to be invoked.
Register a handler to be called when the first Ajax request begins. This is an Ajax Event.
The function to be invoked.
Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.
The function to be invoked.
Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.
The function to be invoked.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition. (default: swing)
A function to call once the animation is complete.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A map of additional options to pass to the method.
Insert content, specified by the parameter, to the end of each element in the set of matched elements.
param content1 DOM element, DocumentFragment, array of elements, HTML string, or jQuery object to insert at the end of each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert at the end of each element in the set of matched elements.
Insert content, specified by the parameter, to the end of each element in the set of matched elements.
param func A function that returns an HTML string, DOM element(s), or jQuery object to insert at the end of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, this refers to the current element in the set.
Insert every element in the set of matched elements to the end of the target.
A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter.
Get the value of an attribute for the first element in the set of matched elements.
The name of the attribute to get.
Set one or more attributes for the set of matched elements.
The name of the attribute to set.
A value to set for the attribute.
Set one or more attributes for the set of matched elements.
The name of the attribute to set.
A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old attribute value as arguments.
Set one or more attributes for the set of matched elements.
An object of attribute-value pairs to set.
Insert content, specified by the parameter, before each element in the set of matched elements.
param content1 HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert before each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert before each element in the set of matched elements.
Insert content, specified by the parameter, before each element in the set of matched elements.
param func A function that returns an HTML string, DOM element(s), or jQuery object to insert before each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.
Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
A function to execute each time the event is triggered.
Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
An object containing data that will be passed to the event handler.
Setting the third argument to false will attach a function that prevents the default action from occurring and stops the event from bubbling. The default is true.
Attach a handler to an event for the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names.
Setting the third argument to false will attach a function that prevents the default action from occurring and stops the event from bubbling. The default is true.
Attach a handler to an event for the elements.
An object containing one or more DOM event types and functions to execute for them.
Trigger the "blur" event on an element
Bind an event handler to the "blur" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "blur" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "change" event on an element.
Bind an event handler to the "change" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "change" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Get the children of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Remove from the queue all items that have not yet been run.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Trigger the "click" event on an element.
Bind an event handler to the "click" JavaScript event
Bind an event handler to the "click" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Create a deep copy of the set of matched elements.
param withDataAndEvents A Boolean indicating whether event handlers and data should be copied along with the elements. The default value is false. param deepWithDataAndEvents A Boolean indicating whether event handlers and data for all children of the cloned element should be copied. By default its value matches the first argument's value (which defaults to false).
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.
A string containing a selector expression to match elements against.
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.
A string containing a selector expression to match elements against.
A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.
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.
A jQuery object to match elements against.
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.
An element to match elements against.
Get an array of all the elements and selectors matched against the current element up through the DOM tree.
An array or string containing a selector expression to match elements against (can also be a jQuery object).
A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.
Get the children of each element in the set of matched elements, including text and comment nodes.
Trigger the "contextmenu" event on an element.
Bind an event handler to the "contextmenu" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "contextmenu" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Get the value of style properties for the first element in the set of matched elements.
A CSS property.
Set one or more CSS properties for the set of matched elements.
A CSS property name.
A value to set for the property.
Set one or more CSS properties for the set of matched elements.
A CSS property name.
A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old value as arguments.
Set one or more CSS properties for the set of matched elements.
An object of property-value pairs to set.
Store arbitrary data associated with the matched elements.
A string naming the piece of data to set.
The new data value; it can be any Javascript type including Array or Object.
Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.
Name of the data stored.
Store arbitrary data associated with the matched elements.
An object of key-value pairs of data to update.
Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.
Trigger the "dblclick" event on an element.
Bind an event handler to the "dblclick" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "dblclick" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Set a timer to delay execution of subsequent items in the queue.
An integer indicating the number of milliseconds to delay execution of the next item in the queue.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Execute the next function on the queue for the matched elements.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Remove the set of matched elements from the DOM.
param selector A selector expression that filters the set of matched elements to be removed.
Iterate over a jQuery object, executing a function for each matched element.
A function to execute for each matched element.
Remove all child nodes of the set of matched elements from the DOM.
End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
Reduce the set of matched elements to the one at the specified index.
An integer indicating the 0-based position of the element. OR An integer indicating the position of the element, counting backwards from the last element in the set.
Bind an event handler to the "error" JavaScript event. (DEPRECATED from v1.8)
A function to execute when the event is triggered.
Bind an event handler to the "error" JavaScript event. (DEPRECATED from v1.8)
A plain object of data that will be passed to the event handler.
A function to execute when the event is triggered.
Display the matched elements by fading them to opaque.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display the matched elements by fading them to opaque.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display the matched elements by fading them to opaque.
A map of additional options to pass to the method.
Hide the matched elements by fading them to transparent.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Hide the matched elements by fading them to transparent.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Hide the matched elements by fading them to transparent.
A map of additional options to pass to the method.
Adjust the opacity of the matched elements.
A string or number determining how long the animation will run.
A number between 0 and 1 denoting the target opacity.
A function to call once the animation is complete.
Adjust the opacity of the matched elements.
A string or number determining how long the animation will run.
A number between 0 and 1 denoting the target opacity.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display or hide the matched elements by animating their opacity.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display or hide the matched elements by animating their opacity.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display or hide the matched elements by animating their opacity.
A map of additional options to pass to the method.
Reduce the set of matched elements to those that match the selector or pass the function's test.
A string containing a selector expression to match the current set of elements against.
Reduce the set of matched elements to those that match the selector or pass the function's test.
A function used as a test for each element in the set. this is the current DOM element.
Reduce the set of matched elements to those that match the selector or pass the function's test.
An element to match the current set of elements against.
Reduce the set of matched elements to those that match the selector or pass the function's test.
An existing jQuery object to match the current set of elements against.
Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
A string containing a selector expression to match elements against.
Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
An element to match elements against.
Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
A jQuery object to match elements against.
Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.
The name of the queue in which to stop animations.
Reduce the set of matched elements to the first in the set.
Trigger the "focus" event on an element.
Bind an event handler to the "focus" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "focus" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "focusin" event on an element.
Bind an event handler to the "focusin" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "focusin" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "focusout" event on an element.
Bind an event handler to the "focusout" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "focusout" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Retrieve one of the elements matched by the jQuery object.
A zero-based integer indicating which element to retrieve.
Retrieve the elements matched by the jQuery object.
Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
A string containing a selector expression to match elements against.
Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
A DOM element to match elements against.
Determine whether any of the matched elements are assigned the given class.
The class name to search for.
Get the current computed height for the first element in the set of matched elements.
Set the CSS height of every matched element.
An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string).
Set the CSS height of every matched element.
A function returning the height to set. Receives the index position of the element in the set and the old height as arguments. Within the function, this refers to the current element in the set.
Hide the matched elements.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Hide the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Hide the matched elements.
A map of additional options to pass to the method.
Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.
A function to execute when the mouse pointer enters the element.
A function to execute when the mouse pointer leaves the element.
Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements.
A function to execute when the mouse pointer enters or leaves the element.
Get the HTML contents of the first element in the set of matched elements.
Set the HTML contents of each element in the set of matched elements.
A string of HTML to set as the content of each matched element.
Set the HTML contents of each element in the set of matched elements.
A function returning the HTML content to set. Receives the index position of the element in the set and the old HTML value as arguments. jQuery empties the element before calling the function; use the oldhtml argument to reference the previous content. Within the function, this refers to the current element in the set.
Search for a given element from among the matched elements.
Search for a given element from among the matched elements.
A selector representing a jQuery collection in which to look for an element.
Get the current computed height for the first element in the set of matched elements, including padding but not border.
Sets the inner height on elements in the set of matched elements, including padding but not border.
Get the current computed width for the first element in the set of matched elements, including padding but not border.
Sets the inner width on elements in the set of matched elements, including padding but not border.
Insert every element in the set of matched elements after the target.
param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter.
Insert every element in the set of matched elements before the target.
param target A selector, element, array of elements, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter.
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.
A string containing a selector expression to match elements against.
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.
A function used as a test for the set of elements. It accepts one argument, index, which is the element's index in the jQuery collection.Within the function, this refers to the current DOM element.
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.
An existing jQuery object to match the current set of elements against.
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.
One or more elements to match the current set of elements against.
Trigger the "keydown" event on an element.
Bind an event handler to the "keydown" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "keydown" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "keypress" event on an element.
Bind an event handler to the "keypress" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "keypress" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "keyup" event on an element.
Bind an event handler to the "keyup" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "keyup" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Reduce the set of matched elements to the final one in the set.
Load data from the server and place the returned HTML into the matched element.
A string containing the URL to which the request is sent.
A plain object or string that is sent to the server with the request.
A callback function that is executed when the request completes.
Bind an event handler to the "load" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "load" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Pass each element in the current matched set through a function, producing a new jQuery object containing the return values.
A function object that will be invoked for each element in the current set.
Trigger the "mousedown" event on an element.
Bind an event handler to the "mousedown" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "mousedown" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mouseenter" event on an element.
Bind an event handler to be fired when the mouse enters an element.
A function to execute when the event is triggered.
Bind an event handler to be fired when the mouse enters an element.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mouseleave" event on an element.
Bind an event handler to be fired when the mouse leaves an element.
A function to execute when the event is triggered.
Bind an event handler to be fired when the mouse leaves an element.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mousemove" event on an element.
Bind an event handler to the "mousemove" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "mousemove" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mouseout" event on an element.
Bind an event handler to the "mouseout" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "mouseout" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mouseover" event on an element.
Bind an event handler to the "mouseover" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "mouseover" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
Trigger the "mouseup" event on an element.
Bind an event handler to the "mouseup" JavaScript event.
A function to execute when the event is triggered.
Bind an event handler to the "mouseup" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute when the event is triggered.
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.
A string containing a selector expression to match elements against.
Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.
A string containing a selector expression to indicate where to stop matching following sibling elements.
A string containing a selector expression to match elements against.
Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.
A DOM node or jQuery object indicating where to stop matching following sibling elements.
A string containing a selector expression to match elements against.
Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.
A DOM node or jQuery object indicating where to stop matching following sibling elements.
A string containing a selector expression to match elements against.
Remove elements from the set of matched elements.
A string containing a selector expression to match elements against.
Remove elements from the set of matched elements.
A function used as a test for each element in the set. this is the current DOM element.
Remove elements from the set of matched elements.
One or more DOM elements to remove from the matched set.
Remove elements from the set of matched elements.
An existing jQuery object to match the current set of elements against.
Remove an event handler.
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
A selector which should match the one originally passed to .on() when attaching event handlers.
A handler function previously attached for the event(s), or the special value false.
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
A handler function previously attached for the event(s), or the special value false. Takes handler with extra args that can be attached with on().
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
A handler function previously attached for the event(s), or the special value false.
Remove an event handler.
An object where the string keys represent one or more space-separated event types and optional namespaces, and the values represent handler functions previously attached for the event(s).
A selector which should match the one originally passed to .on() when attaching event handlers.
Get the current coordinates of the first element in the set of matched elements, relative to the document.
An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.
An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.
An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.
A function to return the coordinates to set. Receives the index of the element in the collection as the first argument and the current coordinates as the second argument. The function should return an object with the new top and left properties.
Get the closest ancestor element that is positioned.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false. Rest parameter args is for optional parameters passed to jQuery.trigger(). Note that the actual parameters on the event handler function must be marked as optional (? syntax).
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach an event handler function for one or more events to the selected elements.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach an event handler function for one or more events to the selected elements.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Data to be passed to the handler in event.data when an event occurs.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
A function to execute at the time the event is triggered.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
An object containing data that will be passed to the event handler.
A function to execute at the time the event is triggered.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".
A selector string to filter the descendants of the selected elements that trigger the event. If the selector is null or omitted, the event is always triggered when it reaches the selected element.
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered. The value false is also allowed as a shorthand for a function that simply does return false.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
A selector string to filter the descendants of the selected elements that will call the handler. If the selector is null or omitted, the handler is always called when it reaches the selected element.
Data to be passed to the handler in event.data when an event occurs.
Attach a handler to an event for the elements. The handler is executed at most once per element per event type.
An object in which the string keys represent one or more space-separated event types and optional namespaces, and the values represent a handler function to be called for the event(s).
Data to be passed to the handler in event.data when an event occurs.
Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. Returns an integer (without "px") representation of the value or null if called on an empty set of elements.
A Boolean indicating whether to include the element's margin in the calculation.
Sets the outer height on elements in the set of matched elements, including padding and border.
Get the current computed width for the first element in the set of matched elements, including padding and border.
A Boolean indicating whether to include the element's margin in the calculation.
Sets the outer width on elements in the set of matched elements, including padding and border.
Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
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.
A string containing a selector expression to indicate where to stop matching ancestor elements.
A string containing a selector expression to match elements against.
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.
A DOM node or jQuery object indicating where to stop matching ancestor elements.
A string containing a selector expression to match elements against.
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.
A DOM node or jQuery object indicating where to stop matching ancestor elements.
A string containing a selector expression to match elements against.
Get the current coordinates of the first element in the set of matched elements, relative to the offset parent.
Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.
param content1 DOM element, DocumentFragment, array of elements, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements. param content2 One or more additional DOM elements, arrays of elements, HTML strings, or jQuery objects to insert at the beginning of each element in the set of matched elements.
Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.
param func A function that returns an HTML string, DOM element(s), or jQuery object to insert at the beginning of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, this refers to the current element in the set.
Insert every element in the set of matched elements to the beginning of the target.
A selector, element, HTML string, array of elements, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter.
Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.
A string containing a selector expression to indicate where to stop matching preceding sibling elements.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.
A DOM node or jQuery object indicating where to stop matching preceding sibling elements.
A string containing a selector expression to match elements against.
Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.
A DOM node or jQuery object indicating where to stop matching preceding sibling elements.
A string containing a selector expression to match elements against.
Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.
The type of queue that needs to be observed. (default: fx)
Object onto which the promise methods have to be attached
Get the value of a property for the first element in the set of matched elements.
The name of the property to get.
Set one or more properties for the set of matched elements.
The name of the property to set.
A value to set for the property.
Set one or more properties for the set of matched elements.
An object of property-value pairs to set.
Set one or more properties for the set of matched elements.
The name of the property to set.
A function returning the value to set. Receives the index position of the element in the set and the old property value as arguments. Within the function, the keyword this refers to the current element.
Add a collection of DOM elements onto the jQuery stack.
An array of elements to push onto the stack and make into a new jQuery object.
Add a collection of DOM elements onto the jQuery stack.
An array of elements to push onto the stack and make into a new jQuery object.
The name of a jQuery method that generated the array of elements.
The arguments that were passed in to the jQuery method (for serialization).
Show the queue of functions to be executed on the matched elements.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
Manipulate the queue of functions to be executed, once for each matched element.
An array of functions to replace the current queue contents.
Manipulate the queue of functions to be executed, once for each matched element.
The new function to add to the queue, with a function to call that will dequeue the next item.
Manipulate the queue of functions to be executed, once for each matched element.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
An array of functions to replace the current queue contents.
Manipulate the queue of functions to be executed, once for each matched element.
A string containing the name of the queue. Defaults to fx, the standard effects queue.
The new function to add to the queue, with a function to call that will dequeue the next item.
Specify a function to execute when the DOM is fully loaded.
A function to execute after the DOM is ready.
Remove the set of matched elements from the DOM.
A selector expression that filters the set of matched elements to be removed.
Remove an attribute from each element in the set of matched elements.
An attribute to remove; as of version 1.7, it can be a space-separated list of attributes.
Remove a single class, multiple classes, or all classes from each element in the set of matched elements.
One or more space-separated classes to be removed from the class attribute of each matched element.
Remove a single class, multiple classes, or all classes from each element in the set of matched elements.
Remove a previously-stored piece of data.
A string naming the piece of data to delete or space-separated string naming the pieces of data to delete.
Remove a previously-stored piece of data.
An array of strings naming the pieces of data to delete.
Remove all previously-stored piece of data.
Remove a property for the set of matched elements.
The name of the property to remove.
Replace each target element with the set of matched elements.
A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace.
Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.
param newContent The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object.
Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.
param func A function that returns content with which to replace the set of matched elements.
Trigger the "resize" event on an element.
Bind an event handler to the "resize" JavaScript event.
A function to execute each time the event is triggered.
Bind an event handler to the "resize" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Trigger the "scroll" event on an element.
Bind an event handler to the "scroll" JavaScript event.
A function to execute each time the event is triggered.
Bind an event handler to the "scroll" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
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.
Set the current horizontal position of the scroll bar for each of the set of matched elements.
An integer indicating the new position to set the scroll bar to.
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.
Set the current vertical position of the scroll bar for each of the set of matched elements.
An integer indicating the new position to set the scroll bar to.
Trigger the "select" event on an element.
Bind an event handler to the "select" JavaScript event.
A function to execute each time the event is triggered.
Bind an event handler to the "select" JavaScript event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Encode a set of form elements as a string for submission.
Encode a set of form elements as an array of names and values.
Display the matched elements.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display the matched elements.
A map of additional options to pass to the method.
Get the siblings of each element in the set of matched elements, optionally filtered by a selector.
A string containing a selector expression to match elements against.
Reduce the set of matched elements to a subset specified by a range of indices.
An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set.
An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set.
Display the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display the matched elements with a sliding motion.
A map of additional options to pass to the method.
Display or hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display or hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display or hide the matched elements with a sliding motion.
A map of additional options to pass to the method.
Hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Hide the matched elements with a sliding motion.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Hide the matched elements with a sliding motion.
A map of additional options to pass to the method.
Stop the currently-running animation on the matched elements.
A Boolean indicating whether to remove queued animation as well. Defaults to false.
A Boolean indicating whether to complete the current animation immediately. Defaults to false.
Stop the currently-running animation on the matched elements.
The name of the queue in which to stop animations.
A Boolean indicating whether to remove queued animation as well. Defaults to false.
A Boolean indicating whether to complete the current animation immediately. Defaults to false.
Trigger the "submit" event on an element.
Bind an event handler to the "submit" JavaScript event
A function to execute each time the event is triggered.
Bind an event handler to the "submit" JavaScript event
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Get the combined text contents of each element in the set of matched elements, including their descendants.
Set the content of each element in the set of matched elements to the specified text.
The text to set as the content of each matched element. When Number or Boolean is supplied, it will be converted to a String representation.
Set the content of each element in the set of matched elements to the specified text.
A function returning the text content to set. Receives the index position of the element in the set and the old text value as arguments.
Retrieve all the elements contained in the jQuery set, as an array.
Display or hide the matched elements.
A string or number determining how long the animation will run.
A function to call once the animation is complete.
Display or hide the matched elements.
A string or number determining how long the animation will run.
A string indicating which easing function to use for the transition.
A function to call once the animation is complete.
Display or hide the matched elements.
A map of additional options to pass to the method.
Display or hide the matched elements.
A Boolean indicating whether to show or hide the elements.
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 switch argument.
One or more class names (separated by spaces) to be toggled for each element in the matched set.
A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.
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 switch argument.
A boolean value to determine whether the class should be added or removed.
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 switch argument.
A function that returns class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the switch as arguments.
A boolean value to determine whether the class should be added or removed.
Execute all handlers and behaviors attached to the matched elements for the given event type.
A string containing a JavaScript event type, such as click or submit.
Additional parameters to pass along to the event handler.
Execute all handlers and behaviors attached to the matched elements for the given event type.
A jQuery.Event object.
Additional parameters to pass along to the event handler.
Execute all handlers attached to an element for an event.
A string containing a JavaScript event type, such as click or submit.
An array of additional parameters to pass along to the event handler.
Execute all handlers attached to an element for an event.
A jQuery.Event object.
An array of additional parameters to pass along to the event handler.
Remove a previously-attached event handler from the elements.
A string containing a JavaScript event type, such as click or submit.
The function that is to be no longer executed.
Remove a previously-attached event handler from the elements.
A string containing a JavaScript event type, such as click or submit.
Unbinds the corresponding 'return false' function that was bound using .bind( eventType, false ).
Remove a previously-attached event handler from the elements.
A JavaScript event object as passed to an event handler.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A selector which will be used to filter the event results.
A string containing a JavaScript event type, such as "click" or "keydown"
A function to execute at the time the event is triggered.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A selector which will be used to filter the event results.
An object of one or more event types and previously bound functions to unbind from them.
Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.
A string containing a namespace to unbind all events from.
Bind an event handler to the "unload" JavaScript event. (DEPRECATED from v1.8)
A function to execute when the event is triggered.
Bind an event handler to the "unload" JavaScript event. (DEPRECATED from v1.8)
A plain object of data that will be passed to the event handler.
A function to execute when the event is triggered.
Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.
Get the current value of the first element in the set of matched elements.
Set the value of each element in the set of matched elements.
A string of text, an array of strings or number corresponding to the value of each matched element to set as selected/checked.
Set the value of each element in the set of matched elements.
A function returning the value to set. this is the current element. Receives the index position of the element in the set and the old value as arguments.
Get the current computed width for the first element in the set of matched elements.
Set the CSS width of each element in the set of matched elements.
An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).
Set the CSS width of each element in the set of matched elements.
A function returning the width to set. Receives the index position of the element in the set and the old width as arguments. Within the function, this refers to the current element in the set.
Wrap an HTML structure around each element in the set of matched elements.
A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.
Wrap an HTML structure around each element in the set of matched elements.
A callback function returning the HTML content or jQuery object to wrap around the matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.
Wrap an HTML structure around all elements in the set of matched elements.
A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.
Wrap an HTML structure around the content of each element in the set of matched elements.
An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements.
Wrap an HTML structure around the content of each element in the set of matched elements.
A callback function which generates a structure to wrap around the content of the matched elements. Receives the index position of the element in the set as an argument. Within the function, this refers to the current element in the set.
Generated using TypeDoc
The jQuery instance members