做專案時常會需要 mask() 與 unmask() 這兩個方法:在指定元素上蓋一層遮罩,中間顯示提示訊息,藉此改善操作體驗。問題是,有些框架(例如 ExtJS)為了用這一兩個功能而整體引入,實在有點不划算。
jQuery 本身夠輕、也夠好用,所以自己包一組 mask/unmask 出來是合理的選擇。以下實作參考並改良了網路上的 documentMask 寫法,使用上更靈活。
(function(){
$.extend($.fn, {
mask: function(msg, maskDivClass){
this.unmask();
var op = { opacity: 0.8, z: 10000, bgcolor: '#ccc' };
var original = $(document.body);
var position = { top: 0, left: 0 };
if (this[0] && this[0] !== window.document) {
original = this;
position = original.position();
}
var maskDiv = $('<div class="maskdivgen"></div>');
maskDiv.appendTo(original);
var maskWidth = original.outerWidth() || original.width();
var maskHeight = original.outerHeight() || original.height();
maskDiv.css({
position: 'absolute',
top: position.top,
left: position.left,
'z-index': op.z,
width: maskWidth,
height: maskHeight,
'background-color': op.bgcolor,
opacity: 0
});
if (maskDivClass) { maskDiv.addClass(maskDivClass); }
if (msg) {
var msgDiv = $('<div style="position:absolute;border:#6593cf 1px solid;padding:2px;background:#ccca">' +
'<div style="line-height:24px;border:#a3bad9 1px solid;background:white;padding:2px 10px">' +
msg + '</div></div>');
msgDiv.appendTo(maskDiv);
var widthspace = maskDiv.width() - msgDiv.width();
var heightspace = maskDiv.height() - msgDiv.height();
msgDiv.css({
cursor: 'wait',
top: (heightspace / 2 - 2),
left: (widthspace / 2 - 2)
});
}
maskDiv.fadeIn('fast', function(){
$(this).fadeTo('slow', op.opacity);
});
return maskDiv;
},
unmask: function(){
var original = $(document.body);
if (this[0] && this[0] !== window.document) {
original = $(this[0]);
}
original.find("> div.maskdivgen").fadeOut('slow', 0, function(){
$(this).remove();
});
}
});
})();
這支插件有幾個值得留意的細節:
$(document) 上就是全螢幕遮罩,呼叫在個別元素上則只蓋住該元素,位置會自動抓 position()。outerWidth() 抓不到時改用 width(),應對不同 jQuery 版本的差異。this.unmask(),避免遮罩層堆疊。<div id="test" style="width:200px;height:100px;border:black 1px solid;"></div>
<a href="#" onclick="$('#test').mask('DIV 層遮罩')">開啟 DIV 遮罩</a>
<a href="#" onclick="$('#test').unmask()">關閉 DIV 遮罩</a>
<a href="#" onclick="$(document).mask('全屏遮罩').click(function(){ $(document).unmask() })">全螢幕遮罩</a>
三個入口分別示範了元素級遮罩、手動關閉,以及全螢幕遮罩搭配「點擊關閉」的常見互動。技術含量不高,但整理成插件之後,整個專案的遮罩需求就都能一行解決。