WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

The jQuery instance members

see

https://api.jquery.com/Types/#jQuery

Hierarchy

  • JQuery

Indexable

[index: number]: HTMLElement

The jQuery instance members

Index

Properties

context

context: Element

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

see

https://api.jquery.com/context/

jquery

jquery: string

length

length: number

The number of elements in the jQuery object.

see

https://api.jquery.com/length/

selector

selector: string

A selector representing selector passed to jQuery(), if any, when creating the original set. version deprecated: 1.7, removed: 1.9

see

https://api.jquery.com/selector/

Methods

add

  • Add elements to the set of matched elements.

    see

    https://api.jquery.com/add/#add-selector

    Parameters

    • selector: string

      A string representing a selector expression to find additional elements to add to the set of matched elements.

    • Optional context: Element

      The point in the document at which the selector should begin matching; similar to the context argument of the $(selector, context) method.

    Returns JQuery

  • Add elements to the set of matched elements.

    see

    https://api.jquery.com/add/#add-elements

    Parameters

    • Rest ...elements: Element[]

      One or more elements to add to the set of matched elements.

    Returns JQuery

  • Add elements to the set of matched elements.

    see

    https://api.jquery.com/add/#add-html

    Parameters

    • html: string

      An HTML fragment to add to the set of matched elements.

    Returns JQuery

  • Add elements to the set of matched elements.

    see

    https://api.jquery.com/add/#add-selection

    Parameters

    • obj: JQuery

      An existing jQuery object to add to the set of matched elements.

    Returns JQuery

addBack

  • addBack(selector?: string): JQuery
  • Add the previous set of elements on the stack to the current set, optionally filtered by a selector.

    see

    https://api.jquery.com/addBack/

    Parameters

    • Optional selector: string

    Returns JQuery

addClass

  • addClass(className: string): JQuery
  • addClass(func: function): JQuery
  • Adds the specified class(es) to each of the set of matched elements.

    see

    https://api.jquery.com/addClass/#addClass-className

    Parameters

    • className: string

      One or more space-separated classes to be added to the class attribute of each matched element.

    Returns JQuery

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

    see

    https://api.jquery.com/addClass/#addClass-function

    Parameters

    • func: 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.

        • (index: number, className: string): string
        • Parameters

          • index: number
          • className: string

          Returns string

    Returns JQuery

after

  • after(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • after(func: function): JQuery
  • Insert content, specified by the parameter, after each element in the set of matched elements.

    see

    https://api.jquery.com/after/#after-content-content

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string

      HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert after each element in the set of matched elements.

    • Rest ...content2: any[]

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/after/#after-function

    Parameters

    • func: function

      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.

        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

ajaxComplete

  • ajaxComplete(handler: function): JQuery
  • Register a handler to be called when Ajax requests complete. This is an AjaxEvent.

    see

    https://api.jquery.com/ajaxComplete/

    Parameters

    • handler: function

      The function to be invoked.

        • Parameters

          Returns any

    Returns JQuery

ajaxError

  • ajaxError(handler: function): JQuery

ajaxSend

  • ajaxSend(handler: function): JQuery

ajaxStart

  • ajaxStart(handler: function): JQuery
  • Register a handler to be called when the first Ajax request begins. This is an Ajax Event.

    see

    https://api.jquery.com/ajaxStart/

    Parameters

    • handler: function

      The function to be invoked.

        • (): any
        • Returns any

    Returns JQuery

ajaxStop

  • ajaxStop(handler: function): JQuery
  • Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.

    see

    https://api.jquery.com/ajaxStop/

    Parameters

    • handler: function

      The function to be invoked.

        • (): any
        • Returns any

    Returns JQuery

ajaxSuccess

  • ajaxSuccess(handler: function): JQuery

animate

  • animate(properties: Object, duration?: string | number, complete?: Function): JQuery
  • animate(properties: Object, duration?: string | number, easing?: string, complete?: Function): JQuery
  • animate(properties: Object, options: JQueryAnimationOptions): JQuery
  • Perform a custom animation of a set of CSS properties.

    see

    https://api.jquery.com/animate/#animate-properties-duration-easing-complete

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • Optional duration: string | number

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Perform a custom animation of a set of CSS properties.

    see

    https://api.jquery.com/animate/#animate-properties-duration-easing-complete

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • Optional duration: string | number

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition. (default: swing)

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Perform a custom animation of a set of CSS properties.

    see

    https://api.jquery.com/animate/#animate-properties-options

    Parameters

    • properties: Object

      An object of CSS properties and values that the animation will move toward.

    • options: JQueryAnimationOptions

      A map of additional options to pass to the method.

    Returns JQuery

append

  • append(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • append(func: function): JQuery
  • Insert content, specified by the parameter, to the end of each element in the set of matched elements.

    see

    https://api.jquery.com/append/#append-content-content

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string

      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.

    • Rest ...content2: any[]

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/append/#append-function

    Parameters

    • func: function

      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.

        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

appendTo

  • appendTo(target: JQuery | any[] | Element | string): JQuery
  • Insert every element in the set of matched elements to the end of the target.

    see

    https://api.jquery.com/appendTo/

    Parameters

    • target: JQuery | any[] | Element | string

      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.

    Returns JQuery

attr

  • attr(attributeName: string): string
  • attr(attributeName: string, value: string | number | null): JQuery
  • attr(attributeName: string, func: function): JQuery
  • attr(attributes: Object): JQuery
  • Get the value of an attribute for the first element in the set of matched elements.

    see

    https://api.jquery.com/attr/#attr-attributeName

    Parameters

    • attributeName: string

      The name of the attribute to get.

    Returns string

  • Set one or more attributes for the set of matched elements.

    see

    https://api.jquery.com/attr/#attr-attributeName-value

    Parameters

    • attributeName: string

      The name of the attribute to set.

    • value: string | number | null

      A value to set for the attribute. If this is null, the attribute will be deleted.

    Returns JQuery

  • Set one or more attributes for the set of matched elements.

    see

    https://api.jquery.com/attr/#attr-attributeName-function

    Parameters

    • attributeName: string

      The name of the attribute to set.

    • func: 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.

        • (index: number, attr: string): string | number
        • Parameters

          • index: number
          • attr: string

          Returns string | number

    Returns JQuery

  • Set one or more attributes for the set of matched elements.

    see

    https://api.jquery.com/attr/#attr-attributes

    Parameters

    • attributes: Object

      An object of attribute-value pairs to set.

    Returns JQuery

before

  • before(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • before(func: function): JQuery
  • Insert content, specified by the parameter, before each element in the set of matched elements.

    see

    https://api.jquery.com/before/#before-content-content

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string

      HTML string, DOM element, DocumentFragment, array of elements, or jQuery object to insert before each element in the set of matched elements.

    • Rest ...content2: any[]

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/before/#before-function

    Parameters

    • func: function

      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.

        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

bind

  • bind(eventType: string, eventData: any, handler: function): JQuery
  • bind(eventType: string, handler: function): JQuery
  • bind(eventType: string, eventData: any, preventBubble: boolean): JQuery
  • bind(eventType: string, preventBubble: boolean): JQuery
  • bind(events: any): JQuery
  • Attach a handler to an event for the elements.

    see

    https://api.jquery.com/bind/#bind-eventType-eventData-handler

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • eventData: any

      An object containing data that will be passed to the event handler.

    • handler: function

      A function to execute each time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements.

    see

    https://api.jquery.com/bind/#bind-eventType-eventData-handler

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • handler: function

      A function to execute each time the event is triggered.

    Returns JQuery

  • Attach a handler to an event for the elements.

    see

    https://api.jquery.com/bind/#bind-eventType-eventData-preventBubble

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • eventData: any

      An object containing data that will be passed to the event handler.

    • preventBubble: boolean

      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.

    Returns JQuery

  • Attach a handler to an event for the elements.

    see

    https://api.jquery.com/bind/#bind-eventType-eventData-preventBubble

    Parameters

    • eventType: string

      A string containing one or more DOM event types, such as "click" or "submit," or custom event names.

    • preventBubble: boolean

      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.

    Returns JQuery

  • Attach a handler to an event for the elements.

    see

    https://api.jquery.com/bind/#bind-events

    Parameters

    • events: any

      An object containing one or more DOM event types and functions to execute for them.

    Returns JQuery

blur

  • blur(): JQuery
  • blur(handler: function): JQuery
  • blur(eventData?: any, handler?: function): JQuery

change

  • change(): JQuery
  • change(handler: function): JQuery
  • change(eventData?: any, handler?: function): JQuery

children

  • children(selector?: string): JQuery
  • Get the children of each element in the set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/children/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

clearQueue

  • clearQueue(queueName?: string): JQuery
  • Remove from the queue all items that have not yet been run.

    see

    https://api.jquery.com/clearQueue/

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

click

  • click(): JQuery
  • click(handler: function): JQuery
  • click(eventData?: any, handler?: function): JQuery

clone

  • clone(withDataAndEvents?: boolean, deepWithDataAndEvents?: boolean): JQuery
  • Create a deep copy of the set of matched elements.

    see

    https://api.jquery.com/clone/

    Parameters

    • Optional withDataAndEvents: boolean

      A Boolean indicating whether event handlers and data should be copied along with the elements. The default value is false.

    • Optional deepWithDataAndEvents: boolean

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

    Returns JQuery

closest

  • closest(selector: string): JQuery
  • closest(selector: string, context?: Element): JQuery
  • closest(obj: JQuery): JQuery
  • closest(element: Element): JQuery
  • closest(selectors: any, context?: Element): any[]
  • 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.

    see

    https://api.jquery.com/closest/#closest-selector

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/closest/#closest-selector-context

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    • Optional context: Element

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/closest/#closest-selection

    Parameters

    • obj: JQuery

      A jQuery object to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/closest/#closest-element

    Parameters

    • element: Element

      An element to match elements against.

    Returns JQuery

  • Get an array of all the elements and selectors matched against the current element up through the DOM tree.

    see

    https://api.jquery.com/closest/#closest-selectors-context

    Parameters

    • selectors: any

      An array or string containing a selector expression to match elements against (can also be a jQuery object).

    • Optional context: Element

      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.

    Returns any[]

contents

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

    see

    https://api.jquery.com/contents/

    Returns JQuery

contextmenu

  • contextmenu(): JQuery
  • contextmenu(handler: function): JQuery
  • contextmenu(eventData: Object, handler: function): JQuery

css

  • css(propertyName: string): string
  • css(propertyName: string, value: string | number): JQuery
  • css(propertyName: string, value: function): JQuery
  • css(properties: Object): JQuery
  • Get the value of style properties for the first element in the set of matched elements.

    see

    https://api.jquery.com/css/#css-propertyName

    Parameters

    • propertyName: string

      A CSS property.

    Returns string

  • Set one or more CSS properties for the set of matched elements.

    see

    https://api.jquery.com/css/#css-propertyName-value

    Parameters

    • propertyName: string

      A CSS property name.

    • value: string | number

      A value to set for the property.

    Returns JQuery

  • Set one or more CSS properties for the set of matched elements.

    see

    https://api.jquery.com/css/#css-propertyName-function

    Parameters

    • propertyName: string

      A CSS property name.

    • value: 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.

        • (index: number, value: string): string | number
        • Parameters

          • index: number
          • value: string

          Returns string | number

    Returns JQuery

  • Set one or more CSS properties for the set of matched elements.

    see

    https://api.jquery.com/css/#css-properties

    Parameters

    • properties: Object

      An object of property-value pairs to set.

    Returns JQuery

data

  • data(key: string, value: any): JQuery
  • data(key: string): any
  • data(obj: object): JQuery
  • data(): any
  • Store arbitrary data associated with the matched elements.

    see

    https://api.jquery.com/data/#data-key-value

    Parameters

    • key: string

      A string naming the piece of data to set.

    • value: any

      The new data value; it can be any JavaScript type including Array or Object.

    Returns JQuery

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

    see

    https://api.jquery.com/data/#data-key

    Parameters

    • key: string

      Name of the data stored.

    Returns any

  • Store arbitrary data associated with the matched elements.

    see

    https://api.jquery.com/data/#data-obj

    Parameters

    • obj: object

      An object of key-value pairs of data to update.

      • [key: string]: any

    Returns JQuery

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

    see

    https://api.jquery.com/data/#data

    Returns any

dblclick

  • dblclick(): JQuery
  • dblclick(handler: function): JQuery
  • dblclick(eventData?: any, handler?: function): JQuery

delay

  • delay(duration: number, queueName?: string): JQuery
  • Set a timer to delay execution of subsequent items in the queue.

    see

    https://api.jquery.com/delay/

    Parameters

    • duration: number

      An integer indicating the number of milliseconds to delay execution of the next item in the queue.

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

delegate

  • delegate(selector: any, eventType: string, handler: function): JQuery
  • delegate(selector: any, eventType: string, eventData: any, handler: function): JQuery

dequeue

  • dequeue(queueName?: string): JQuery
  • Execute the next function on the queue for the matched elements.

    see

    https://api.jquery.com/dequeue/

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns JQuery

detach

  • detach(selector?: string): JQuery
  • Remove the set of matched elements from the DOM.

    see

    https://api.jquery.com/detach/

    Parameters

    • Optional selector: string

      A selector expression that filters the set of matched elements to be removed.

    Returns JQuery

each

  • each(func: function): JQuery
  • Iterate over a jQuery object, executing a function for each matched element.

    see

    https://api.jquery.com/each/

    Parameters

    • func: function

      A function to execute for each matched element.

        • (index: number, elem: Element): any
        • Parameters

          • index: number
          • elem: Element

          Returns any

    Returns JQuery

empty

end

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

    see

    https://api.jquery.com/end/

    Returns JQuery

eq

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

    see

    https://api.jquery.com/eq/

    Parameters

    • index: number

      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.

    Returns JQuery

error

  • error(handler: function): JQuery
  • error(eventData: any, handler: function): JQuery

fadeIn

  • Display the matched elements by fading them to opaque.

    see

    https://api.jquery.com/fadeIn/#fadeIn-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements by fading them to opaque.

    see

    https://api.jquery.com/fadeIn/#fadeIn-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements by fading them to opaque.

    see

    https://api.jquery.com/fadeIn/#fadeIn-options

    Parameters

    Returns JQuery

fadeOut

  • Hide the matched elements by fading them to transparent.

    see

    https://api.jquery.com/fadeOut/#fadeOut-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements by fading them to transparent.

    see

    https://api.jquery.com/fadeOut/#fadeOut-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements by fading them to transparent.

    see

    https://api.jquery.com/fadeOut/#fadeOut-options

    Parameters

    Returns JQuery

fadeTo

  • fadeTo(duration: string | number, opacity: number, complete?: Function): JQuery
  • fadeTo(duration: string | number, opacity: number, easing?: string, complete?: Function): JQuery
  • Adjust the opacity of the matched elements.

    see

    https://api.jquery.com/fadeTo/#fadeTo-duration-opacity-complete

    Parameters

    • duration: string | number

      A string or number determining how long the animation will run.

    • opacity: number

      A number between 0 and 1 denoting the target opacity.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Adjust the opacity of the matched elements.

    see

    https://api.jquery.com/fadeTo/#fadeTo-duration-opacity-easing-complete

    Parameters

    • duration: string | number

      A string or number determining how long the animation will run.

    • opacity: number

      A number between 0 and 1 denoting the target opacity.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

fadeToggle

  • fadeToggle(duration?: number | string, complete?: Function): JQuery
  • fadeToggle(duration?: number | string, easing?: string, complete?: Function): JQuery
  • fadeToggle(options: JQueryAnimationOptions): JQuery
  • Display or hide the matched elements by animating their opacity.

    see

    https://api.jquery.com/fadeToggle/#fadeToggle-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements by animating their opacity.

    see

    https://api.jquery.com/fadeToggle/#fadeToggle-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements by animating their opacity.

    see

    https://api.jquery.com/fadeToggle/#fadeToggle-options

    Parameters

    Returns JQuery

filter

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

    see

    https://api.jquery.com/filter/#filter-selector

    Parameters

    • selector: string

      A string containing a selector expression to match the current set of elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/filter/#filter-function

    Parameters

    • func: function

      A function used as a test for each element in the set. this is the current DOM element.

        • (index: number, element: Element): any
        • Parameters

          • index: number
          • element: Element

          Returns any

    Returns JQuery

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

    see

    https://api.jquery.com/filter/#filter-elements

    Parameters

    • element: Element

      An element to match the current set of elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/filter/#filter-selection

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns JQuery

find

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

    see

    https://api.jquery.com/find/#find-selector

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/find/#find-element

    Parameters

    • element: Element

      An element to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/find/#find-element

    Parameters

    • obj: JQuery

      A jQuery object to match elements against.

    Returns JQuery

finish

  • finish(queue?: string): JQuery
  • Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.

    see

    https://api.jquery.com/finish/

    Parameters

    • Optional queue: string

      The name of the queue in which to stop animations.

    Returns JQuery

first

focus

  • focus(): JQuery
  • focus(handler: function): JQuery
  • focus(eventData?: any, handler?: function): JQuery

focusin

  • focusin(): JQuery
  • focusin(handler: function): JQuery
  • focusin(eventData: Object, handler: function): JQuery

focusout

  • focusout(): JQuery
  • focusout(handler: function): JQuery
  • focusout(eventData: Object, handler: function): JQuery

get

  • get(index: number): HTMLElement
  • get(): HTMLElement[]
  • Retrieve one of the elements matched by the jQuery object.

    see

    https://api.jquery.com/get/#get-index

    Parameters

    • index: number

      A zero-based integer indicating which element to retrieve.

    Returns HTMLElement

  • Retrieve the elements matched by the jQuery object.

    alias

    toArray

    see

    https://api.jquery.com/get/#get

    Returns HTMLElement[]

has

  • has(selector: string): JQuery
  • has(contained: Element): JQuery
  • Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.

    see

    https://api.jquery.com/has/#has-selector

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/has/#has-contained

    Parameters

    • contained: Element

      A DOM element to match elements against.

    Returns JQuery

hasClass

  • hasClass(className: string): boolean
  • Determine whether any of the matched elements are assigned the given class.

    see

    https://api.jquery.com/hasClass/

    Parameters

    • className: string

      The class name to search for.

    Returns boolean

height

  • height(): number
  • height(value: number | string): JQuery
  • height(func: function): JQuery
  • Get the current computed height for the first element in the set of matched elements.

    see

    https://api.jquery.com/height/#height

    Returns number

  • Set the CSS height of every matched element.

    see

    https://api.jquery.com/height/#height-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string).

    Returns JQuery

  • Set the CSS height of every matched element.

    see

    https://api.jquery.com/height/#height-function

    Parameters

    • func: 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.

        • (index: number, height: number): number | string
        • Parameters

          • index: number
          • height: number

          Returns number | string

    Returns JQuery

hide

  • Hide the matched elements.

    see

    https://api.jquery.com/hide/#hide

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements.

    see

    https://api.jquery.com/hide/#hide-options

    Parameters

    Returns JQuery

hover

  • hover(handlerIn: function, handlerOut: function): JQuery
  • hover(handlerInOut: function): JQuery

html

  • html(): string
  • html(htmlString: string): JQuery
  • html(func: function): JQuery
  • Get the HTML contents of the first element in the set of matched elements.

    see

    https://api.jquery.com/html/#html

    Returns string

  • Set the HTML contents of each element in the set of matched elements.

    see

    https://api.jquery.com/html/#html-htmlString

    Parameters

    • htmlString: string

      A string of HTML to set as the content of each matched element.

    Returns JQuery

  • Set the HTML contents of each element in the set of matched elements.

    see

    https://api.jquery.com/html/#html-function

    Parameters

    • func: 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.

        • (index: number, oldhtml: string): string
        • Parameters

          • index: number
          • oldhtml: string

          Returns string

    Returns JQuery

index

  • index(): number
  • index(selector: string | JQuery | Element): number
  • Search for a given element from among the matched elements.

    see

    https://api.jquery.com/index/#index

    Returns number

  • Search for a given element from among the matched elements.

    see

    https://api.jquery.com/index/#index-selector

    Parameters

    • selector: string | JQuery | Element

      A selector representing a jQuery collection in which to look for an element.

    Returns number

innerHeight

  • innerHeight(): number
  • innerHeight(value: number | string): JQuery
  • Get the current computed height for the first element in the set of matched elements, including padding but not border.

    see

    https://api.jquery.com/innerHeight/#innerHeight

    Returns number

  • Sets the inner height on elements in the set of matched elements, including padding but not border.

    see

    https://api.jquery.com/innerHeight/#innerHeight-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

innerWidth

  • innerWidth(): number
  • innerWidth(value: number | string): JQuery
  • Get the current computed width for the first element in the set of matched elements, including padding but not border.

    see

    https://api.jquery.com/innerWidth/#innerWidth

    Returns number

  • Sets the inner width on elements in the set of matched elements, including padding but not border.

    see

    https://api.jquery.com/innerWidth/#innerWidth-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

insertAfter

  • insertAfter(target: JQuery | any[] | Element | Text | string): JQuery
  • Insert every element in the set of matched elements after the target.

    see

    https://api.jquery.com/insertAfter/

    Parameters

    • target: JQuery | any[] | Element | Text | string

      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.

    Returns JQuery

insertBefore

  • insertBefore(target: JQuery | any[] | Element | Text | string): JQuery
  • Insert every element in the set of matched elements before the target.

    see

    https://api.jquery.com/insertBefore/

    Parameters

    • target: JQuery | any[] | Element | Text | string

      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.

    Returns JQuery

is

  • is(selector: string): boolean
  • is(func: function): boolean
  • is(obj: JQuery): boolean
  • is(elements: any): boolean
  • 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.

    see

    https://api.jquery.com/is/#is-selector

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns boolean

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

    see

    https://api.jquery.com/is/#is-function

    Parameters

    • func: function

      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.

        • (index: number, element: Element): boolean
        • Parameters

          • index: number
          • element: Element

          Returns boolean

    Returns boolean

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

    see

    https://api.jquery.com/is/#is-selection

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns boolean

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

    see

    https://api.jquery.com/is/#is-elements

    Parameters

    • elements: any

      One or more elements to match the current set of elements against.

    Returns boolean

keydown

  • keydown(): JQuery
  • keydown(handler: function): JQuery
  • keydown(eventData?: any, handler?: function): JQuery

keypress

  • keypress(): JQuery
  • keypress(handler: function): JQuery
  • keypress(eventData?: any, handler?: function): JQuery

keyup

  • keyup(): JQuery
  • keyup(handler: function): JQuery
  • keyup(eventData?: any, handler?: function): JQuery

last

load

  • load(url: string, data?: string | Object, complete?: function): JQuery
  • load(handler: function): JQuery
  • load(eventData?: any, handler?: function): JQuery
  • Load data from the server and place the returned HTML into the matched element.

    see

    https://api.jquery.com/load/

    Parameters

    • url: string

      A string containing the URL to which the request is sent.

    • Optional data: string | Object

      A plain object or string that is sent to the server with the request.

    • Optional complete: function

      A callback function that is executed when the request completes.

        • (responseText: string, textStatus: string, XMLHttpRequest: XMLHttpRequest): any
        • Parameters

          • responseText: string
          • textStatus: string
          • XMLHttpRequest: XMLHttpRequest

          Returns any

    Returns JQuery

  • Bind an event handler to the "load" JavaScript event.

    see

    https://api.jquery.com/load/

    Parameters

    Returns JQuery

  • Bind an event handler to the "load" JavaScript event.

    see

    https://api.jquery.com/load/

    Parameters

    • Optional eventData: any

      An object containing data that will be passed to the event handler.

    • Optional handler: function

      A function to execute when the event is triggered.

    Returns JQuery

map

  • map(callback: function): JQuery
  • Pass each element in the current matched set through a function, producing a new jQuery object containing the return values.

    see

    https://api.jquery.com/map/

    Parameters

    • callback: function

      A function object that will be invoked for each element in the current set.

        • (index: number, domElement: Element): any
        • Parameters

          • index: number
          • domElement: Element

          Returns any

    Returns JQuery

mousedown

  • mousedown(): JQuery
  • mousedown(handler: function): JQuery
  • mousedown(eventData: Object, handler: function): JQuery

mouseenter

  • mouseenter(): JQuery
  • mouseenter(handler: function): JQuery
  • mouseenter(eventData: Object, handler: function): JQuery

mouseleave

  • mouseleave(): JQuery
  • mouseleave(handler: function): JQuery
  • mouseleave(eventData: Object, handler: function): JQuery

mousemove

  • mousemove(): JQuery
  • mousemove(handler: function): JQuery
  • mousemove(eventData: Object, handler: function): JQuery

mouseout

  • mouseout(): JQuery
  • mouseout(handler: function): JQuery
  • mouseout(eventData: Object, handler: function): JQuery

mouseover

  • mouseover(): JQuery
  • mouseover(handler: function): JQuery
  • mouseover(eventData: Object, handler: function): JQuery

mouseup

  • mouseup(): JQuery
  • mouseup(handler: function): JQuery
  • mouseup(eventData: Object, handler: function): JQuery

next

  • next(selector?: string): JQuery
  • 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.

    see

    https://api.jquery.com/next/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

nextAll

  • nextAll(selector?: string): JQuery
  • Get all following siblings of each element in the set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/nextAll/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

nextUntil

  • nextUntil(selector?: string, filter?: string): JQuery
  • nextUntil(element?: Element, filter?: string): JQuery
  • nextUntil(obj?: JQuery, filter?: string): JQuery
  • Get all following siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object passed.

    see

    https://api.jquery.com/nextUntil/#nextUntil-selector-filter

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/nextUntil/#nextUntil-element-filter

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/nextUntil/#nextUntil-element-filter

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching following sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

not

  • Remove elements from the set of matched elements.

    see

    https://api.jquery.com/not/#not-selector

    Parameters

    • selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

  • Remove elements from the set of matched elements.

    see

    https://api.jquery.com/not/#not-function

    Parameters

    • func: function

      A function used as a test for each element in the set. this is the current DOM element.

        • (index: number, element: Element): boolean
        • Parameters

          • index: number
          • element: Element

          Returns boolean

    Returns JQuery

  • Remove elements from the set of matched elements.

    see

    https://api.jquery.com/not/#not-selection

    Parameters

    • elements: Element | Element[]

      One or more DOM elements to remove from the matched set.

    Returns JQuery

  • Remove elements from the set of matched elements.

    see

    https://api.jquery.com/not/#not-selection

    Parameters

    • obj: JQuery

      An existing jQuery object to match the current set of elements against.

    Returns JQuery

off

  • off(): JQuery
  • off(events: string, selector?: string, handler?: function): JQuery
  • off(events: string, handler: function): JQuery
  • off(events: string, handler: function): JQuery
  • off(events: object, selector?: string): JQuery
  • Remove an event handler.

    see

    https://api.jquery.com/off/#off

    Returns JQuery

  • Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • Optional selector: string

      A selector which should match the one originally passed to .on() when attaching event handlers.

    • Optional handler: function

      A handler function previously attached for the event(s), or the special value false.

    Returns JQuery

  • Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • handler: function

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

    Returns JQuery

  • Parameters

    • events: string

      One or more space-separated event types and optional namespaces, or just namespaces, such as "click", "keydown.myPlugin", or ".myPlugin".

    • handler: function

      A handler function previously attached for the event(s), or the special value false.

    Returns JQuery

  • Parameters

    • events: object

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

      • [key: string]: any
    • Optional selector: string

      A selector which should match the one originally passed to .on() when attaching event handlers.

    Returns JQuery

offset

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

    see

    https://api.jquery.com/offset/#offset

    Returns JQueryCoordinates

  • An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    see

    https://api.jquery.com/offset/#offset-coordinates

    Parameters

    • coordinates: JQueryCoordinates

      An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    Returns JQuery

  • An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements.

    see

    https://api.jquery.com/offset/#offset-function

    Parameters

    • func: 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.

    Returns JQuery

offsetParent

on

  • on(events: string, handler: function): JQuery
  • on(events: string, data: any, handler: function): JQuery
  • on(events: string, selector: string, handler: function): JQuery
  • on(events: string, selector: string, data: any, handler: function): JQuery
  • on(events: object, selector?: string, data?: any): JQuery
  • on(events: object, data?: any): JQuery
  • Attach an event handler function for one or more events to the selected elements.

    see

    https://api.jquery.com/on/#on-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • handler: function

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

    Returns JQuery

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

    see

    https://api.jquery.com/on/#on-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • data: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: function

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/on/#on-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      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.

    • handler: function

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/on/#on-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      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: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: function

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/on/#on-events-selector-data

    Parameters

    • events: object

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

      • [key: string]: any
    • Optional selector: string

      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.

    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

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

    see

    https://api.jquery.com/on/#on-events-selector-data

    Parameters

    • events: object

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

      • [key: string]: any
    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

one

  • one(events: string, handler: function): JQuery
  • one(events: string, data: Object, handler: function): JQuery
  • one(events: string, selector: string, handler: function): JQuery
  • one(events: string, selector: string, data: any, handler: function): JQuery
  • one(events: object, selector?: string, data?: any): JQuery
  • one(events: object, data?: any): JQuery
  • Attach a handler to an event for the elements. The handler is executed at most once per element per event type.

    see

    https://api.jquery.com/one/#one-events-data-handler

    Parameters

    • events: string

      A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.

    • handler: function

      A function to execute at the time the event is triggered.

    Returns JQuery

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

    see

    https://api.jquery.com/one/#one-events-data-handler

    Parameters

    • events: string

      A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.

    • data: Object

      An object containing data that will be passed to the event handler.

    • handler: function

      A function to execute at the time the event is triggered.

    Returns JQuery

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

    see

    https://api.jquery.com/one/#one-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      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.

    • handler: function

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/one/#one-events-selector-data-handler

    Parameters

    • events: string

      One or more space-separated event types and optional namespaces, such as "click" or "keydown.myPlugin".

    • selector: string

      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: any

      Data to be passed to the handler in event.data when an event is triggered.

    • handler: function

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/one/#one-events-selector-data

    Parameters

    • events: object

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

      • [key: string]: any
    • Optional selector: string

      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.

    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

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

    see

    https://api.jquery.com/one/#one-events-selector-data

    Parameters

    • events: object

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

      • [key: string]: any
    • Optional data: any

      Data to be passed to the handler in event.data when an event occurs.

    Returns JQuery

outerHeight

  • outerHeight(includeMargin?: boolean): number
  • outerHeight(value: number | string): JQuery
  • 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.

    see

    https://api.jquery.com/outerHeight/#outerHeight-includeMargin

    Parameters

    • Optional includeMargin: boolean

      A Boolean indicating whether to include the element's margin in the calculation.

    Returns number

  • Sets the outer height on elements in the set of matched elements, including padding and border.

    see

    https://api.jquery.com/outerHeight/#outerHeight-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

outerWidth

  • outerWidth(includeMargin?: boolean): number
  • outerWidth(value: number | string): JQuery
  • Get the current computed width for the first element in the set of matched elements, including padding and border.

    see

    https://api.jquery.com/outerWidth/#outerWidth-includeMargin

    Parameters

    • Optional includeMargin: boolean

      A Boolean indicating whether to include the element's margin in the calculation.

    Returns number

  • Sets the outer width on elements in the set of matched elements, including padding and border.

    see

    https://api.jquery.com/outerWidth/#outerWidth-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

parent

  • parent(selector?: string): JQuery
  • Get the parent of each element in the current set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/parent/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

parents

  • parents(selector?: string): JQuery
  • Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/parents/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

parentsUntil

  • parentsUntil(selector?: string, filter?: string): JQuery
  • parentsUntil(element?: Element, filter?: string): JQuery
  • parentsUntil(obj?: JQuery, filter?: string): JQuery
  • 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.

    see

    https://api.jquery.com/parentsUntil/#parentsUntil-selector-filter

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/parentsUntil/#parentsUntil-element-filter

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/parentsUntil/#parentsUntil-element-filter

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching ancestor elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

position

prepend

  • prepend(content1: JQuery | any[] | Element | DocumentFragment | Text | string, ...content2: any[]): JQuery
  • prepend(func: function): JQuery
  • Insert content, specified by the parameter, to the beginning of each element in the set of matched elements.

    see

    https://api.jquery.com/prepend/#prepend-content-content

    Parameters

    • content1: JQuery | any[] | Element | DocumentFragment | Text | string

      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.

    • Rest ...content2: any[]

      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.

    Returns JQuery

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

    see

    https://api.jquery.com/prepend/#prepend-function

    Parameters

    • func: function

      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.

        • (index: number, html: string): string | Element | JQuery
        • Parameters

          • index: number
          • html: string

          Returns string | Element | JQuery

    Returns JQuery

prependTo

  • prependTo(target: JQuery | any[] | Element | string): JQuery
  • Insert every element in the set of matched elements to the beginning of the target.

    see

    https://api.jquery.com/prependTo/

    Parameters

    • target: JQuery | any[] | Element | string

      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.

    Returns JQuery

prev

  • prev(selector?: string): JQuery
  • Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/prev/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

prevAll

  • prevAll(selector?: string): JQuery
  • Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/prevAll/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

prevUntil

  • prevUntil(selector?: string, filter?: string): JQuery
  • prevUntil(element?: Element, filter?: string): JQuery
  • prevUntil(obj?: JQuery, filter?: string): JQuery
  • Get all preceding siblings of each element up to but not including the element matched by the selector, DOM node, or jQuery object.

    see

    https://api.jquery.com/prevUntil/#prevUntil-selector-filter

    Parameters

    • Optional selector: string

      A string containing a selector expression to indicate where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/prevUntil/#prevUntil-element-filter

    Parameters

    • Optional element: Element

      A DOM node or jQuery object indicating where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

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

    see

    https://api.jquery.com/prevUntil/#prevUntil-element-filter

    Parameters

    • Optional obj: JQuery

      A DOM node or jQuery object indicating where to stop matching preceding sibling elements.

    • Optional filter: string

      A string containing a selector expression to match elements against.

    Returns JQuery

promise

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

    see

    https://api.jquery.com/promise/

    Parameters

    • Optional type: string

      The type of queue that needs to be observed. (default: fx)

    • Optional target: Object

      Object onto which the promise methods have to be attached

    Returns JQueryPromise<any>

prop

  • prop(propertyName: string): any
  • prop(propertyName: string, value: string | number | boolean): JQuery
  • prop(properties: Object): JQuery
  • prop(propertyName: string, func: function): JQuery
  • Get the value of a property for the first element in the set of matched elements.

    see

    https://api.jquery.com/prop/#prop-propertyName

    Parameters

    • propertyName: string

      The name of the property to get.

    Returns any

  • Set one or more properties for the set of matched elements.

    see

    https://api.jquery.com/prop/#prop-propertyName-value

    Parameters

    • propertyName: string

      The name of the property to set.

    • value: string | number | boolean

      A value to set for the property.

    Returns JQuery

  • Set one or more properties for the set of matched elements.

    see

    https://api.jquery.com/prop/#prop-properties

    Parameters

    • properties: Object

      An object of property-value pairs to set.

    Returns JQuery

  • Set one or more properties for the set of matched elements.

    see

    https://api.jquery.com/prop/#prop-propertyName-function

    Parameters

    • propertyName: string

      The name of the property to set.

    • func: 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.

        • (index: number, oldPropertyValue: any): any
        • Parameters

          • index: number
          • oldPropertyValue: any

          Returns any

    Returns JQuery

pushStack

  • pushStack(elements: any[]): JQuery
  • pushStack(elements: any[], name: string, arguments: any[]): JQuery
  • Add a collection of DOM elements onto the jQuery stack.

    see

    https://api.jquery.com/pushStack/#pushStack-elements

    Parameters

    • elements: any[]

      An array of elements to push onto the stack and make into a new jQuery object.

    Returns JQuery

  • Add a collection of DOM elements onto the jQuery stack.

    see

    https://api.jquery.com/pushStack/#pushStack-elements-name-arguments

    Parameters

    • elements: any[]

      An array of elements to push onto the stack and make into a new jQuery object.

    • name: string

      The name of a jQuery method that generated the array of elements.

    • arguments: any[]

      The arguments that were passed in to the jQuery method (for serialization).

    Returns JQuery

queue

  • queue(queueName?: string): any[]
  • queue(newQueue: Function[]): JQuery
  • queue(callback: Function): JQuery
  • queue(queueName: string, newQueue: Function[]): JQuery
  • queue(queueName: string, callback: Function): JQuery
  • Show the queue of functions to be executed on the matched elements.

    see

    https://api.jquery.com/queue/#queue-queueName

    Parameters

    • Optional queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    Returns any[]

  • Manipulate the queue of functions to be executed, once for each matched element.

    see

    https://api.jquery.com/queue/#queue-queueName-newQueue

    Parameters

    • newQueue: Function[]

      An array of functions to replace the current queue contents.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    see

    https://api.jquery.com/queue/#queue-queueName-callback

    Parameters

    • callback: Function

      The new function to add to the queue, with a function to call that will dequeue the next item.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    see

    https://api.jquery.com/queue/#queue-queueName-newQueue

    Parameters

    • queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    • newQueue: Function[]

      An array of functions to replace the current queue contents.

    Returns JQuery

  • Manipulate the queue of functions to be executed, once for each matched element.

    see

    https://api.jquery.com/queue/#queue-queueName-callback

    Parameters

    • queueName: string

      A string containing the name of the queue. Defaults to fx, the standard effects queue.

    • callback: Function

      The new function to add to the queue, with a function to call that will dequeue the next item.

    Returns JQuery

ready

  • ready(handler: function): JQuery
  • Specify a function to execute when the DOM is fully loaded.

    see

    https://api.jquery.com/ready/

    Parameters

    • handler: function

      A function to execute after the DOM is ready.

    Returns JQuery

remove

  • remove(selector?: string): JQuery
  • Remove the set of matched elements from the DOM.

    see

    https://api.jquery.com/remove/

    Parameters

    • Optional selector: string

      A selector expression that filters the set of matched elements to be removed.

    Returns JQuery

removeAttr

  • removeAttr(attributeName: string): JQuery
  • Remove an attribute from each element in the set of matched elements.

    see

    https://api.jquery.com/removeAttr/

    Parameters

    • attributeName: string

      An attribute to remove; as of version 1.7, it can be a space-separated list of attributes.

    Returns JQuery

removeClass

  • removeClass(className?: string): JQuery
  • removeClass(func: function): JQuery
  • Remove a single class, multiple classes, or all classes from each element in the set of matched elements.

    see

    https://api.jquery.com/removeClass/#removeClass-className

    Parameters

    • Optional className: string

      One or more space-separated classes to be removed from the class attribute of each matched element.

    Returns JQuery

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

    see

    https://api.jquery.com/removeClass/#removeClass-function

    Parameters

    • func: 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.

        • (index: number, className: string): string
        • Parameters

          • index: number
          • className: string

          Returns string

    Returns JQuery

removeData

  • removeData(name: string): JQuery
  • removeData(list: string[]): JQuery
  • removeData(): JQuery

removeProp

  • removeProp(propertyName: string): JQuery
  • Remove a property for the set of matched elements.

    see

    https://api.jquery.com/removeProp/

    Parameters

    • propertyName: string

      The name of the property to remove.

    Returns JQuery

replaceAll

  • replaceAll(target: JQuery | any[] | Element | string): JQuery
  • Replace each target element with the set of matched elements.

    see

    https://api.jquery.com/replaceAll/

    Parameters

    • target: JQuery | any[] | Element | string

      A selector string, jQuery object, DOM element, or array of elements indicating which element(s) to replace.

    Returns JQuery

replaceWith

  • replaceWith(newContent: JQuery | any[] | Element | Text | string): JQuery
  • replaceWith(func: function): JQuery
  • Replace each element in the set of matched elements with the provided new content and return the set of elements that was removed.

    see

    https://api.jquery.com/replaceWith/#replaceWith-newContent

    Parameters

    • newContent: JQuery | any[] | Element | Text | string

      The content to insert. May be an HTML string, DOM element, array of DOM elements, or jQuery object.

    Returns JQuery

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

    see

    https://api.jquery.com/replaceWith/#replaceWith-function

    Parameters

    • func: function

      A function that returns content with which to replace the set of matched elements.

    Returns JQuery

resize

  • resize(): JQuery
  • resize(handler: function): JQuery
  • resize(eventData: Object, handler: function): JQuery

scroll

  • scroll(): JQuery
  • scroll(handler: function): JQuery
  • scroll(eventData: Object, handler: function): JQuery

scrollLeft

  • scrollLeft(): number
  • scrollLeft(value: number): JQuery
  • 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.

    see

    https://api.jquery.com/scrollLeft/#scrollLeft

    Returns number

  • Set the current horizontal position of the scroll bar for each of the set of matched elements.

    see

    https://api.jquery.com/scrollLeft/#scrollLeft-value

    Parameters

    • value: number

      An integer indicating the new position to set the scroll bar to.

    Returns JQuery

scrollTop

  • scrollTop(): number
  • scrollTop(value: number): JQuery
  • 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.

    see

    https://api.jquery.com/scrollTop/#scrollTop

    Returns number

  • Set the current vertical position of the scroll bar for each of the set of matched elements.

    see

    https://api.jquery.com/scrollTop/#scrollTop-value

    Parameters

    • value: number

      An integer indicating the new position to set the scroll bar to.

    Returns JQuery

select

  • select(): JQuery
  • select(handler: function): JQuery
  • select(eventData: Object, handler: function): JQuery

serialize

  • serialize(): string
  • Encode a set of form elements as a string for submission.

    see

    https://api.jquery.com/serialize/

    Returns string

serializeArray

show

  • Display the matched elements.

    see

    https://api.jquery.com/show/#show

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements.

    see

    https://api.jquery.com/show/#show-options

    Parameters

    Returns JQuery

siblings

  • siblings(selector?: string): JQuery
  • Get the siblings of each element in the set of matched elements, optionally filtered by a selector.

    see

    https://api.jquery.com/siblings/

    Parameters

    • Optional selector: string

      A string containing a selector expression to match elements against.

    Returns JQuery

slice

  • slice(start: number, end?: number): JQuery
  • Reduce the set of matched elements to a subset specified by a range of indices.

    see

    https://api.jquery.com/slice/

    Parameters

    • start: number

      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.

    • Optional end: number

      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.

    Returns JQuery

slideDown

  • slideDown(duration?: number | string, complete?: Function): JQuery
  • slideDown(duration?: number | string, easing?: string, complete?: Function): JQuery
  • slideDown(options: JQueryAnimationOptions): JQuery
  • Display the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideDown/#slideDown-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideDown/#slideDown-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideDown/#slideDown-options

    Parameters

    Returns JQuery

slideToggle

  • slideToggle(duration?: number | string, complete?: Function): JQuery
  • slideToggle(duration?: number | string, easing?: string, complete?: Function): JQuery
  • slideToggle(options: JQueryAnimationOptions): JQuery
  • Display or hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideToggle/#slideToggle-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideToggle/#slideToggle-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideToggle/#slideToggle-options

    Parameters

    Returns JQuery

slideUp

  • Hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideUp/#slideUp-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideUp/#slideUp-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Hide the matched elements with a sliding motion.

    see

    https://api.jquery.com/slideUp/#slideUp-options

    Parameters

    Returns JQuery

stop

  • stop(clearQueue?: boolean, jumpToEnd?: boolean): JQuery
  • stop(queue?: string, clearQueue?: boolean, jumpToEnd?: boolean): JQuery
  • Stop the currently-running animation on the matched elements.

    see

    https://api.jquery.com/stop/#stop-clearQueue-jumpToEnd

    Parameters

    • Optional clearQueue: boolean

      A Boolean indicating whether to remove queued animation as well. Defaults to false.

    • Optional jumpToEnd: boolean

      A Boolean indicating whether to complete the current animation immediately. Defaults to false.

    Returns JQuery

  • Stop the currently-running animation on the matched elements.

    see

    https://api.jquery.com/stop/#stop-queue-clearQueue-jumpToEnd

    Parameters

    • Optional queue: string

      The name of the queue in which to stop animations.

    • Optional clearQueue: boolean

      A Boolean indicating whether to remove queued animation as well. Defaults to false.

    • Optional jumpToEnd: boolean

      A Boolean indicating whether to complete the current animation immediately. Defaults to false.

    Returns JQuery

submit

  • submit(): JQuery
  • submit(handler: function): JQuery
  • submit(eventData?: any, handler?: function): JQuery

text

  • text(): string
  • text(text: string | number | boolean): JQuery
  • text(func: function): JQuery
  • Get the combined text contents of each element in the set of matched elements, including their descendants.

    see

    https://api.jquery.com/text/#text

    Returns string

  • Set the content of each element in the set of matched elements to the specified text.

    see

    https://api.jquery.com/text/#text-text

    Parameters

    • text: string | number | boolean

      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.

    Returns JQuery

  • Set the content of each element in the set of matched elements to the specified text.

    see

    https://api.jquery.com/text/#text-function

    Parameters

    • func: 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.

        • (index: number, text: string): string
        • Parameters

          • index: number
          • text: string

          Returns string

    Returns JQuery

toArray

  • toArray(): HTMLElement[]
  • Retrieve all the elements contained in the jQuery set, as an array.

    name

    toArray

    see

    https://api.jquery.com/toArray/

    Returns HTMLElement[]

toggle

  • toggle(duration?: number | string, complete?: Function): JQuery
  • toggle(duration?: number | string, easing?: string, complete?: Function): JQuery
  • toggle(options: JQueryAnimationOptions): JQuery
  • toggle(showOrHide: boolean): JQuery
  • Display or hide the matched elements.

    see

    https://api.jquery.com/toggle/#toggle-duration-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements.

    see

    https://api.jquery.com/toggle/#toggle-duration-easing-complete

    Parameters

    • Optional duration: number | string

      A string or number determining how long the animation will run.

    • Optional easing: string

      A string indicating which easing function to use for the transition.

    • Optional complete: Function

      A function to call once the animation is complete.

    Returns JQuery

  • Display or hide the matched elements.

    see

    https://api.jquery.com/toggle/#toggle-options

    Parameters

    Returns JQuery

  • Display or hide the matched elements.

    see

    https://api.jquery.com/toggle/#toggle-display

    Parameters

    • showOrHide: boolean

      A Boolean indicating whether to show or hide the elements.

    Returns JQuery

toggleClass

  • toggleClass(className: string, swtch?: boolean): JQuery
  • toggleClass(swtch?: boolean): JQuery
  • toggleClass(func: function, swtch?: boolean): JQuery
  • 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.

    see

    https://api.jquery.com/toggleClass/#toggleClass-className

    Parameters

    • className: string

      One or more class names (separated by spaces) to be toggled for each element in the matched set.

    • Optional swtch: boolean

      A Boolean (not just truthy/falsy) value to determine whether the class should be added or removed.

    Returns JQuery

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

    see

    https://api.jquery.com/toggleClass/#toggleClass-state

    Parameters

    • Optional swtch: boolean

      A boolean value to determine whether the class should be added or removed.

    Returns JQuery

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

    see

    https://api.jquery.com/toggleClass/#toggleClass-function-state

    Parameters

    • func: 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 switch as arguments.

        • (index: number, className: string, swtch: boolean): string
        • Parameters

          • index: number
          • className: string
          • swtch: boolean

          Returns string

    • Optional swtch: boolean

      A boolean value to determine whether the class should be added or removed.

    Returns JQuery

trigger

  • trigger(eventType: string, extraParameters?: any[] | Object): JQuery
  • trigger(event: JQueryEventObject, extraParameters?: any[] | Object): JQuery
  • Execute all handlers and behaviors attached to the matched elements for the given event type.

    see

    https://api.jquery.com/trigger/#trigger-eventType-extraParameters

    Parameters

    • eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • Optional extraParameters: any[] | Object

      Additional parameters to pass along to the event handler.

    Returns JQuery

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

    see

    https://api.jquery.com/trigger/#trigger-event-extraParameters

    Parameters

    • event: JQueryEventObject

      A jQuery.Event object.

    • Optional extraParameters: any[] | Object

      Additional parameters to pass along to the event handler.

    Returns JQuery

triggerHandler

  • triggerHandler(eventType: string, ...extraParameters: any[]): Object
  • triggerHandler(event: JQueryEventObject, ...extraParameters: any[]): Object

unbind

  • unbind(eventType?: string, handler?: function): JQuery
  • unbind(eventType: string, fls: boolean): JQuery
  • unbind(evt: any): JQuery
  • Remove a previously-attached event handler from the elements.

    see

    https://api.jquery.com/unbind/#unbind-eventType-handler

    Parameters

    • Optional eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • Optional handler: function

      The function that is to be no longer executed.

    Returns JQuery

  • Remove a previously-attached event handler from the elements.

    see

    https://api.jquery.com/unbind/#unbind-eventType-false

    Parameters

    • eventType: string

      A string containing a JavaScript event type, such as click or submit.

    • fls: boolean

      Unbinds the corresponding 'return false' function that was bound using .bind( eventType, false ).

    Returns JQuery

  • Remove a previously-attached event handler from the elements.

    see

    https://api.jquery.com/unbind/#unbind-event

    Parameters

    • evt: any

      A JavaScript event object as passed to an event handler.

    Returns JQuery

undelegate

  • undelegate(): JQuery
  • undelegate(selector: string, eventType: string, handler?: function): JQuery
  • undelegate(selector: string, events: Object): JQuery
  • undelegate(namespace: string): JQuery
  • Remove a handler from the event for all elements which match the current selector, based upon a specific set of root elements.

    see

    https://api.jquery.com/undelegate/#undelegate

    Returns JQuery

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

    see

    https://api.jquery.com/undelegate/#undelegate-selector-eventType

    Parameters

    • selector: string

      A selector which will be used to filter the event results.

    • eventType: string

      A string containing a JavaScript event type, such as "click" or "keydown"

    • Optional handler: function

      A function to execute at the time the event is triggered.

    Returns JQuery

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

    see

    https://api.jquery.com/undelegate/#undelegate-selector-events

    Parameters

    • selector: string

      A selector which will be used to filter the event results.

    • events: Object

      An object of one or more event types and previously bound functions to unbind from them.

    Returns JQuery

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

    see

    https://api.jquery.com/undelegate/#undelegate-namespace

    Parameters

    • namespace: string

      A string containing a namespace to unbind all events from.

    Returns JQuery

unload

  • unload(handler: function): JQuery
  • unload(eventData?: any, handler?: function): JQuery

unwrap

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

    see

    https://api.jquery.com/unwrap/

    Returns JQuery

val

  • val(): any
  • val(value: string | string[] | number): JQuery
  • val(func: function): JQuery
  • Get the current value of the first element in the set of matched elements.

    see

    https://api.jquery.com/val/#val

    Returns any

  • Set the value of each element in the set of matched elements.

    see

    https://api.jquery.com/val/#val-value

    Parameters

    • value: string | string[] | number

      A string of text, an array of strings or number corresponding to the value of each matched element to set as selected/checked.

    Returns JQuery

  • Set the value of each element in the set of matched elements.

    see

    https://api.jquery.com/val/#val-function

    Parameters

    • func: 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.

        • (index: number, value: string): string
        • Parameters

          • index: number
          • value: string

          Returns string

    Returns JQuery

width

  • width(): number
  • width(value: number | string): JQuery
  • width(func: function): JQuery
  • Get the current computed width for the first element in the set of matched elements.

    see

    https://api.jquery.com/width/#width

    Returns number

  • Set the CSS width of each element in the set of matched elements.

    see

    https://api.jquery.com/width/#width-value

    Parameters

    • value: number | string

      An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string).

    Returns JQuery

  • Set the CSS width of each element in the set of matched elements.

    see

    https://api.jquery.com/width/#width-function

    Parameters

    • func: 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.

        • (index: number, width: number): number | string
        • Parameters

          • index: number
          • width: number

          Returns number | string

    Returns JQuery

wrap

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

    see

    https://api.jquery.com/wrap/#wrap-wrappingElement

    Parameters

    • wrappingElement: JQuery | Element | string

      A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.

    Returns JQuery

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

    see

    https://api.jquery.com/wrap/#wrap-function

    Parameters

    • func: 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.

        • (index: number): string | JQuery
        • Parameters

          • index: number

          Returns string | JQuery

    Returns JQuery

wrapAll

  • wrapAll(wrappingElement: JQuery | Element | string): JQuery
  • wrapAll(func: function): JQuery
  • Wrap an HTML structure around all elements in the set of matched elements.

    see

    https://api.jquery.com/wrapAll/#wrapAll-wrappingElement

    Parameters

    • wrappingElement: JQuery | Element | string

      A selector, element, HTML string, or jQuery object specifying the structure to wrap around the matched elements.

    Returns JQuery

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

    see

    https://api.jquery.com/wrapAll/#wrapAll-function

    Parameters

    • func: 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.

        • (index: number): string
        • Parameters

          • index: number

          Returns string

    Returns JQuery

wrapInner

  • wrapInner(wrappingElement: JQuery | Element | string): JQuery
  • wrapInner(func: function): JQuery
  • Wrap an HTML structure around the content of each element in the set of matched elements.

    see

    https://api.jquery.com/wrapInner/#wrapInner-wrappingElement

    Parameters

    • wrappingElement: JQuery | Element | string

      An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements.

    Returns JQuery

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

    see

    https://api.jquery.com/wrapInner/#wrapInner-function

    Parameters

    • func: 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.

        • (index: number): string
        • Parameters

          • index: number

          Returns string

    Returns JQuery

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc