提示框(tooltip)能在使用者把滑鼠移到某元素上時,即時顯示一段說明文字,是提升使用者體驗的常見手法。本文分享一個完整的 jQuery tooltip 外掛實作,支援多種顯示方位與動畫效果。
這個外掛透過 $.fn.tooltip 擴充 jQuery,讓你可以直接對選到的元素呼叫 .tooltip()。一開始先定義一組可自訂的設定:
(function($) {
$.fn.tooltip = function(settings) {
// 設定參數
config = {
'dialog_content_selector' : 'div.tooltip_description',
'animation_distance' : 50,
'opacity' : 0.85,
'arrow_left_offset' : 70,
'arrow_top_offset' : 50,
'arrow_height' : 20,
'arrow_width' : 20,
'animation_duration_ms' : 300,
'event_in':'mouseover',
'event_out':'mouseout'
};
if (settings) $.extend(config, settings);
// 為所有匹配元素綁定互動事件
this.each(function() {
$(this).bind(config.event_in,function(){ _show(this); })
.bind(config.event_out,function(){ _hide(this); })
});
這個 tooltip 最精彩的地方,在於它會依元素在視窗中的位置自動選擇顯示方位。透過 _show 函式,程式會判斷該元素帶有的 class(如 tooltiptopright、tooltipbottom 等),或是根據元素距離視窗邊緣的距離,智慧地決定要從「右上、右下、上方、下方」哪個方向彈出:
function _show(target_elm) {
var dialog_content = $(target_elm).find(config.dialog_content_selector);
var dialog_box = _create(dialog_content);
var is_top_right = $(target_elm).hasClass("tooltiptopright");
var is_bottom_right = $(target_elm).hasClass("tooltipbottomright");
var is_top = $(target_elm).hasClass("tooltiptop");
var is_bottom = $(target_elm).hasClass("tooltipbottom");
var has_position = is_top_right || is_bottom_right || is_top || is_bottom;
var position;
var target_elm_position = $(target_elm).offset();
// ... 依方位計算 start / end 座標與箭頭樣式 ...
計算好位置後,程式會先隱藏所有箭頭,再顯示對應方位的箭頭,最後用 animate 做出滑入動畫:
$(dialog_box).css({
top : position.start.top + "px",
left : position.start.left + "px",
opacity : config.opacity
});
$(dialog_box).find("div.arrow").hide();
$(dialog_box).find(position.arrow_class).show();
$(dialog_box).animate({
top : position.end.top,
left: position.end.left,
opacity : "toggle"
}, config.animation_duration_ms);
_hide 負責在滑鼠移出時移除提示框;_create 則負責動態建立帶有箭頭與內容的 DOM 結構,並掛載到 body 上:
function _hide(target_elm) {
$("body").find("div.jquery-gdakram-tooltip").stop().remove();
};
function _create(content_elm) {
var header = ($(content_elm).attr("title")) ? "<h1>" + $(content_elm).attr("title") + "</h1>" : '';
return $("<div class='jquery-gdakram-tooltip'>...</div>").appendTo('body');
};
這個 tooltip 外掛透過靈活的方位判斷、動畫過場與箭頭指示,打造出一個視覺細緻、互動流暢的提示框元件。你只要在 HTML 中準備好 div.tooltip_description 的內容,並對目標元素呼叫 .tooltip(),就能輕鬆升級頁面的引導體驗。