寫插件寫久了才發現,兩個最基本的能力 jQuery 早就提供了,只是自己一直繞遠路。
$("dom").data("mydata", "this is data");
不必自己在外層包一個物件當快取,也不必擔心命名污染。data() 存的資料不會寫進 DOM 屬性,也不會出現在 innerHTML 裡,對效能與安全都比較友好。
this.myfn = function(){ /* ... */ };
在插件的建構函式中,this 就代表目前這個 jQuery 物件,直接掛函式上去即可,呼叫端就能寫成 $("#x").myfn()。記得回傳 this 以維持鏈式呼叫。
這個插件的功能近似 CSS 的 text-overflow,但差別是它能精確控制「顯示幾個字」,而不只是靠寬度決定。
/**
* demo:
* 1. $("#limittext").limittext();
* 2. $("#limittext").limittext({"limit":1});
* 3. $("#limittext").limittext({"limit":1,"fill":"(部分隱藏)","fillid":"aaa"});
* 4. $("#limittext").limittext({...}).limit(10);
* 5. $("#limittext").limittext({...}).limit('all');
* @param {Object} opt
* @author Lonely
* @link https://liushan.net
*/
jQuery.fn.extend({
limittext: function(opt){
opt = $.extend({
"limit": 30,
"fill": "...",
"fillid": null
}, opt);
var $this = $(this);
var body = $(this).data('body');
// 第一次呼叫時把原始內容存進 data,之後重複呼叫都用它當基準
if (body == null) {
body = $this.html();
$(this).data('body', body);
}
// 這個方法掛在 this 上,因此可以在鏈式呼叫中直接使用
this.limit = function(limit){
var showbody;
if (body.length <= limit || limit == 'all') {
showbody = body;
} else {
if (opt.fillid == null)
showbody = body.substring(0, limit) + opt.fill;
else
showbody = body.substring(0, limit) +
"<span id='"+ opt.fillid +"'>" + opt.fill + "<span>";
}
$(this).html(showbody);
};
this.limit(opt.limit);
return this;
}
});
如果直接把截斷後的結果寫回元素,第二次呼叫時取到的 body 就已經是「被截斷過的殘缺版本」,再截一次只會越來越短。把完整原文存進 data(),每次要重新計算時都從那裡取,這才是正確做法。
反過來說,這也意味著:如果元素的內容會動態改變(例如 ajax 回填),記得同步更新 data('body'),否則顯示的會是舊的內容。
第一,fillid 那個分支的結束標籤寫成了 <span> 而非 </span>,會造成標籤沒閉合,實作時請修正。
第二,this.limit 裡用 $(this) 取值,但在 this.limit 被當成獨立函式呼叫(例如放在 setTimeout 裡)時,this 的指向會改變。比較穩健的寫法是改用外層已經抓好的 $this 變數。