Question

如何创建一个自定义jQuery插件

Answer 1

jQuery 库是专为加快 JavaScript 开发速度而设计的。通过简化编写 JavaScript 的方式，减少代码量。使用 jQuery 库时，您可能会发现您经常为一些常用函数重写相同的代码。如果这样的话，这可能就是您需要编写自定义 jQuery 插件的一个原因。
jQuery 插件允许您使用自定义代码扩展 jQuery 库；您可以对一些重复性函数使用插件。例如，很多插件可供幻灯片、下拉菜单和折叠菜单所用。如果您搜索 jQuery 插件，就会发现有大量可用于自己项目的示例（看看它们是如何构建的）。
常用缩略词
CSS：层叠样式表
HTML：超文本标记语言
在本文中，您将学习如何快速创建一个自定义 jQuery 插件。示例代码和逐步操作将为您演示如何创建一个 jQuery accordion 插件。如果您了解 jQuery，而且准备让您的技能再上一个台阶，这篇文章非常适合您。
您可以在此 下载 本文所用的示例源代码。
先决条件
本文假设您对 JavaScript、jQuery 和层叠样式表有一个基本了解。请参阅 参考资料 了解更多有关先决条件的信息。
回页首
准备开始
jQuery 是一个可扩展 JavaScript 语言的库。当您创建一个 jQuery 插件时，本质上是在扩展这个 jQuery 库。要真正了解插件如何扩展 jQuery 库需要对 JavaScript prototype 属性有一个基本了解。尽管不直接使用，但是 JavaScript prototype 属性可通过 jQuery 属性 fn 在后台使用，这是原生 JavaScript prototype 属性的一个 jQuery 别名。
要使用 fn 属性创建一个新 jQuery 插件，只需要为 fn 属性分配一个插件名，并将其指向一个充当构造函数的新函数，类似于纯 JavaScript。清单 1 中的代码显示了如何定义一个名为 accordion 的新 jQuery 插件，其方法是通过使用 jQuery 对象和 fn 属性，并将其分配给一个新的构造函数。
清单 1. 定义一个名为 accordion 的新 jQuery 插件
jQuery.fn.accordion = function() {
// Add plugin code here
};

清单 1 展示了创建 jQuery 插件的一种方法；该示例没有什么功能性错误。但是，创建一个 jQuery 插件所推荐的方法是，先创建一个允许使用美元符号 ($) 的包装器函数。在默认情况下，美元符号可能与其他 JavaScript 框架发生冲突，如果将插件包装在一个函数中，就不会出现冲突。清单 2 中的示例代码显示如何将一个包装器函数应用到一个 jQuery 插件定义中。
清单 2. 在一个包装器函数中包装一个名为 accordion 的新 jQuery 插件
(function($) {
$.fn.accordion = function() {
// Add plugin code here
};
})(jQuery);

在清单 2 中，jQuery 关键字被应用到包装器函数中，这允许您在插件中使用美元符号，就像使用 fn 属性时那样。包装器函数就绪后，就可以在整个插件的任何地方使用美元符号代替 jQuery 关键字，不会干扰其他第三方插件。该选项提供了一种方法使我们可以在开发整个插件中编写较少的代码，并且有助于您的插件代码保持整洁，易于维护。
回页首
维护链接性
jQuery 的一个优势是允许您使用任何类型的选择器。但是，必须记住，您的插件可以处理几种不同的元素类型。使用 this 关键字允许您的插件应用于相关函数，通过循环实现每个元素的访问，而不考虑元素类型。如果在 each 循环前使用 return 关键字，就可以使用您的插件维护链接性。清单 3 显示了分配给一个函数处理程序且与 return 关键字相结合的 each 循环。
清单 3. 在 each 循环之前使用 return 关键字
(function($) {
$.fn.accordion = function() {
return this.each(function() {
// Using return allows for chainability
});
};
})(jQuery);

有了清单 3 的代码后，示例 accordion 插件可用在一个方法调用链中。有了链接性（另一个强大的 jQuery 特性），您的插件就可用在一个方法调用链中。例如，下面的代码显示了如何淡出 HTML 元素，并在单一的方法调用链中将其从文档对象模型 (DOM) 中删除。
$("#my-div").fadeOut().remove();

回页首
构造一个 accordion
一个典型的层叠设计包括标题栏和相关内容区域。定义列表是一个可供 accordions 使用的很好的 HTML 结构；dt 元素供标题所用，而dd 元素供内容区域所用。清单 4 中的 HTML 结构是一个定义列表，含有四个标题以及相应的内容区域。
清单 4. 单一方法调用链
<dl class="accordion" id="my-accordion">
<dt>Section 1</dt>
<dd>Mauris mauris ante, blandit et, ultrices a, suscipit eget, quam.</dd>
<dt>Section 2</dt>
<dd>Vestibulum a velit eu ante scelerisque vulputate.</dd>
<dt>Section 3</dt>
<dd>Nam mi. Proin viverra leo ut odio. Curabitur malesuada.</dd>
<dt>Section 4</dt>
<dd>Vivamus nisi metus, molestie vel, gravida in, condimentum sit amet, nunc.</dd>
</dl>

清单 4 中定义的列表也有一个分配给它的名为 accordion 的 CSS 类。没有应用任何 CSS，这个 accordion
1. 没有应用任何 CSS 的 accordion 结构
accordion 类用于将类型应用到整个定义列表、标题和内容区域。在清单 5 的示例中，accordion 类本身应用于宽度、边框、字体集和字体大小。清单 5 的示例中。您可以修改任何一个正在运行的 CSS 示例以包含您自定义的风格，比如颜色、字体、大小和间距。
清单 5. 用于定义整个定义列表样式的 accordion CSS 类
.accordion {
width: 500px;
border: 1px solid #ccc;
border-bottom: none;
font-family: Arial, Helvetica, sans-serif;
font-size: 12px;
}

然后，您可以使用 accordion CSS 类定义标题 (dt) 和内容 (dd) 样式。标题和内容都包含一个设置底边框为 0 的共享样式，这允许标题栏和内容区域相互适宜地放置，如清单 6 所示。
清单 6. 与 accordion 标题和内容区域相关联的共享样式
.accordion dt,
.accordion dd {
border-bottom: 1px solid #ccc;
margin: 0px;
}

为了使 dt 元素看起来更像一个标题栏，设置一个背景色并添加一个指针光标，明显地呈现给用户该标题栏是可点击的。各种其他样式也都包括在这些类中，比如填充、字体大小和字体粗细。dd 元素添加了填充，将描述与标题隔开一点。清单 7 显示了一个示例。
清单 7. 与 accordion 标题和内容区域相关的 CSS 类
.accordion dt {
background: #eaeaea;
cursor: pointer;
padding: 8px 4px;
font-size: 13px;
font-weight: bold;
}
.accordion dd {
padding: 12px 8px;
}

有了这些增加的 CSS，视觉效果将会更完美、更像 accordion