本文总结原生JavaScript插件开发实践,重点探讨弹出层组件的架构设计。通过自执行函数封装避免变量冲突,利用构造函数暴露接口。详细分析参数配置的必要性,区分必填与可选参数,并结合默认值合并策略,确保插件具备扩展性与易用性,避免成为一次性代码。
前言
前言
此前公司网站设计存在不规范之处,尤其是弹出层组件缺乏统一标准。由于UI设计师多次更换,每位设计师实现的样式各异,导致体验不一致。近期公司着手规范此类问题,决定将通用功能模块化或插件化。笔者计划开发一个弹出层插件,并在此过程中总结相关开发理念。尽管该插件逻辑并不复杂,但其中蕴含的设计思想值得记录与分享。
架构设计思路
该怎样架构?
架构的核心在于预判并解决未来可能出现的场景与需求。
过往封装插件时,曾因后端反馈接口难以使用而进行复盘。问题主要在于暴露的接口不足,且部分无需传递的参数强制要求传入。这种缺乏前瞻性设计的写法,往往导致插件沦为一次性工具,缺乏复用价值。
因此,在编写插件前需预先规划参数体系:明确哪些为必填项,哪些为可选项,预判未来可能扩展的功能点,以及哪些配置项允许后续修改。只有充分考量这些因素,才能避免插件出现结构性缺陷。
基础代码结构
基本雏形
;(function(window,document){
var MaskShare = function(){
};
MaskShare.prototype = {};
window.MaskShare = MaskShare;
}(window,document));
将代码封装于自执行函数中,以隔离作用域并防止变量污染。随后将构造函数挂载至window对象,便于外部实例化与调用。
期望实现的效果如下所示:

参数分析与配置
思考需要哪些参数
核心功能为:点击指定元素触发遮罩层显示,点击遮罩层区域则隐藏该层。
据此分析,至少需要接收一个目标元素参数,用于指定触发源。同时,应提供默认配置项,以支持灵活定制。
;(function(window,document){
var MaskShare = function(targetDom,options){
// 判断是用函数创建的还是用new创建的。这样我们就可以通过MaskShare("dom") 或 new MaskShare("dom")来使用这个插件了
if(!(this instanceof MaskShare))return new MaskShare(targetDom,options);
// 参数合并
this.options = this.extend({
// 这个参数以后可能会更改所以暴露出去
imgSrc:"../static/img/coupon-mask_1.png"
},options);
// 判断传进来的是DOM还是字符串
if((typeof targetDom)==="string"){
this.targetDom = document.querySelector(targetDom);
}else{
this.targetDom = targetDom;
}
var boxDom = document.createElement("div");
var imgDom = document.createElement("img");
// 设置默认样式 注意将z-index值设置大一些,防止其他元素层级比遮罩层高
boxDom.style.cssText = "display: none;position: absolute;left: 0;top: 0;width: 100%;height:100%;background-color: rgba(0,0,0,0.8);z-index:9999;";
imgDom.style.cssText = "margin-top:20px;width: 100%;";
// 追加或重设其样式
if(this.options.boxDomStyle){
this.setStyle(boxDom,this.options.boxDomStyle);
}
if(this.options.imgDomStyle){
this.setStyle(imgDom,this.options.imgDomStyle);
}
imgDom.src = this.options.imgSrc;
boxDom.appendChild(imgDom);
this.boxDom = boxDom;
// 初始化
this.init();
};
MaskShare.prototype = {
init:function(){
this.event();
},
extend:function(obj,obj2){
for(var k in obj2){
obj[k] = obj2[k];
}
return obj;
},
setStyle:function(dom,objStyle){
for(var k in objStyle){
dom.style[k] = objStyle[k];
}
},
event:function(){
var _this = this;
this.targetDom.addEventListener("click",function(){
document.body.appendChild(_this.boxDom);
_this.boxDom.style.display = "block";
// 打开遮罩层的回调
_this.options.open&&_this.options.open();
},false);
this.boxDom.addEventListener("click",function(){
this.style.display = "none";
// 关闭遮罩层的回调
_this.options.close&&_this.options.close();
},false);
}
};
// 暴露方法
window.MaskShare = MaskShare;
}(window,document));
使用示例:
MaskShare(".immediately",{
imgSrc:"../static/img/loading_icon.gif",
boxDomStyle:{
opacity:".9"
},
imgDomStyle:{
opacity:".8"
},
open:function(){
console.log("show");
},
close:function(){
console.log("close");
}
});
局限性与展望
本次总结
进一步审视发现,当前设计仍存在局限。例如,若触发内容非图片而是纯文本,现有方案无法适配。构建实用插件不仅要求技术实现无误,更需具备全面的前瞻性思考。本文所述仅为起点,后续优化空间依然广阔。
以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,同时也希望多多支持本站!