A selector is used in jQuery to select DOM elements from a DOM document. That document is, in most cases, the DOM document present in all browsers, but can also be an XML document received via Ajax.
The jQuery special event hooks are a set of per-event-name functions and properties that allow code to control the behavior of event processing within jQuery. The mechanism is similar to fixHooks in that the special event information is stored in jQuery.event.special.NAME, where NAME is the name of the special event. Event names are case sensitive.
As with fixHooks, the special event hooks design assumes it will be very rare that two unrelated pieces of code want to process the same event name. Special event authors who need to modify events with existing hooks will need to take precautions to avoid introducing unwanted side-effects by clobbering those hooks.
A "Tweener" is a function responsible for creating a tween object, and you might want to override these if you want to implement complex values ( like a clip/transform array matrix ) in a single property.
A string is designated htmlString in jQuery documentation when it is used to represent one or more DOM elements, typically to be created and inserted in the document. When passed as an argument of the jQuery() function, the string is identified as HTML if it starts with <tag ... >) and is parsed as such until the final > character. Prior to jQuery 1.9, a string was considered to be HTML if it contained <tag ... > anywhere within the string.
A string containing the jQuery version number.
The number of elements in the jQuery object.
Create a new jQuery object with elements added 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.
Create a new jQuery object with elements added to the set of matched elements.
@param selector_elements_html_selection
selector — A string representing a selector expression to find additional elements to add to the set of matched elements. elements — One or more elements to add to the set of matched elements. html — An HTML fragment to add to the set of matched elements. selection — 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.
A string containing a selector expression to match the current set of elements against.
Adds the specified class(es) to each element in the set of matched elements.
@param className_function
className — One or more space-separated classes to be added to the class attribute of each matched element. function — A function returning one or more space-separated class names to be added to the existing class name(s). Receives the index position of the element in the set and the existing class name(s) as
arguments. Within the function, `this` refers to the current element in the set.Insert content, specified by the parameter, after each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, 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 function_functionｰhtml
function — A function that returns an HTML string, DOM element(s), text node(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. <br>functionｰhtml — A function that returns an HTML string, DOM element(s), text node(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 and the old HTML value of the element as arguments. 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
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.
Perform a custom animation of a set of CSS properties.
An object of CSS properties and values that the animation will move toward.
A function to call once the animation is complete, called once per matched element.
Insert content, specified by the parameter, to the end of each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, 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.
A function that returns an HTML string, DOM element(s), text node(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.
Set one or more attributes for the set of matched elements.
The name of the attribute to set.
@param value_function
value — A value to set for the attribute. If null, the specified attribute will be removed (as in `.removeAttr()`). function — 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.
Get the value of an attribute for the first element in the set of matched elements.
The name of the attribute to get.
Insert content, specified by the parameter, before each element in the set of matched elements.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, 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 function_functionｰhtml
function — A function that returns an HTML string, DOM element(s), text node(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. <br>functionｰhtml — A function that returns an HTML string, DOM element(s), text node(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 and the old HTML value of the element as arguments. 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.
@param handler_preventBubble
handler — A function to execute each time the event is triggered. preventBubble — 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.
Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
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.
Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Create a deep copy of the set of matched elements.
A Boolean indicating whether event handlers and data should be copied along with the elements. The default value is false. *In jQuery 1.5.0 the default value was incorrectly true; it was changed back to false in 1.5.1 and up.
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.
A DOM element within which a matching element may be found.
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.
@param selector_selection_element
selector — A string containing a selector expression to match elements against. selection — A jQuery object to match elements against. element — An element to match elements against.Get the children of each element in the set of matched elements, including text and comment nodes.
Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "contextmenu" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Set one or more CSS properties for the set of matched elements.
A CSS property name.
@param value_function
value — A value to set for the property. function — 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.
Get the computed style properties for the first element in the set of matched elements.
A CSS property.
Get the computed style properties for the first element in the set of matched elements.
An array of one or more CSS properties.
Store arbitrary data associated with the matched elements.
A string naming the piece of data to set.
The new data value; this can be any Javascript type except undefined.
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.
Name of the data stored.
undefined is not recognized as a data value. Calls such as .data( "name", undefined )
will return the jQuery object that it was called on, allowing for chaining.
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.
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.
Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
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.
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.
A selector to filter the elements that trigger the event.
A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," 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 one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.
A selector to filter the elements that trigger the event.
A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.
A function to execute each time the event is triggered.
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.
A selector to filter the elements that trigger the event.
A plain object of one or more event types and functions to execute for them.
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.
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. An integer indicating the position of the element, counting backwards from the last element in the set.
Reduce the set of matched elements to the even ones in the set, numbered from zero.
Merge the contents of an object onto the jQuery prototype to provide new jQuery instance methods.
An object to merge onto the jQuery prototype.
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, called once per matched element.
Display the matched elements by fading them to opaque.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display the matched elements by fading them to opaque.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Hide the matched elements by fading them to transparent.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Hide the matched elements by fading them to transparent.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
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, called once per matched element.
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, called once per matched element.
Display or hide the matched elements by animating their opacity.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements by animating their opacity.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — 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.
@param selector_elements_selection_function
selector — A string containing a selector expression to match the current set of elements against. elements — One or more DOM elements to match the current set of elements against. selection — An existing jQuery object to match the current set of elements against. function — A function used as a test for each element in the set. this is the current DOM element.Get the descendants of each element in the current set of matched elements, filtered by a selector, jQuery object, or element.
@param selector_element
selector — A string containing a selector expression to match elements against. element — An element or 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.
Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "focusin" event.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "focusin" 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.
Bind an event handler to the "focusout" JavaScript event.
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.
@param selector_contained
selector — A string containing a selector expression to match elements against. contained — 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.
Set the CSS height of every matched element.
@param value_function
value — An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string). <br>function — 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.Get the current computed height for the first element in the set of matched elements.
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, called once per matched element.
Hide the matched elements.
A string or number determining how long the animation will run.
@param easing_complete
easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element.Hide the matched elements.
@param duration_complete_options
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — 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.
Set the HTML contents of each element in the set of matched elements.
@param htmlString_function
htmlString — A string of HTML to set as the content of each matched element. function — 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.Get the HTML contents of the first element in the set of matched elements.
Search for a given element from among the matched elements.
@param selector_element
selector — A selector representing a jQuery collection in which to look for an element. element — The DOM element or first element within the jQuery object to look for.Set the CSS inner height of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string). <br>function — A function returning the inner height (including padding but not border) to set. Receives the index position of the element in the set and the old inner height as arguments. Within the function, `this`
refers to the current element in the set.Get the current computed height for the first element in the set of matched elements, including padding but not border.
Set the CSS inner width of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string). <br>function — A function returning the inner width (including padding but not border) to set. Receives the index position of the element in the set and the old inner width as arguments. Within the function, `this`
refers to the current element in the set.Get the current computed inner width for the first element in the set of matched elements, including padding but not border.
Insert every element in the set of matched elements after the 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.
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.
@param selector_function_selection_elements
selector — A string containing a selector expression to match elements against. function — A function used as a test for every element in the set. It accepts two arguments, index, which is the element's index in the jQuery collection, and `element`, which is the DOM element. Within the
function, `this` refers to the current DOM element. <br>selection — An existing jQuery object to match the current set of elements against. elements — One or more elements to match the current set of elements against.Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
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.
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.
@param complete_data
complete — A callback function that is executed when the request completes. data — A plain object or string that is sent to the server with the request.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.
Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
A function to execute each time 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.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching following sibling elements. element — 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.
@param selector_function_selection
selector — A string containing a selector expression, a DOM element, or an array of elements to match against the set. function — A function used as a test for each element in the set. It accepts two arguments, index, which is the element's index in the jQuery collection, and `element`, which is the DOM element. Within the
function, `this` refers to the current DOM element. <br>selection — An existing jQuery object to match the current set of elements against.Reduce the set of matched elements to the odd ones in the set, numbered from zero.
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 function to execute each time the event is triggered.
Remove an event handler.
One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".
@param selector_handler
selector — A selector which should match the one originally passed to .on() when attaching event handlers. handler — 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.
Remove an event handler.
A jQuery.Event object.
Set the current coordinates of every element in the set of matched elements, relative to the document.
@param coordinates_function
coordinates — An object containing the properties top and left, which are numbers indicating the new top and left coordinates for the elements. <br>function — 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 current coordinates of the first element in the set of matched elements, relative to the document.
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 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.
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.
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.
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".
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when the event is triggered.
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".
@param selector_data
selector — 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. <br>data — Data to be passed to the handler in event.data when an event is triggered.A function to execute when the event is triggered.
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.
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.
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).
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).
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.
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 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).
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.
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.
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".
Data to be passed to the handler in event.data when an event is triggered.
A function to execute when 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 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).
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).
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.
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.
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).
Set the CSS outer height of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string). <br>function — A function returning the outer height to set. Receives the index position of the element in the set and the old outer height as arguments. Within the function, `this` refers to the current element in
the set.Get the current computed outer height (including padding, border, and optionally margin) for the first element in the set of matched elements.
A Boolean indicating whether to include the element's margin in the calculation.
Set the CSS outer width of each element in the set of matched elements.
@param value_function
value — A number representing the number of pixels, or a number along with an optional unit of measure appended (as a string). <br>function — A function returning the outer width to set. Receives the index position of the element in the set and the old outer width as arguments. Within the function, `this` refers to the current element in
the set.Get the current computed outer width (including padding, border, and optionally margin) for the first element in the set of matched elements.
A Boolean indicating whether to include the element's margin in the calculation.
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.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching ancestor elements. element — 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.
One or more additional DOM elements, text nodes, arrays of elements and text nodes, 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.
A function that returns an HTML string, DOM element(s), text node(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. If a selector is provided, it retrieves the previous sibling only if it matches that 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.
@param selector_element
selector — A string containing a selector expression to indicate where to stop matching preceding sibling elements. element — 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.
Object onto which the promise methods have to be attached
Return a Promise object to observe when all actions of a certain type bound to the collection, queued or not, have finished.
Object onto which the promise methods have to be attached
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.
Set one or more properties for the set of matched elements.
The name of the property to set.
@param value_function
value — A value to set for the property. function — 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.Set one or more properties for the set of matched elements.
An object of property-value pairs to set.
Get the value of a property for the first element in the set of matched elements.
The name of the property to get.
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).
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.
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. 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. An array of functions to replace the current queue contents.
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.
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.
@param className_function
className — One or more space-separated classes to be removed from the class attribute of each matched element. function — A function returning one or more space-separated class names to be removed. Receives the index position of the element in the set and the old class value as arguments.Remove a previously-stored piece of data.
A string naming the piece of data to delete. An array or space-separated string naming the pieces of data to delete.
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_function
newContent — The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object. function — A function that returns content with which to replace the set of matched elements.Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
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 horizontal position of the scroll bar for the first element in the set of matched elements.
Set the current vertical position of the scroll bar for each of the set of matched elements.
A number 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.
Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display the matched elements.
A string or number determining how long the animation will run.
@param easing_complete
easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element.Display the matched elements.
@param duration_complete_options
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Display or hide the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — 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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
Hide the matched elements with a sliding motion.
@param duration_easing
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition.A function to call once the animation is complete, called once per matched element.
Hide the matched elements with a sliding motion.
@param duration_easing_complete_options
duration — A string or number determining how long the animation will run. easing — A string indicating which easing function to use for the transition. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method.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.
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.
Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
An object containing data that will be passed to the event handler.
A function to execute each time the event is triggered.
Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
A function to execute each time the event is triggered.
Set the content of each element in the set of matched elements to the specified text.
@param text_function
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. <br>function — 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.Get the combined text contents of each element in the set of matched elements, including their descendants.
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 string indicating which easing function to use for the transition.
A function to call once the animation is complete, called once per matched element.
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, called once per matched element.
Display or hide the matched elements.
@param duration_complete_options_display
duration — A string or number determining how long the animation will run. complete — A function to call once the animation is complete, called once per matched element. options — A map of additional options to pass to the method. display — Use true to show the element or false to hide it.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.
@param className_function
className — One or more class names (separated by spaces) to be toggled for each element in the matched set. function — 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 state as arguments.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 state argument.
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.
@param eventType_event
eventType — A string containing a JavaScript event type, such as click or submit. event — A `jQuery.Event` object.Additional parameters to pass along to the event handler.
Execute all handlers attached to an element for an event.
@param eventType_event
eventType — A string containing a JavaScript event type, such as click or submit. event — A `jQuery.Event` object.Additional parameters to pass along to the event handler.
Remove a previously-attached event handler from 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.
Remove a previously-attached event handler from the elements.
A string containing one or more DOM event types, such as "click" or "submit," or custom event names. A jQuery.Event object.
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 each 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.
@param eventType_events
eventType — A string containing a JavaScript event type, such as "click" or "keydown" events — 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 selector which will be used to filter the event results.
Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place.
A selector to check the parent element against. If an element's parent does not match the selector, the element won't be unwrapped.
Set the value of each element in the set of matched elements.
@param value_function
value — A string of text, a number, or an array of strings corresponding to the value of each matched element to set as selected/checked. <br>function — 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 value of the first element in the set of matched elements.
Set the CSS width of each element in the set of matched elements.
@param value_function
value — An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string). <br>function — 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.Get the current computed width for the first element in the set of matched elements.
Wrap an HTML structure around each element in the set of matched elements.
@param wrappingElement_function
wrappingElement — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements. When you pass a jQuery collection containing more than one element, or a selector
matching more than one element, the first element will be used. <br>function — 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.
@param wrappingElement_function
wrappingElement — A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements. function — A callback function returning the HTML content or jQuery object to wrap around all the matched elements. Within the function, `this` refers to the first element in the set. **Prior to jQuery
3.0**, the callback was incorrectly called for every element in the set and received the index
position of the element in the set as an argument.Wrap an HTML structure around the content of each element in the set of matched elements.
@param wrappingElement_function
wrappingElement — An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements. <br>function — 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.
Deprecated since 1.8. Use `{@link Tween.propHooks jQuery.Tween.propHooks}`.
jQuery.fx.stepfunctions are being replaced byjQuery.Tween.propHooksand may eventually be removed, but are still supported via the default tween propHook.