jquery插件制作教程 txtHover
发布时间：2013-05-11 编辑：jiaochengji.com
该系列文章是我阅读<jQuery Plugin Development Beginner's Guide>后的总结，有兴趣的朋友可以去读原版的书籍
该系列文章是我阅读<jquery Plugin Development Beginner's Guide>后的总结，有兴趣的朋友可以去读原版的书籍
定义插件的结构骨架：
书中最开始使用的结构骨架如下：
jQuery.fn.fluginmane=function(){
return this.each(function(){
//code...
})
}
这种结构不是很理想，特别书中提到，为了防止冲突例子不使用$，而使用jQuery。在这里，我们使用匿名函数的方式实现插件的结构骨架，这样就可以防止可能的冲突。也希望大家好好了解下匿名函数相关的知识。
(function($){
$.fn.fluginname=function(){
return this.each(function(){
//code...
});
}
})(jQuery);
注意点：
1.为了统一和规范，我们的插件文件都将以jquery.fluginname.js的形式命名(fluginname代表你插件的名字)。
2.我们使用到的函数都需要是私有的，不能被外部访问到，这样可保证插件不会受到外部的影响和干扰（匿名函数已经保证了这点）。
3.允许用户使用options控制插件的行为。
4.默认的options允许外部访问，这样用户就可以用最少的代码实现自定义化。
5.this.each()会遍历所有符合要求的对象，他本身是个jquery对象，插件最后返回该对象。其实通过这种方式就实现了javascript的链式模式。
我们的第一个插件：txtHover
1.代码实现：
(function($){
$.fn.txtHover=function(){
return this.each(function(){
$(this).text('text changed!');
});
}
})(jQuery);
2.如何使用：
创建一个html文件，添加jquery和插件的引用，代码如下：
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<script type="text/javascript" src="Scripts/jquery-1.4.1.min.js"></script>
<script type="text/javascript" src="Scripts/jquery.txtHover.js"></script>
<script type="text/javascript">
$(document).ready(function () {
$('#test').txtHover();
});
</script>
</head>
<body>
<div id="test">
this is test.</div>
</body>
</html>
添加hover事件：
(function ($) {
$.fn.txtHover = function () {
return this.each(function () {
var temp = $(this).text();
$(this).hover(function () {
$(this).text('text changed!');
}, function () {
$(this).text(temp);
});
});
}
})(jQuery);
第一个版本，当页面加载完毕之后，div的内容就被修改了，这样的设计没多大用处。我们最常用到的是，当鼠标移到到文字上面的时候产生一些变化。改进的插件添加了hover事件。首先我们把div的原始值保存在变量temp里面，当鼠标移动到div上面的时候，文字被替换，鼠标移出时，将文字替换回来。
添加自定义选项
为了方便用户更加灵活的使用，我们需要添加自定义的功能，插件代码修改：
(function ($) {
$.fn.txtHover = function (options) {
var defaults = { txt: 'text changed!' };
var opt = $.extend(defaults, options);
return this.each(function () {
var self = $(this);
var temp = self.text();
self.hover(function () {
self.text(opt.txt);
}, function () {
self.text(temp);
});
});
}
})(jQuery);
插件定义了一个变量defaults，设置了默认的文字信息。我们使用$.extend()（不了解这个函数的朋友可以去查阅资料）方法扩展了一个新变量opt，如果用户传入的options变量包含txt，则opt就使用用户传入的，否则就使用系统默认的。我们在系统中定义了 var self = $(this)，来代替this对象。this在javascript中是个很恼人的对象，在不同函数上下文中所代表的对象会不同，将this传给一个另外的变量会避免程序出现一些错误。不熟悉的朋友很有必要好好掌握该知识点。
用户在html页面上调用插件的时候，可以自定义鼠标移到div上面时候的文字内容了。
$(document).ready(function () {
$('#test').txtHover({ txt: 'test' });
}); 好了，今天的例子到此为止。
书中最开始使用的结构骨架如下：
复制代码 代码如下:
jQuery.fn.fluginmane=function(){
return this.each(function(){
//code...
})
}
这种结构不是很理想，特别书中提到，为了防止冲突例子不使用$，而使用jQuery。在这里，我们使用匿名函数的方式实现插件的结构骨架，这样就可以防止可能的冲突。也希望大家好好了解下匿名函数相关的知识。
复制代码 代码如下:
(function($){
$.fn.fluginname=function(){
return this.each(function(){
//code...
});
}
})(jQuery);
注意点：
1.为了统一和规范，我们的插件文件都将以jquery.fluginname.js的形式命名(fluginname代表你插件的名字)。
2.我们使用到的函数都需要是私有的，不能被外部访问到，这样可保证插件不会受到外部的影响和干扰（匿名函数已经保证了这点）。
3.允许用户使用options控制插件的行为。
4.默认的options允许外部访问，这样用户就可以用最少的代码实现自定义化。
5.this.each()会遍历所有符合要求的对象，他本身是个jquery对象，插件最后返回该对象。其实通过这种方式就实现了javascript的链式模式。
我们的第一个插件：txtHover
1.代码实现：
复制代码 代码如下:
(function($){
$.fn.txtHover=function(){
return this.each(function(){
$(this).text('text changed!');
});
}
})(jQuery);
2.如何使用：
创建一个html文件，添加jquery和插件的引用，代码如下：
复制代码 代码如下:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<script type="text/javascript" src="Scripts/jquery-1.4.1.min.js"></script>
<script type="text/javascript" src="Scripts/jquery.txtHover.js"></script>
<script type="text/javascript">
$(document).ready(function () {
$('#test').txtHover();
});
</script>
</head>
<body>
<div id="test">
this is test.</div>
</body>
</html>
添加hover事件：
复制代码 代码如下:
(function ($) {
$.fn.txtHover = function () {
return this.each(function () {
var temp = $(this).text();
$(this).hover(function () {
$(this).text('text changed!');
}, function () {
$(this).text(temp);
});
});
}
})(jQuery);
第一个版本，当页面加载完毕之后，div的内容就被修改了，这样的设计没多大用处。我们最常用到的是，当鼠标移到到文字上面的时候产生一些变化。改进的插件添加了hover事件。首先我们把div的原始值保存在变量temp里面，当鼠标移动到div上面的时候，文字被替换，鼠标移出时，将文字替换回来。
添加自定义选项
为了方便用户更加灵活的使用，我们需要添加自定义的功能，插件代码修改：
复制代码 代码如下:
(function ($) {
$.fn.txtHover = function (options) {
var defaults = { txt: 'text changed!' };
var opt = $.extend(defaults, options);
return this.each(function () {
var self = $(this);
var temp = self.text();
self.hover(function () {
self.text(opt.txt);
}, function () {
self.text(temp);
});
});
}
})(jQuery);
插件定义了一个变量defaults，设置了默认的文字信息。我们使用$.extend()（不了解这个函数的朋友可以去查阅资料）方法扩展了一个新变量opt，如果用户传入的options变量包含txt，则opt就使用用户传入的，否则就使用系统默认的。我们在系统中定义了 var self = $(this)，来代替this对象。this在javascript中是个很恼人的对象，在不同函数上下文中所代表的对象会不同，将this传给一个另外的变量会避免程序出现一些错误。不熟悉的朋友很有必要好好掌握该知识点。
用户在html页面上调用插件的时候，可以自定义鼠标移到div上面时候的文字内容了。
$(document).ready(function () {
$('#test').txtHover({ txt: 'test' });
}); 好了，今天的例子到此为止。
您可能感兴趣的文章：
jquery插件制作教程 txtHover
JQuery 插件模板 制作jquery插件的朋友可以参考下
40款非常棒的jQuery 插件和制作教程（系列二）
推荐40个非常优秀的jQuery插件和教程【系列三】
40款非常棒的jQuery 插件和制作教程（系列一）
基于jQuery的表格操作插件
22个很棒的jQuery文件上传插件
Jquery插件写法笔记整理
25个非常棒的jQuery滑块插件和教程小结
Jquery插件编写简明教程
[关闭]