0
0
mirror of https://github.com/twbs/bootstrap.git synced 2024-11-29 11:24:18 +01:00
Bootstrap/js/tooltip.js

462 lines
14 KiB
JavaScript
Raw Normal View History

2013-05-22 04:30:33 +02:00
/* ========================================================================
2014-02-13 10:12:26 +01:00
* Bootstrap: tooltip.js v3.1.1
* http://getbootstrap.com/javascript/#tooltip
* Inspired by the original jQuery.tipsy by Jason Frame
2013-05-22 04:30:33 +02:00
* ========================================================================
* Copyright 2011-2014 Twitter, Inc.
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
2013-05-22 04:30:33 +02:00
* ======================================================================== */
2011-09-11 07:24:31 +02:00
2014-06-10 07:18:05 +02:00
(function (o_o) {
typeof define === 'function' && define.amd ? define(['jquery'], o_o) :
typeof exports === 'object' ? o_o(require('jquery')) : o_o(jQuery)
2014-06-10 07:18:05 +02:00
})(function ($) {
2014-01-01 15:42:41 +01:00
'use strict';
2013-05-17 02:18:15 +02:00
// TOOLTIP PUBLIC CLASS DEFINITION
// ===============================
var Tooltip = function (element, options) {
2013-05-17 02:18:15 +02:00
this.type =
this.options =
this.enabled =
this.timeout =
this.hoverState =
this.$element = null
this.init('tooltip', element, options)
}
2014-05-13 06:15:16 +02:00
Tooltip.VERSION = '3.1.1'
2013-05-17 02:18:15 +02:00
Tooltip.DEFAULTS = {
2013-12-15 20:04:32 +01:00
animation: true,
placement: 'top',
selector: false,
template: '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>',
2013-12-15 20:04:32 +01:00
trigger: 'hover focus',
title: '',
delay: 0,
html: false,
container: false,
viewport: {
selector: 'body',
padding: 0
}
2013-05-17 02:18:15 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.init = function (type, element, options) {
this.enabled = true
this.type = type
this.$element = $(element)
this.options = this.getOptions(options)
this.$viewport = this.options.viewport && $(this.options.viewport.selector || this.options.viewport)
2013-05-17 02:18:15 +02:00
var triggers = this.options.trigger.split(' ')
2013-05-17 02:18:15 +02:00
for (var i = triggers.length; i--;) {
var trigger = triggers[i]
if (trigger == 'click') {
this.$element.on('click.' + this.type, this.options.selector, $.proxy(this.toggle, this))
} else if (trigger != 'manual') {
var eventIn = trigger == 'hover' ? 'mouseenter' : 'focusin'
var eventOut = trigger == 'hover' ? 'mouseleave' : 'focusout'
2013-05-17 02:18:15 +02:00
2013-08-10 23:09:05 +02:00
this.$element.on(eventIn + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
2013-05-17 02:18:15 +02:00
this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
}
2013-05-17 02:18:15 +02:00
}
this.options.selector ?
(this._options = $.extend({}, this.options, { trigger: 'manual', selector: '' })) :
this.fixTitle()
}
Tooltip.prototype.getDefaults = function () {
return Tooltip.DEFAULTS
}
Tooltip.prototype.getOptions = function (options) {
options = $.extend({}, this.getDefaults(), this.$element.data(), options)
2013-05-17 02:18:15 +02:00
if (options.delay && typeof options.delay == 'number') {
options.delay = {
2013-12-15 20:04:32 +01:00
show: options.delay,
hide: options.delay
2013-05-17 02:18:15 +02:00
}
}
2013-05-17 02:18:15 +02:00
return options
}
2013-08-10 23:09:05 +02:00
Tooltip.prototype.getDelegateOptions = function () {
2013-05-17 02:18:15 +02:00
var options = {}
2013-08-10 23:09:05 +02:00
var defaults = this.getDefaults()
2013-05-17 02:18:15 +02:00
this._options && $.each(this._options, function (key, value) {
if (defaults[key] != value) options[key] = value
2013-05-23 00:18:30 +02:00
})
2013-08-10 23:09:05 +02:00
return options
}
Tooltip.prototype.enter = function (obj) {
2013-05-27 21:45:13 +02:00
var self = obj instanceof this.constructor ?
obj : $(obj.currentTarget).data('bs.' + this.type)
if (!self) {
self = new this.constructor(obj.currentTarget, this.getDelegateOptions())
$(obj.currentTarget).data('bs.' + this.type, self)
}
2013-07-24 07:58:14 +02:00
clearTimeout(self.timeout)
self.hoverState = 'in'
2013-07-25 05:10:16 +02:00
if (!self.options.delay || !self.options.delay.show) return self.show()
self.timeout = setTimeout(function () {
2013-05-17 02:18:15 +02:00
if (self.hoverState == 'in') self.show()
}, self.options.delay.show)
}
2013-05-27 21:45:13 +02:00
Tooltip.prototype.leave = function (obj) {
var self = obj instanceof this.constructor ?
obj : $(obj.currentTarget).data('bs.' + this.type)
if (!self) {
self = new this.constructor(obj.currentTarget, this.getDelegateOptions())
$(obj.currentTarget).data('bs.' + this.type, self)
}
2013-05-27 21:45:13 +02:00
2013-07-24 07:58:14 +02:00
clearTimeout(self.timeout)
2013-05-17 02:18:15 +02:00
self.hoverState = 'out'
2013-05-17 02:18:15 +02:00
if (!self.options.delay || !self.options.delay.hide) return self.hide()
self.timeout = setTimeout(function () {
2013-05-17 02:18:15 +02:00
if (self.hoverState == 'out') self.hide()
}, self.options.delay.hide)
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.show = function () {
2013-12-07 01:51:59 +01:00
var e = $.Event('show.bs.' + this.type)
2011-08-28 03:03:01 +02:00
2013-05-17 02:18:15 +02:00
if (this.hasContent() && this.enabled) {
this.$element.trigger(e)
2011-08-28 03:03:01 +02:00
var inDom = $.contains(document.documentElement, this.$element[0])
if (e.isDefaultPrevented() || !inDom) return
var that = this
2013-05-17 02:18:15 +02:00
var $tip = this.tip()
2012-12-23 10:18:16 +01:00
var tipId = this.getUID(this.type)
2013-05-17 02:18:15 +02:00
this.setContent()
$tip.attr('id', tipId)
this.$element.attr('aria-describedby', tipId)
2013-05-17 02:18:15 +02:00
if (this.options.animation) $tip.addClass('fade')
2013-05-17 02:18:15 +02:00
var placement = typeof this.options.placement == 'function' ?
this.options.placement.call(this, $tip[0], this.$element[0]) :
this.options.placement
2011-11-21 03:19:50 +01:00
var autoToken = /\s?auto?\s?/i
var autoPlace = autoToken.test(placement)
if (autoPlace) placement = placement.replace(autoToken, '') || 'top'
2013-05-17 02:18:15 +02:00
$tip
.detach()
.css({ top: 0, left: 0, display: 'block' })
.addClass(placement)
.data('bs.' + this.type, this)
2013-05-17 02:18:15 +02:00
this.options.container ? $tip.appendTo(this.options.container) : $tip.insertAfter(this.$element)
var pos = this.getPosition()
var actualWidth = $tip[0].offsetWidth
var actualHeight = $tip[0].offsetHeight
if (autoPlace) {
var orgPlacement = placement
var $parent = this.$element.parent()
var parentDim = this.getPosition($parent)
placement = placement == 'bottom' && pos.top + pos.height + actualHeight - parentDim.scroll > parentDim.height ? 'top' :
placement == 'top' && pos.top - parentDim.scroll - actualHeight < 0 ? 'bottom' :
placement == 'right' && pos.right + actualWidth > parentDim.width ? 'left' :
placement == 'left' && pos.left - actualWidth < parentDim.left ? 'right' :
placement
$tip
.removeClass(orgPlacement)
.addClass(placement)
}
var calculatedOffset = this.getCalculatedOffset(placement, pos, actualWidth, actualHeight)
2013-05-17 02:18:15 +02:00
2013-08-05 02:22:49 +02:00
this.applyPlacement(calculatedOffset, placement)
this.hoverState = null
2014-03-17 08:12:55 +01:00
var complete = function () {
that.$element.trigger('shown.bs.' + that.type)
}
$.support.transition && this.$tip.hasClass('fade') ?
$tip
.one($.support.transition.end, complete)
.emulateTransitionEnd(150) :
complete()
}
2013-05-17 02:44:50 +02:00
}
Tooltip.prototype.applyPlacement = function (offset, placement) {
2013-05-17 02:18:15 +02:00
var $tip = this.tip()
var width = $tip[0].offsetWidth
var height = $tip[0].offsetHeight
2013-01-26 13:50:26 +01:00
// manually read margins because getBoundingClientRect includes difference
2013-08-05 02:22:49 +02:00
var marginTop = parseInt($tip.css('margin-top'), 10)
var marginLeft = parseInt($tip.css('margin-left'), 10)
// we must check for NaN for ie 8/9
if (isNaN(marginTop)) marginTop = 0
if (isNaN(marginLeft)) marginLeft = 0
offset.top = offset.top + marginTop
offset.left = offset.left + marginLeft
// $.fn.offset doesn't round pixel values
// so we use setOffset directly with our own function B-0
2014-01-03 23:37:03 +01:00
$.offset.setOffset($tip[0], $.extend({
using: function (props) {
$tip.css({
top: Math.round(props.top),
left: Math.round(props.left)
})
}
}, offset), 0)
$tip.addClass('in')
2013-01-26 13:50:26 +01:00
2013-08-05 02:22:49 +02:00
// check to see if placing tip in new offset caused the tip to resize itself
2013-05-17 02:18:15 +02:00
var actualWidth = $tip[0].offsetWidth
var actualHeight = $tip[0].offsetHeight
2013-02-06 07:29:59 +01:00
2013-05-17 02:18:15 +02:00
if (placement == 'top' && actualHeight != height) {
2013-08-05 02:22:49 +02:00
offset.top = offset.top + height - actualHeight
2013-05-17 02:18:15 +02:00
}
var delta = this.getViewportAdjustedDelta(placement, offset, actualWidth, actualHeight)
if (delta.left) offset.left += delta.left
else offset.top += delta.top
2013-01-26 13:50:26 +01:00
var arrowDelta = delta.left ? delta.left * 2 - width + actualWidth : delta.top * 2 - height + actualHeight
var arrowPosition = delta.left ? 'left' : 'top'
var arrowOffsetPosition = delta.left ? 'offsetWidth' : 'offsetHeight'
2013-01-26 13:50:26 +01:00
$tip.offset(offset)
this.replaceArrow(arrowDelta, $tip[0][arrowOffsetPosition], arrowPosition)
2013-05-17 02:18:15 +02:00
}
Tooltip.prototype.replaceArrow = function (delta, dimension, position) {
2013-09-18 18:50:02 +02:00
this.arrow().css(position, delta ? (50 * (1 - delta / dimension) + '%') : '')
2013-05-17 02:18:15 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.setContent = function () {
var $tip = this.tip()
var title = this.getTitle()
2011-08-28 02:22:49 +02:00
2013-05-17 02:18:15 +02:00
$tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
$tip.removeClass('fade in top bottom left right')
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.hide = function () {
var that = this
var $tip = this.tip()
var e = $.Event('hide.bs.' + this.type)
this.$element.removeAttr('aria-describedby')
function complete() {
if (that.hoverState != 'in') $tip.detach()
that.$element.trigger('hidden.bs.' + that.type)
}
2013-08-01 07:28:05 +02:00
2013-05-17 02:18:15 +02:00
this.$element.trigger(e)
2013-05-17 02:18:15 +02:00
if (e.isDefaultPrevented()) return
2013-05-17 02:18:15 +02:00
$tip.removeClass('in')
$.support.transition && this.$tip.hasClass('fade') ?
$tip
2013-08-01 07:28:05 +02:00
.one($.support.transition.end, complete)
.emulateTransitionEnd(150) :
2013-08-01 07:28:05 +02:00
complete()
this.hoverState = null
2013-05-17 02:18:15 +02:00
return this
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.fixTitle = function () {
var $e = this.$element
2014-05-29 06:35:22 +02:00
if ($e.attr('title') || typeof ($e.attr('data-original-title')) != 'string') {
2013-05-17 02:18:15 +02:00
$e.attr('data-original-title', $e.attr('title') || '').attr('title', '')
2011-11-21 03:19:50 +01:00
}
2013-05-17 02:18:15 +02:00
}
2011-11-21 03:19:50 +01:00
2013-05-17 02:18:15 +02:00
Tooltip.prototype.hasContent = function () {
return this.getTitle()
}
Tooltip.prototype.getPosition = function ($element) {
$element = $element || this.$element
var el = $element[0]
var isBody = el.tagName == 'BODY'
return $.extend({}, (typeof el.getBoundingClientRect == 'function') ? el.getBoundingClientRect() : null, {
scroll: isBody ? document.documentElement.scrollTop || document.body.scrollTop : $element.scrollTop(),
width: isBody ? $(window).width() : $element.outerWidth(),
height: isBody ? $(window).height() : $element.outerHeight()
2014-03-17 08:12:55 +01:00
}, isBody ? { top: 0, left: 0 } : $element.offset())
2013-05-17 02:18:15 +02:00
}
Tooltip.prototype.getCalculatedOffset = function (placement, pos, actualWidth, actualHeight) {
2013-08-05 02:22:49 +02:00
return placement == 'bottom' ? { top: pos.top + pos.height, left: pos.left + pos.width / 2 - actualWidth / 2 } :
placement == 'top' ? { top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2 } :
placement == 'left' ? { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth } :
/* placement == 'right' */ { top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width }
}
Tooltip.prototype.getViewportAdjustedDelta = function (placement, pos, actualWidth, actualHeight) {
var delta = { top: 0, left: 0 }
if (!this.$viewport) return delta
var viewportPadding = this.options.viewport && this.options.viewport.padding || 0
var viewportDimensions = this.getPosition(this.$viewport)
if (/right|left/.test(placement)) {
var topEdgeOffset = pos.top - viewportPadding - viewportDimensions.scroll
var bottomEdgeOffset = pos.top + viewportPadding - viewportDimensions.scroll + actualHeight
if (topEdgeOffset < viewportDimensions.top) { // top overflow
delta.top = viewportDimensions.top - topEdgeOffset
} else if (bottomEdgeOffset > viewportDimensions.top + viewportDimensions.height) { // bottom overflow
delta.top = viewportDimensions.top + viewportDimensions.height - bottomEdgeOffset
}
} else {
var leftEdgeOffset = pos.left - viewportPadding
var rightEdgeOffset = pos.left + viewportPadding + actualWidth
if (leftEdgeOffset < viewportDimensions.left) { // left overflow
delta.left = viewportDimensions.left - leftEdgeOffset
} else if (rightEdgeOffset > viewportDimensions.width) { // right overflow
delta.left = viewportDimensions.left + viewportDimensions.width - rightEdgeOffset
}
}
return delta
2013-08-05 02:22:49 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.getTitle = function () {
var title
var $e = this.$element
var o = this.options
2013-05-17 02:18:15 +02:00
title = $e.attr('data-original-title')
|| (typeof o.title == 'function' ? o.title.call($e[0]) : o.title)
2013-05-17 02:18:15 +02:00
return title
}
Tooltip.prototype.getUID = function (prefix) {
do prefix += ~~(Math.random() * 1000000)
while (document.getElementById(prefix))
return prefix
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.tip = function () {
2014-03-17 08:12:55 +01:00
return (this.$tip = this.$tip || $(this.options.template))
2013-05-17 02:18:15 +02:00
}
2013-01-26 13:50:26 +01:00
2013-08-05 02:36:08 +02:00
Tooltip.prototype.arrow = function () {
2014-03-17 08:12:55 +01:00
return (this.$arrow = this.$arrow || this.tip().find('.tooltip-arrow'))
2013-05-17 02:18:15 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.validate = function () {
if (!this.$element[0].parentNode) {
this.hide()
this.$element = null
this.options = null
}
2013-05-17 02:18:15 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.enable = function () {
this.enabled = true
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.disable = function () {
this.enabled = false
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.toggleEnabled = function () {
this.enabled = !this.enabled
}
2011-11-21 03:19:50 +01:00
2013-05-17 02:18:15 +02:00
Tooltip.prototype.toggle = function (e) {
var self = this
if (e) {
self = $(e.currentTarget).data('bs.' + this.type)
if (!self) {
self = new this.constructor(e.currentTarget, this.getDelegateOptions())
$(e.currentTarget).data('bs.' + this.type, self)
}
}
2013-05-27 21:45:13 +02:00
self.tip().hasClass('in') ? self.leave(self) : self.enter(self)
2013-05-17 02:18:15 +02:00
}
2013-05-17 02:18:15 +02:00
Tooltip.prototype.destroy = function () {
2013-12-27 03:18:53 +01:00
clearTimeout(this.timeout)
this.hide().$element.off('.' + this.type).removeData('bs.' + this.type)
}
2013-05-17 02:18:15 +02:00
// TOOLTIP PLUGIN DEFINITION
// =========================
function Plugin(option) {
return this.each(function () {
2013-05-17 02:18:15 +02:00
var $this = $(this)
var data = $this.data('bs.tooltip')
2013-05-17 02:18:15 +02:00
var options = typeof option == 'object' && option
2013-12-27 03:27:43 +01:00
if (!data && option == 'destroy') return
if (!data) $this.data('bs.tooltip', (data = new Tooltip(this, options)))
if (typeof option == 'string') data[option]()
})
}
var old = $.fn.tooltip
$.fn.tooltip = Plugin
$.fn.tooltip.Constructor = Tooltip
2011-08-28 02:22:49 +02:00
2013-05-17 02:18:15 +02:00
// TOOLTIP NO CONFLICT
// ===================
$.fn.tooltip.noConflict = function () {
$.fn.tooltip = old
return this
}
2014-06-10 07:18:05 +02:00
});