jQuery API 中文文档

jQuery 是一个高效、精简并且功能丰富的 JavaScript 工具库。它提供的 API 易于使用且兼容众多浏览器,这让诸如 HTML 文档遍历和操作、事件处理、动画和 Ajax 操作更加简单。如果你是一个 jQuery 新手,我们建议你先到jQuery 学习中心历练历练。

如果你是在升级新版本的 jQuery ,务必阅读我们博客上列出的版本发布说明。如果你以前使用的是 1.9 版本之前的 jQuery ,建议你再看一看 1.9 版本升级指南

注意,这份 API 中文文档是关于 jQuery 的,其他兄弟项目的 API 文档地址如下:


.blur()

为 "blur" 事件绑定一个处理函数,或者触发元素上的 "blur" 事件(注:此事件不支持冒泡)。

.click()

为 JavaScript 的"click" 事件绑定一个处理器,或者触发元素上的 "click" 事件。

.closest()

从元素本身开始,在DOM 树上逐级向上级元素匹配,并返回最先匹配的祖先元素。以数组的形式返回与选择器相匹配的所有元素,从当前元素开始,在 DOM 树中向上遍历。

.css()

获取匹配元素集合中的第一个元素的样式属性的值设置每个匹配元素的一个或多个CSS属性。

.data()

在匹配元素上存储任意相关数据. 返回匹配的元素集合中的第一个元素的给定名称的数据存储的值。 通过.data(name, value)或HTML5 data-* 属性设置

deferred.notifyWith()

根据给定的上下文(context)和args递延调用Deferred(延迟)对象上进行中的回调(progressCallbacks )。

deferred.reject()

拒绝Deferred(延迟)对象,并根据给定的args参数调用任何失败回调函数(failCallbacks)。

.delegate()

为所有匹配选择器(selector参数)的元素绑定一个或多个事件处理函数,基于一个指定的根元素的子集,匹配的元素包括那些目前已经匹配到的元素,也包括那些今后可能匹配到的元素。

.eq()

减少匹配元素的集合为指定的索引的哪一个元素。

event.data

当当前正在执行的处理程序绑定时,一个可选的数据对象传递给一个事件方法。

.filter()

筛选元素集合中匹配表达式 或 通过传递函数测试的 那些元素集合。

.find()

通过一个选择器,jQuery对象,或元素过滤,得到当前匹配的元素集合中每个元素的后代。

.finish()

停止当前正在运行的动画,删除所有排队的动画,并完成匹配元素所有的动画。

.get()

通过jQuery对象获取一个对应的DOM元素。通过检索匹配jQuery对象得到对应的DOM元素。

.has()

筛选匹配元素集合中的那些有相匹配的选择器或DOM元素的后代元素。

.hover()

将二个事件函数绑定到匹配元素上,分别当鼠标指针进入和离开元素时被执行。将一个单独事件函数绑定到匹配元素上,分别当鼠标指针进入和离开元素时被执行。

.is()

判断当前匹配的元素集合中的元素,是否为一个选择器,DOM元素,或者jQuery对象,如果这些元素至少一个匹配给定的参数,那么返回true。

jQuery.Deferred()

一个构造函数,返回一个链式实用对象方法来注册多个回调,回调队列,  调用回调队列,并转达任何同步或异步函数的成功或失败状态。

jQuery.cssHooks

直接向 jQuery 中添加钩子,用于覆盖设置或获取特定 CSS 属性时的方法,目的是为了标准化 CSS 属性名或创建自定义属性。

jQuery.cssNumber

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

jQuery.data()

存储任意数据到指定的元素,返回设置的值。 返回用jQuery.data(element, name, value)储存在元素上的相应名字的数据,或者元素上完整的数据存储

jQuery.each()

一个通用的迭代函数,它可以用来无缝迭代对象和数组。数组和类似数组的对象通过一个长度属性(如一个函数的参数对象)来迭代数字索引,从0到length - 1。其他对象通过其属性名进行迭代。

jQuery()

接受一个包含一个CSS选择器的字符串,用于匹配的一组元素。根据提供的原始 HTML 标记字符串,动态创建由 jQuery 对象包装的 DOM 元素。当DOM完成加载的时候绑定一个要执行的函数。

jQuery.unique()

删除数组中重复元素。只处理删除DOM元素数组,而不能处理字符串或者数字数组。

.load()

从服务器载入数据并且将返回的 HTML 代码并插入至 匹配的元素 中。

.map()

通过一个函数匹配当前集合中的每个元素,产生一个包含新的jQuery对象。

.mouseenter()

为 mouse enters(鼠标进入) 事件绑定一个处理函数,或者触发元素上的 mouse enters(鼠标进入) 事件。

.mouseleave()

为 mouse leaves(鼠标离开) 事件绑定一个处理函数,或者触发元素上的 mouse leaves(鼠标离开) 事件。

.mouseout()

为 JavaScript 的 "mouseout" 事件绑定一个处理函数,或者触发元素上的该事件。(注:支持事件冒泡)

.mouseover()

为 JavaScript 的 "mouseover" 事件绑定一个处理函数,或者触发元素上的该事件。(注:支持事件冒泡)

.next()

取得匹配的元素集合中每一个元素紧邻的后面同辈元素的元素集合。如果提供一个选择器,那么只有紧跟着的兄弟元素满足选择器时,才会返回此元素。

.nextAll()

获得每个匹配元素集合中所有下面的同辈元素,选择性筛选的选择器。

.nextUntil()

通过选择器,DOM节点,或jQuery对象得到每个元素之后的所有兄弟元素,但不包括匹配的元素。

.offset()

在匹配的元素集合中,获取的第一个元素的当前坐标,坐标相对于文档。 设置匹配的元素集合中每一个元素的坐标, 坐标相对于文档。

.offsetParent()

取得离指定元素最近的含有定位信息的祖先元素。含有定位信息的元素指的是,CSS 的 position 属性是 relative, absolute, 或 fixed 的元素。

.outerHeight()

获取元素集合中第一个元素的当前计算高度值,包括padding,border和选择性的margin。返回一个整数(不包含“px”)表示的值  ,或如果在一个空集合上调用该方法,则会返回 null。

.outerWidth()

获取元素集合中第一个元素的当前计算宽度值,包括padding,border和选择性的margin。(注:返回一个整数(不包含“px”)表示的值,或如果在一个空集合上调用该方法,则会返回 null。)

.parent()

取得匹配元素集合中,每个元素的父元素,可以提供一个可选的选择器。

.parents()

获得集合中每个匹配元素的祖先元素,可以提供一个可选的选择器作为参数。

.parentsUntil()

查找当前元素的所有的前辈元素,直到遇到选择器, DOM 节点或 jQuery 对象匹配的元素为止,但不包括这些元素。

.position()

获取匹配元素中第一个元素的当前坐标,相对于offset parent的坐标。( 译者注:offset parent指离该元素最近的而且被定位过的祖先元素 )

.prev()

取得一个包含匹配的元素集合中每一个元素紧邻的前一个同辈元素的元素集合。选择性筛选的选择器。

.prevAll()

获得集合中每个匹配元素的所有前面的兄弟元素,选择性筛选的选择器。

.prevUntil()

获取每个元素但不包括选择器,DOM节点,或者jQuery对象匹配的元素的所有前面的兄弟元素。

.promise()

返回一个 Promise 对象,用来观察当某种类型的所有行动绑定到集合,排队与否还是已经完成。

.scrollTop()

获取匹配的元素集合中第一个元素的当前垂直滚动条的位置或设置每个匹配元素的垂直滚动条位置。设置每个匹配元素的垂直滚动条位置

.siblings()

获得匹配元素集合中每个元素的兄弟元素,可以提供一个可选的选择器。。

.slice()

根据指定的下标范围,过滤匹配的元素集合,并生成一个新的 jQuery 对象。

.toggleClass()

在匹配的元素集合中的每个元素上添加或删除一个或多个样式类,取决于这个样式类是否存在或值切换属性。即:如果存在(不存在)就删除(添加)一个类。