《jQuery从入门到精通》第二节 开始使用jQuery（二）

【课前】不要辜负年轻时候努力的你，我相信我们每一个人心中都有一个梦想，给自己一份自信，加油！

【上课】

1.2.2 jQuery API在线帮助文档

俗话说得好“授之以鱼，不如授之以渔”，在学习和开发生活中一定会遇到很多问题，这些问题或许能够自己可以解决，或许需要求助别人，亦或许需要上网上发帖，请求热心网友的回答。在这一节呢，需要读者明白的是，百度和谷歌都是开发和学习人员的一大好朋友，在学习和开发过程中遇到的问题别人一定也遇到过，所以希望大家可以借助他们的力量解决问题，能够更好地学习。

另外谷歌和百度也不是万能的，有时候可能会去作一些不是很常用的东西，亦或是忘记了某个函数该怎么写、怎么用这些在搜索引擎上或许就没有那么详尽的回答了，此时需要的是一个可以详细介绍jQuery所有函数及功能的文档那就是——jQuery在线API帮助文档。



图1-9 jQuery在线帮助文档首页

在jQuery的官方网站上看到了“API Documentation”，这便是jQuery在线帮助文档了。她是jQuery的开发方为开发者和学习人员提供的最为权威的帮助文档。全面的介绍了jQuery的相关函数以及功能，其中更有详细的样例程序。可以说是最好的帮手。



图1-10 jQuery帮助文档内容

进入帮助文档的页面首先看到的是大概这样的一个页面。左侧是按照字母排序的有关jQuery帮助的主题，包括关于Ajax、属性、回调函数等相关的主题。而右侧则是显示的该主题下所包含的API函数。或许会疑问API到底是什么？API就是应用程序接口的意思，可以理解为jQuery提供的一些供调用的函数都可以叫做jQuery的API，选用哪种JavaScript库就是为了使用其中的API函数。例如途中显示的.add()就是一个API函数。而这个在线帮助文档就可以详细介绍各个API函数的功能以及用法的文档。接下来看一下其中包含哪些内容呢？

这里以Effects > Sliding>.slideToggle()函数为例来说明API帮助文档提供了哪些帮助：



图1-11 .slideToggle()函数帮助

这里可以获得以下信息：



图1-12 函数的名称



图1-13 函数的所属域



图1-14 函数的用法



图1-15 这个函数的描述



图1-16 函数被添加进jQuery的版本



图1-17 参数的意义

注意这里的几种表示约定：.slideToggle( [duration ] [, complete ] )，由“[”，“]”包含起来的表示可选参数，对于这个函数而言duration，complete都是可选参数。意思是这个函数可以一个参数都没有写作：.slideToggle()，也可以包含一个参数：.slideToggle( duration)、.slideToggle(complete)，也可以包含两个参数.slideToggle( duration,complete )。

来看一下这个函数参数的意义：duration可以是一个Number或者String，表示这个动作会运行多长时间，默认时间是400。注意这里400的单位是毫秒，在jQuery中所有的动画的时间单位都是毫秒。Complete需要是一个Function类型，就是一个函数类型，从描述中可以知道这是一个回调函数，当这个动画完成的时候jQuery回去自动调用设定好的回调函数。所谓回调函数只是一个普通的函数，因为它会在一个动作完成时去自动调用，所以称其为回调函数。



图1-18 另一个版本的.slideToggle

在这个帮助中看到了另外一个对这个函数的描述，这就表示这个函数不止一种函数形式。这就程序员们所经常说的函数重载。可以看到这个版本的函数是在1.4.3中追加的，如果用的是1.4.3以前的jQuery库的话就不会支持此函数了。这里就不在对这个函数进行详细的介绍了。读者可以自己阅读以下关于这个版本函数的介绍。



图1-19 .slideToggle的样例

接下来jQuery在线帮助文档提供了这个函数的样例代码，供开发人员进行观察测试。第一段代码是HTML文件中的一个代码段，第二段代码是JavaScript文件中的一个代码段。这里看到代码是多么的简洁。只需寥寥数行就完成了复杂的滑动隐藏、显示的动画。

如果想查看完整的文件写法可以接着往下看：



图1-20 .slideToggle完整代码



图1-21 .slideToggle效果

这个函数jQuery还提供了更多的样例代码，这里就不在依依赘述了，可以到jQuery的在线帮助文档中进行查看和学习。

【下课啦】在给大家分享课程后，给自己打一下广告，笔者的一个淘宝店，有男女服饰，情侣装，望大家可以光顾一下，支持一下笔者哈：https://shop111461602.taobao.com/