DIV CSS 佈局教程網

擴展 Bootstrap Tooltip 讓提示框支持鼠標交互
編輯:關於JavaScript     

前陣子公司項目裡有個特殊需求找到我:tooltip 裡要放鏈接,用戶得能點進去。原生 tooltip 做不到這件事——鼠標一移出依賴元素,提示面板立刻消失,根本來不及點。

所以目標很明確:給用戶留出足夠時間把鼠標從觸發元素移到提示面板上;並且當鼠標停在面板上時不能隱藏,讓用戶能與裡面的鏈接、表單控件正常交互。

網上常見的土辦法

這需求不算罕見,Google 一下確實有不少現成代碼,比如這段來自 plnkr.co 的寫法(https://plnkr.co/edit/x2VMhh?p=preview):

$(".pop").popover({
  trigger: "manual",
  html: true,
  animation: false
})
.on("mouseenter", function () {
  var _this = this;
  $(this).popover("show");
  $(".popover").on("mouseleave", function () {
    $(_this).popover('hide');
  });
})
.on("mouseleave", function () {
  var _this = this;
  setTimeout(function () {
    if (!$(".popover:hover").length) {
      $(_this).popover("hide");
    }
  }, 300);
});

它借用了 Bootstrap 的 popover(popover 在源碼中是繼承自 tooltip 的擴展組件),把觸發方式改為手動,自己控制顯示與隱藏時機。移出依賴元素時延遲 300ms,若這段時間內鼠標還沒進入面板就隱藏,否則阻止隱藏。

功能上沒問題,但這段代碼可讀性差、重複使用幾乎不可能。於是我決定按 Bootstrap 的插件規範重寫一版。

從源碼找切入點

翻 tooltip 源碼會發現它的擴展性不錯:顯示和隱藏依賴內部的 hoverState 狀態來控制,in 代表在依賴元素之上,out 代表移出。同時它本身就支持延遲動畫機制。所以我們只需要控制 hoverState:

var DelayTooltip = function (element, options) {
  this.init('delayTooltip', element, options);
  this.initDelayTooltip();
};

DelayTooltip.DEFAULTS = $.extend({}, $.fn.tooltip.Constructor.DEFAULTS, {
  trigger: 'hover',
  delay: { hide: 300 }
});

DelayTooltip.prototype.delayTooltipEnter = function () {
  this.hoverState = 'in';
};

DelayTooltip.prototype.delayTooltipLeave = function () {
  this.hoverState = 'out';
  this.leave(this);
};

DelayTooltip.prototype.initDelayTooltip = function () {
  this.tip()
    .on('mouseenter.' + this.type, $.proxy(this.delayTooltipEnter, this))
    .on('mouseleave.' + this.type, $.proxy(this.delayTooltipLeave, this));
};

構造 tooltip 對象的同時註冊面板的 mouseenter / mouseleave,分別設置對應的 hoverState。移出面板時手動調用從 tooltip 繼承來的 leave 方法。隱藏延時則放進默認 options,保持可配置。

插件完整代碼

上面這些就是擴展所需的全部邏輯,剩下的都是 Bootstrap 插件的固定模板:

(function ($) {
  'use strict';

  var DelayTooltip = function (element, options) {
    this.init('delayTooltip', element, options);
    this.initDelayTooltip();
  };

  if (!$.fn.tooltip) throw new Error('Popover requires tooltip.js');

  DelayTooltip.VERSION = '0.1';

  DelayTooltip.DEFAULTS = $.extend({}, $.fn.tooltip.Constructor.DEFAULTS, {
    trigger: 'hover',
    delay: { hide: 300 }
  });

  DelayTooltip.prototype = $.extend({}, $.fn.tooltip.Constructor.prototype);
  DelayTooltip.prototype.constructor = DelayTooltip;

  DelayTooltip.prototype.getDefaults = function () {
    return DelayTooltip.DEFAULTS;
  };

  DelayTooltip.prototype.delayTooltipEnter = function () {
    this.hoverState = 'in';
  };

  DelayTooltip.prototype.delayTooltipLeave = function () {
    this.hoverState = 'out';
    this.leave(this);
  };

  DelayTooltip.prototype.initDelayTooltip = function () {
    this.tip()
      .on('mouseenter.' + this.type, $.proxy(this.delayTooltipEnter, this))
      .on('mouseleave.' + this.type, $.proxy(this.delayTooltipLeave, this));
  };

  function Plugin(option) {
    return this.each(function () {
      var $this = $(this);
      var data = $this.data('bs.delayTooltip');
      var options = typeof option == 'object' && option;

      if (!data && /destroy|hide/.test(option)) return;
      if (!data) $this.data('bs.delayTooltip', (data = new DelayTooltip(this, options)));
      if (typeof option == 'string') data[option]();
    });
  }

  var old = $.fn.delayTooltip;
  $.fn.delayTooltip = Plugin;
  $.fn.delayTooltip.Constructor = DelayTooltip;

  $.fn.delayTooltip.noConflict = function () {
    $.fn.delayTooltip = old;
    return this;
  };
})(jQuery);

使用方式

HTML:

<div id="tooltip">bs tooltip:你能點擊鏈接?</div>
<hr>
<div id="delayTooltip">delay tooltip:嘗試點擊鏈接</div>
<hr>
<div id="delayTooltipInHtml" data-html="true" data-placement="bottom"
     data-toggle="delayTooltip">delay tooltip:利用 html 標簽實現</div>

JavaScript:

(function (global, $) {
  var page = function () {};

  page.prototype.bootstrap = function () {
    var html = 'Weclome to my blog ' +
      '<a target="_blank" href="greengerong.github.io">破狼博客</a>!' +
      '<input type="text" placeholder="input some thing"/>';

    $('#tooltip').tooltip({ html: true, placement: 'top', title: html });
    $('#delayTooltip').delayTooltip({ html: true, placement: 'bottom', title: html });
    $('#delayTooltipInHtml').attr('title', html).delayTooltip();

    return this;
  };

  global.Page = page;
})(this, jQuery);

$(function () {
  'use strict';
  var page = new window.Page().bootstrap();
});

這款擴展既支持 jQuery 調用,也支持在 HTML 中用 data-toggle 聲明式使用。

相比直接粘一段 setTimeout 的代碼,這種寫法的好處是複用性強、延時可配置,後續想改成點擊觸發或加別的交互邏輯,也只需要覆寫對應的 prototype 方法。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved