JS封装——构建自己的jQuery插件

参与的多个项目有时候需要复用一些功能,那么就希望能把一些功能进行封装,提高易用性和代码复用性。
直接上个简单的栗子,详情见imageCarousel

 (function ( $, window, document) {
    var pluginName = "imageCarousel",
    
    //默认配置参数  default settings
    defaults = {
        speed:300,    //滑动速度 slide speed
        autoSlide:true,    //是否主动滑动 slide automatically
        holdTime:4000,      //主动滑动时图片停留时间 the time to hold image between two slidings
        alwaysShowTitle:true, //是否一直显示图片标题 
        color:"#000",   //字体颜色 font color
        clickImage:function(element,index){}, //点击图片时回调函数,参数:element:图片元素,index:图片在图片数组中的序号
    };
    
    // The actual plugin constructor
    function Plugin ( element, images,options ) {
            this.element = element;
            this.images = images;
            this.settings = $.extend( {}, defaults, options );
            this._defaults = defaults;
            this._name = pluginName;
            this.init();
    };
    
    Plugin.prototype = {
            init: function () {   //初始化
                var e = this;
                e.width = $(e.element).width();
                e.height = $(e.element).height();
                $(e.element).addClass("imageCarouselBox");
                $(e.element).css("color",e.settings.color);
                e.picTimer;
                e.setImages(e.images);
            },
                        
            setImages:function(images){  //设置图片数组,可以用于修改当前播放的图片数组
                var e = this;
                e.dataLength = e.images.length;
                $(e.element).html("");
                e.index = 0;
                var ulText = "<ul>"
                var btnText = "<div class='btnBg'><div class='btn'>";
                for(var i=0; i < e.dataLength; i++) {
                    btnText += "<span></span>";
                    ulText += "<li ><img src='"+images[i].path+"' alt='' ><div class='text-box'>"+images[i].title+"</div></li>"; //插入图片
                }
                btnText += "</div></div><div class='preNext pre'></div><div class='preNext next'></div>";
                ulText += "</ul>";
                
                $(e.element).append(ulText);
                $(e.element).append(btnText);
                
                $(e.element).find("ul").css("width",e.width * e.dataLength);
                $(e.element).find("ul li").css("width",e.width).click(function(){
                    e.settings.clickImage(this,e.index);
                });
                if(e.settings.alwaysShowTitle){
                    $(e.element).find("ul li .text-box").fadeIn();
                } else{
                    $(e.element).find("ul li").mouseenter(function(){
                        $(this).find(".text-box").fadeIn();
                    }).mouseleave(function(){
                        $(this).find(".text-box").fadeOut();
                    });
                }
                
                $(e.element).find(".btn span").css("opacity",0.4).mouseenter(function() {
                    e.index = $(e.element).find(".btn span").index(this);
                    e.showImage(e.index);
                }).eq(0).trigger("mouseenter");
                
                $(e.element).find(" .preNext").css("opacity",0.2).hover(function() {
                    $(this).stop(true,false).animate({"opacity":"0.5"},e.settings.speed);
                },function() {
                    $(this).stop(true,false).animate({"opacity":"0.2"},e.settings.speed);
                });
                
                $(e.element).find(" .pre").click(function() {
                    e.index -= 1;
                    if(e.index == -1) {e.index = e.dataLength - 1;}
                    e.showImage(e.index);
                });
                $(e.element).find(" .next").click(function() {
                    e.index += 1;
                    if(e.index == e.dataLength) {e.index = 0;}
                    e.showImage(e.index);
                });
                
                if(e.settings.autoSlide){
                    $(e.element).hover(function() {
                        clearInterval(e.picTimer);
                    },function() {
                        e.picTimer = setInterval(function() {
                            e.showImage(e.index);
                            e.index++;
                            if(e.index == e.dataLength) {e.index = 0;}
                        },e.settings.holdTime); 
                    }).trigger("mouseleave");
                }
            },
        
            showImage: function(index){  //切换当前显示的图片
                var e = this;
                var nowLeft = -index*e.width;
                $(e.element).find("ul").stop(true,false).animate({"left":nowLeft},e.settings.speed);
                $(e.element).find(" .btn span").stop(true,false).animate({"opacity":"0.4"},e.settings.speed)
                  .eq(index).stop(true,false).animate({"opacity":"0.8"},e.settings.speed);
            }
        };

    $.fn[ pluginName ] = function ( images,options) {   //向jQuery注册插件
        var e = this;
        e.each(function() {
            $.data( e, "plugin_" + pluginName, new Plugin( this,images, options ) );
        });
        return e;
    };
    
})(jQuery, window, document)

以上代码封装了一个jQuery图片轮播插件。

1. 用匿名函数封装组件

首先看看如下写法:

(function ( $, window, document) {
  //....封装组件逻辑
})(jQuery, window, document);

这就是一个匿名函数的形式。将它拆开来看如下:

var fn = function($, window, document){
  //....封装组件逻辑
};
fn(jQuery, window, document);

也就是说这种写法就表示先定义一个方法,然后立即调用这个方法,jQuery相当于实参。打开jquery.js的原文件可以看到,jQuery是这个文件里面的一个全局变量。

2. 向jQuery注册组件

先直接看上面栗子的最后几行代码:

$.fn[ pluginName ] = function ( images,options) {   //向jQuery注册插件
    var e = this;
    e.each(function() {
        $.data( e, "plugin_" + pluginName, new Plugin( this,images, options ) );
    });
    return e;
};

由于在栗子最前面我们定义了

var pluginName = "imageCarousel";

那么

$.fn[ pluginName ] = function ( images,options) { 
  //...
}

在jQuery中注册了一个名为imageCarousel的函数及其参数,与jQuery自带的函数一样,可以通过以下方法调用:

$(element).imageCarousel(images,options);

e.each(function() {
    $.data( e, "plugin_" + pluginName, new Plugin( this,images, options ) );
});

则向当前元素添加了一个名为“plugin_imageCarousel”的属性,它的值为 new Plugin( element,images, options )。
也就是说,

$(element).imageCarousel(images,options);

这行代码实际上会向元素中添加“plugin_imageCarousel”属性,并执行了:

$(element).plugin_imageCarousel = new Plugin( element,images, options );

3. 定义组件的构造函数

function Plugin ( element, images,options ) {
    this.element = element;
    this.images = images;
    this.settings = $.extend( {}, defaults, options );
    this._defaults = defaults;
    this._name = pluginName;
    this.init();
};

构造函数保护了插件的各个参数包括默认参数,然后调用了插件的 prototype 中定义的 init 方法。

4. 定义插件的行为

imageCarousel 插件在 Plugin.prototype中定义了init()、setImages(images)、showImage(index)这几个函数,具体作用不用展开说明。这些函数可以用以下方法调用:

$(element).plugin_imageCarousel.init();
$(element).plugin_imageCarousel.setImages(images);
$(element).plugin_imageCarousel.showImage(index);

5. 定义组件的配置参数

有时候我们希望能够自定义组件的一些属性或行为,那么就可以定义一组配置参数:

//默认配置参数  default settings
    defaults = {
        speed:300,    //滑动速度 slide speed
        autoSlide:true,    //是否主动滑动 slide automatically
        holdTime:4000,      //主动滑动时图片停留时间 the time to hold image between two slidings
        alwaysShowTitle:true, //是否一直显示图片标题 
        color:"#000",   //字体颜色 font color
        clickImage:function(element,index){}, //点击图片时回调函数,参数:element:图片元素,index:图片在图片数组中的序号
    };

这些参数预先设置了默认值,那么在使用的时候是如何自定义的呢?
在组件的构造函数中可以看到这样一句代码:

...
this.settings = $.extend( {}, defaults, options );
...

jquery的extend()方法作用是合并另个对象,有相同的则覆盖,没有相同的则添加。也就是说,上面这行代码中options对象中的参数会覆盖defaults对象中同名的参数,这就实现了配置参数自定义的目的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容