搜尋結果頁、詞條說明頁,只要牽涉到「找」這個動作,把命中的關鍵字標出來幾乎是標配。本文用一段自製的 jQuery 外掛,做到在頁面中把關鍵字包成 <strong>,同時支援中文多詞與大小寫設定。
jQuery.fn.extend({
highlight: function (search, configs) {
if (typeof (search) == 'undefined') return;
var configs = jQuery.extend({
insensitive: 1, // 是否忽略大小寫:0 區分、1 不區分
hls_class: 'highlight', // 高亮後套用的 class
clear_last: true // 是否先清掉先前的高亮
}, configs);
// 先還原舊的高亮標記,避免重複嵌套
if (configs.clear_last) {
$(this).find("strong." + configs.hls_class).each(function () {
$(this).after($(this).text());
$(this).remove();
});
}
return this.each(function () {
if (typeof (search) == "string") {
$(this).highregx(search, configs);
} else if (search.constructor === Array) {
for (var query in search) {
var search_str = $.trim(search[query]);
if (search_str != "") $(this).highregx(search_str, configs);
}
}
});
},
highregx: function (query, configs) {
query = this.unicode(query);
var regex = new RegExp("(<[^>]*>)|(" + query + ")", configs.insensitive ? "ig" : "g");
this.html(this.html().replace(regex, function (a, b, c) {
// a 若以 < 開頭代表是標籤本身,原樣保留,不加高亮
return (a.charAt(0) == "<") ? a : "<strong class="" + configs.hls_class + "">" + c + "</strong>";
}));
},
unicode: function (s) {
var len = s.length;
var rs = "";
s = s.replace(/([-.*+?^${}()|[]/])/g, "$1"); // 跳脫正則特殊字元
for (var i = 0; i < len; i++) {
if (s.charCodeAt(i) > 255)
rs += "u" + s.charCodeAt(i).toString(16);
else
rs += s.charAt(i);
}
return rs;
}
});
這段程式把非 ASCII 字元(也就是中文)轉成 uXXXX 形式,目的是讓中文關鍵字能安全地進到正則表達式裡比對,避開編碼與特殊字元帶來的問題。這是它能「支援中文多詞」的關鍵。
<[^>]*> 這一段因為操作方式是直接對 html() 的結果做字串替換,正則很可能誤傷到標籤本身。加上這個分支後,比對到標籤就原樣吐回,只有純文字節點會被包上 strong,這是不破壞 DOM 結構的保護措施。
同一段內容重複呼叫 highlight 時,若不清除舊標記,strong 會一層層疊上去。預設開啟清除,可以讓高亮結果保持可重複、可還原。
// 單一關鍵字
$("#content").highlight("jQuery");
// 多個關鍵字,傳陣列
$("#content").highlight(["jQuery", "高亮", "外掛"]);
// 自訂 class 與大小寫行為
$("#content").highlight("jQuery", { hls_class: "hl", insensitive: 0 });
對應的 CSS 只要一行就能收尾:
.highlight { background: #ff0; font-weight: bold; }
值得一提的是,這種直接改 innerHTML 的做法在現代專案裡要留意 XSS 風險:如果搜尋字或頁面內容含有使用者輸入,建議改用 DOM 節點操作或先做好轉義,再套上高亮邏輯。