jQuery API

最新推荐文章于 2024-03-16 15:48:59 发布

HeliumLau

最新推荐文章于 2024-03-16 15:48:59 发布

阅读量544

点赞数

分类专栏： jQuery 文章标签： jquery

jQuery 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

jQuery API 3.2.1

选择器

基本

id

$('#myDiv')

$('#foo\\[bar\\]')

element

$('div')

class

$('.myClass')

*

匹配所有元素$('*')

selector1, selector2

将所有匹配到的元素合并到一个结果内

HTML 代码:

<div>div</div>
<p class="myClass">p class="myClass"</p>
<span>span</span>
<p class="notMyClass">p class="notMyClass"</p>

jQuery 代码:

$("div,span,p.myClass")

结果:

[ <div>div</div>, <p class="myClass">p class="myClass"</p>, <span>span</span> ]

层级

ancestor descendant

在给定的祖先元素下匹配所有的后代元素

$('div input')

parent > child

在给定的父元素下匹配所有的子元素

$('div > input')

prev + next

匹配所有紧接在prev元素后的next元素

$('div + input')

prev ~ siblings

匹配所有紧接在prev元素后的siblings元素

$('div ~ input')

基本筛选器

：first

获取匹配的第一个元素

$('div:first')

:not(selector)

去除所有与给定选择器匹配的元素

$('input:not(:checked)')

:even

匹配所有索引值为偶数的元素，从0开始计数

$('tr:even')

:odd

匹配所有索引值为奇数的元素，从0开始计数

$('tr: odd')

:eq(index)

匹配一个给定索引值的元素，从0开始计数

$('tr:eq(1)')

:gt(index)

匹配所有大于给定索引值的元素，从0开始

$('tr:gt(0)')

:lt(index)

匹配所有小于给定索引值的元素，从0开始

$('tr:lt(0)')

:last

获取最后个元素

$('li:last')

匹配如h1,h2,h3之类的标题元素

$(':header')

:animated

匹配所有正在执行动画效果的元素

$(':animated')

:focus

匹配当前获取焦点的元素
ps: 如果你正在寻找当前的焦点元素，$(document.activeElement)比较合适，这样不用查询整个DOM树。

:root

选择该文档的根元素

$(':root')

内容

:contains(text)

匹配包含给定文本的元素

<div>John Resig</div>
<div>George Martin</div>
<div>Malcom John Sinclair</div>
<div>J. Ohn

$("div:contains('John')")

:empty

匹配所有不包含子元素或文本的空元素

$('td:empty')

:has(selector)

匹配含有选择器所匹配的元素的元素

$('div:has(p)')

:parent

匹配含有子元素或文本的元素

可见性

:hidden

匹配所有不可见元素，或者type为hidden的元素

$('tr:hidden')

:visible

匹配所有的可见元素

属性

[attribute]

匹配包含给定属性的元素

<div>
  <p>Hello!</p>
</div>
<div id="test2"></div>

$("div[id]")

[attribute=value]

匹配给定的属性是某个特定值的元素

$("input[name='newsletter']")

[attribute!=value]

匹配所有不含有指定的属性，或者属性不等于特定值的元素

$("input[name!='newsletter']")

[attribute^=value]

匹配给定的属性是以某些值开始的元素

$("input[name^='news']")

[attribute$=value]

匹配给定的属性是以某些值结尾的元素

$("input[name$='letter']")

[attribute*=value]

匹配给定的属性是以包含某些值的元素

$("input[name*='man']")

[selector1][selector2][selectorN]

复合属性选择器，需要同时满足多个条件时使用。

$("input[id][name$='man']")

子元素

:first-child

匹配所给选择器的第一个子元素

$("ul li:first-child")

:last-child

匹配所给选择器的最后一个子元素

$("ul li:last-child")

:nth-child

以1开始

:only-child

如果某个元素是父元素中唯一的子元素，那将会被匹配（不包括文本节点）

$("ul li:only-child")

表单

:input

匹配所有input，textarea，select和button元素

$(":input")

:text

匹配所有的单行文本框

$(':text')

:password

匹配所有的密码框

:radio

匹配所有的单选按钮

:checkbox

匹配所有的复选框

:submit

匹配所有的提交按钮

:image

匹配所有的图像域

:reset

匹配所有重置按钮

:button

匹配所有按钮

:file

匹配所有文件域

表单对象属性

:enabled

匹配所有可用元素

:disabled

匹配所有不可用元素

:checked

匹配所有选中的被选中元素

:selected

匹配所有选中的option元素

$("select option:selected")

混淆选择器

核心

工具

CSS

效果

事件

事件对象

回调函数

文档处理

属性

筛选

ajax

jQuery.ajax（url，[settings]）

概述
通过HTTP请求加载远程数据。

$.ajax(url, [settings])

回调函数
如果要处理$.ajax()得到的数据，则需要使用回调函数。

beforeSend在发送请求之前调用，并且传入一个XMLHttpRequest作为参数。
error在请求出错时调用。传入XMLHttpRequest对象，描述错误类型的字符串以及一个异常对象（如果有的话）
dataFilter在请求成功之后调用。传入返回的数据以及“dataType”参数的值。并且必须返回新的数据（可能是处理过得）传递给success回调函数。
success当请求之后调用。传入返回后的数据，以及包含成功代码的字符串。
complete当请求完成之后调用这个函数，无论成功或失败。传入XMLHttpRequest对象，以及一个包含成功或错误代码的字符串。

数据类型
$.ajax()函数依赖服务器提供的信息来处理返回的数据。如果服务器报告说返回的数据是XML，那么返回的结果就可以用普通的XML方法或者jQuery的选择器来遍历。如果见得到其他类型，比如HTML，则数据就以文本形式来对待。

通过dataType选项还可以指定其他不同数据处理方式。除了单纯的XML，还可以指定 html、json、jsonp、script或者text。

其中，text和xml类型返回的数据不会经过处理。数据仅仅简单的将XMLHttpRequest的responseText或responseHTML属性传递给success回调函数，

”’注意”’，我们必须确保网页服务器报告的MIME类型与我们选择的dataType所匹配。比如说，XML的话，服务器端就必须声明 text/xml 或者 application/xml 来获得一致的结果。

如果指定为html类型，任何内嵌的JavaScript都会在HTML作为一个字符串返回之前执行。类似的，指定script类型的话，也会先执行服务器端生成JavaScript，然后再把脚本作为一个文本数据返回。

如果指定为json类型，则会把获取到的数据作为一个JavaScript对象来解析，并且把构建好的对象作为结果返回。为了实现这个目的，他首先尝试使用JSON.parse()。如果浏览器不支持，则使用一个函数来构建。JSON数据是一种能很方便通过JavaScript解析的结构化数据。如果获取的数据文件存放在远程服务器上（域名不同，也就是跨域获取数据），则需要使用jsonp类型。使用这种类型的话，会创建一个查询字符串参数 callback=? ，这个参数会加在请求的URL后面。服务器端应当在JSON数据前加上回调函数名，以便完成一个有效的JSONP请求。如果要指定回调函数的参数名来取代默认的callback，可以通过设置$.ajax()的jsonp参数。

注意，JSONP是JSON格式的扩展。他要求一些服务器端的代码来检测并处理查询字符串参数。更多信息可以参阅最初的文章。

如果指定了script或者jsonp类型，那么当从服务器接收到数据时，实际上是用了<script>标签而不是XMLHttpRequest对象。这种情况下，$.ajax()不再返回一个XMLHttpRequest对象，并且也不会传递事件处理函数，比如beforeSend。

发送数据到服务器
默认情况下，Ajax请求使用GET方法。如果要使用POST方法，可以设定type参数值。这个选项也会影响data选项中的内容如何发送到服务器。

data选项既可以包含一个查询字符串，比如 key1=value1&key2=value2 ，也可以是一个映射，比如 {key1: ‘value1’, key2: ‘value2’} 。如果使用了后者的形式，则数据再发送器会被转换成查询字符串。这个处理过程也可以通过设置processData选项为false来回避。如果我们希望发送一个XML对象给服务器时，这种处理可能并不合适。并且在这种情况下，我们也应当改变contentType选项的值，用其他合适的MIME类型来取代默认的 application/x-www-form-urlencoded 。

高级选项
global选项用于阻止响应注册的回调函数，比如.ajaxSend，或者ajaxError，以及类似的方法。这在有些时候很有用，比如发送的请求非常频繁且简短的时候，就可以在ajaxSend里禁用这个。更多关于这些方法的详细信息，请参阅下面的内容。

如果服务器需要HTTP认证，可以使用用户名和密码可以通过username和password选项来设置。

Ajax请求是限时的，所以错误警告被捕获并处理后，可以用来提升用户体验。请求超时这个参数通常就保留其默认值，要不就通过jQuery.ajaxSetup来全局设定，很少为特定的请求重新设置timeout选项。

默认情况下，请求总会被发出去，但浏览器有可能从他的缓存中调取数据。要禁止使用缓存的结果，可以设置cache参数为false。如果希望判断数据自从上次请求后没有更改过就报告出错的话，可以设置ifModified为true。

scriptCharset允许给<script>标签的请求设定一个特定的字符集，用于script或者jsonp类似的数据。当脚本和页面字符集不同时，这特别好用。

Ajax的第一个字母是asynchronous的开头字母，这意味着所有的操作都是并行的，完成的顺序没有前后关系。$.ajax()的async参数总是设置成true，这标志着在请求开始后，其他代码依然能够执行。强烈不建议把这个选项设置成false，这意味着所有的请求都不再是异步的了，这也会导致浏览器被锁死。

$.ajax函数返回他创建的XMLHttpRequest对象。通常jQuery只在内部处理并创建这个对象，但用户也可以通过xhr选项来传递一个自己创建的xhr对象。返回的对象通常已经被丢弃了，但依然提供一个底层接口来观察和操控请求。比如说，调用对象上的.abort()可以在请求完成前挂起请求。

参数
url, [settings] Object
url：一个用来包含发送请求的URL字符串。
settings：AJAX请求设置。所有选项都是可选的。

选项

settings：选项

accepts（Map）
默认：取决于数据类型。
内容类型发送请求头，告诉服务器什么样的响应会接受返回。如果accepts设置需要修改，推荐在$.ajaxSetup()方法中做一次。

async（Boolean）
默认：true
默认设置下，所有请求均为异步请求。如果需要发送同步请求，请将此选项设置为false。注意，同步请求将锁住浏览器，用户其它操作必须等待请求完成才可以执行。

beforeSend(XHR) （Function）
发送请求前可修改XMLHttpRequest对象的函数，如添加自定义Http头。XMLHttpRequest对象是唯一的参数。这是一个Ajax事件。如果返回false可以取消本次ajax请求。

cache（Boolean）
默认：true
dataType为script和jsonp时默认为false，设置为false将不缓存此页面

complete（XHR，testStatus）（Function）
请求完成后回调函数。

contents（Map）
一个以“{字符串：正则表达式}”配对的对象，用来确定jQuery将如何解析响应，给定其内容类型。

contentType（String）
默认：application/x-www-form-urlencoded
发送信息至服务器时内容编码类型。默认值适合大多数情况。

context（Object）
这个对象用于设置Ajax相关回调函数的上下文。也就是说，让回调函数内this指向这个对象（如果不设定这个参数，那么this就指向调用本次AJAX请求时传递的options参数）。比如指定一个DOM元素作为context参数，这样就设置了success回调函数的上下文为这个DOM元素。

converters（Map）
默认： {“* text”: window.String, “text html”: true, “text json”: jQuery.parseJSON, “text xml”: jQuery.parseXML}
一个数据类型对数据类型转换器的对象。每个转换器的值是一个函数，返回响应的转化值

crossDomain（Map）
默认：同域请求为false
跨域请求为true如果你想强制跨域请求（如JSONP形式）同一域，设置crossDomain为true。这使得例如，服务器端重定向到另一个域

data（Object,String）
发送到服务器的数据。将自动转换为请求字符串格式。GET 请求中将附加在 URL 后。查看 processData 选项说明以禁止此自动转换。必须为 Key/Value 格式。如果为数组，jQuery 将自动为不同值对应同一个名称。如 {foo:[“bar1”, “bar2”]} 转换为 “&foo=bar1&foo=bar2”。

dataFilter（Function）
给Ajax返回的原始数据的进行预处理的函数。提供data和type两个参数：data是Ajax返回的原始数据，type是调用jQuery.ajax时提供的dataType参数。函数返回的值将由jQuery进一步处理。

dataType（String）
预期服务器返回的数据类型。如果不指定，jQuery 将自动根据 HTTP 包 MIME 信息来智能判断，比如XML MIME类型就被识别为XML。在1.4中，JSON就会生成一个JavaScript对象，而script则会执行这个脚本。随后服务器端返回的数据会根据这个值解析后，传递给回调函数。可用值:

“xml”: 返回 XML 文档，可用 jQuery 处理。

“html”: 返回纯文本 HTML 信息；包含的script标签会在插入dom时执行。

“script”: 返回纯文本 JavaScript
代码。不会自动缓存结果。除非设置了”cache”参数。”’注意：”’在远程请求时(不在同一个域下)，所有POST请求都将转为GET请求。(因为将使用DOM的script标签来加载)

“json”: 返回 JSON 数据。

“jsonp”: JSONP 格式。使用 JSONP 形式调用函数时，如 “myurl?callback=?” jQuery 将自动替换 ?
为正确的函数名，以执行回调函数。

“text”: 返回纯文本字符串

error（Function）
默认: 自动判断 (xml 或 html)
请求失败时调用此函数。有以下三个参数：XMLHttpRequest 对象、错误信息、（可选）捕获的异常对象。如果发生了错误，错误信息（第二个参数）除了得到null之外，还可能是”timeout”, “error”, “notmodified” 和 “parsererror”。

global（Boolean）
(默认: true) 是否触发全局 AJAX 事件。设置为 false 将不会触发全局 AJAX 事件，如 ajaxStart 或 ajaxStop 可用于控制不同的 Ajax 事件。

headers（map）
Default: {}
一个额外的”{键:值}”对映射到请求一起发送。此设置被设置之前beforeSend函数被调用;因此，消息头中的值设置可以在覆盖beforeSend函数范围内的任何设置。

ifModified（Boolean）
(默认: false) 仅在服务器数据改变时获取新数据。使用 HTTP 包 Last-Modified 头信息判断。在jQuery 1.4中，他也会检查服务器指定的’etag’来确定数据没有被修改过。

isLocal（map）
默认: 取决于当前的位置协议
允许当前环境被认定为“本地”，（如文件系统），即使jQuery默认情况下不会承认它。以下协议目前公认为本地：file, *-extension, and widget。如果isLocal设置需要修改，建议在$.ajaxSetup()方法中这样做一次。

jsonp（String）
在一个jsonp请求中重写回调函数的名字。这个值用来替代在”callback=?”这种GET或POST请求中URL参数里的”callback”部分，比如{jsonp:’onJsonPLoad’}会导致将”onJsonPLoad=?”传给服务器。

jsonpCallback（String）
为jsonp请求指定一个回调函数名。这个值将用来取代jQuery自动生成的随机函数名。这主要用来让jQuery生成度独特的函数名，这样管理请求更容易，也能方便地提供回调函数和错误处理。你也可以在想让浏览器缓存GET请求的时候，指定这个回调函数名。

mimeType（String）
一个mime类型用来覆盖XHR的 MIME类型。

password（String）
用于响应HTTP访问认证请求的密码

processData（Boolean）
(默认: true) 默认情况下，通过data选项传递进来的数据，如果是一个对象(技术上讲只要不是字符串)，都会处理转化成一个查询字符串，以配合默认内容类型 “application/x-www-form-urlencoded”。如果要发送 DOM 树信息或其它不希望转换的信息，请设置为 false。

scriptCharset（String）
只有当请求时dataType为”jsonp”或”script”，并且type是”GET”才会用于强制修改charset。通常只在本地和远程的内容编码不同时使用。

statusCode（map）
默认: {}
一组数值的HTTP代码和函数对象，当响应时调用了相应的代码。例如，如果响应状态是404，将触发以下警报：

$.ajax({ statusCode: {404: function() {
alert(‘page not found’); } });

success(data, textStatus, jqXHR)
请求成功后的回调函数。参数：由服务器返回，并根据dataType参数进行处理后的数据；描述状态的字符串。还有 jqXHR（在jQuery 1.4.x的中，XMLHttpRequest）对象。在jQuery 1.5，成功设置可以接受一个函数数组。

traditional（Boolean）
如果你想要用传统的方式来序列化数据，那么就设置为true。

timeout（Number）
设置请求超时时间（毫秒）。此设置将覆盖全局设置。

type（String）
(默认: “GET”) 请求方式 (“POST” 或 “GET”)，默认为 “GET”。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可以使用，但仅部分浏览器支持。

username（String）
用于响应HTTP访问认证请求的用户名

xhrFields（Map）
一对“文件名-文件值”在本机设置XHR对象。例如，如果需要的话，你可以用它来设置withCredentials为true的跨域请求。

示例
描述:

加载并执行一个 JS 文件。
jQuery 代码:

$.ajax({
  type: "GET",
  url: "test.js",
  dataType: "script"
});

描述:

保存数据到服务器，成功时显示信息。
jQuery 代码:

$.ajax({
   type: "POST",
   url: "some.php",
   data: "name=John&location=Boston",
   success: function(msg){
     alert( "Data Saved: " + msg );
   }
});

描述:

装入一个 HTML 网页最新版本。
jQuery 代码:

$.ajax({
  url: "test.html",
  cache: false,
  success: function(html){
    $("#results").append(html);
  }
});

描述:

同步加载数据。发送请求时锁住浏览器。需要锁定用户交互操作时使用同步方式。
jQuery 代码:

 var html = $.ajax({
  url: "some.php",
  async: false
 }).responseText;

描述:

发送 XML 数据至服务器。设置 processData 选项为 false，防止自动转换数据格式。
jQuery 代码:

 var xmlDocument = [create xml document];
 $.ajax({
   url: "page.php",
   processData: false,
   data: xmlDocument,
   success: handleResponse
 });

延迟对象

其它