1
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2022-11-09 12:25:43 -05:00
twbs--bootstrap/js/tooltip.js

383 lines
12 KiB
JavaScript
Raw Normal View History

2013-05-21 22:30:33 -04:00
/* ========================================================================
2013-05-16 14:06:30 -04:00
* Bootstrap: tooltip.js v3.0.0
2013-08-11 17:59:39 -04:00
* http://twbs.github.com/bootstrap/javascript.html#tooltip
* Inspired by the original jQuery.tipsy by Jason Frame
2013-05-21 22:30:33 -04:00
* ========================================================================
2012-01-15 02:28:48 -05:00
* Copyright 2012 Twitter, Inc.
2011-09-11 01:24:31 -04:00
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
2013-05-21 22:30:33 -04:00
* ======================================================================== */
2011-09-11 01:24:31 -04:00
2013-05-21 22:30:33 -04:00
+function ($) { "use strict";
2013-05-16 20:18:15 -04:00
// TOOLTIP PUBLIC CLASS DEFINITION
// ===============================
var Tooltip = function (element, options) {
2013-05-16 20:18:15 -04:00
this.type =
this.options =
this.enabled =
this.timeout =
this.hoverState =
this.$element = null
this.init('tooltip', element, options)
}
2013-05-16 20:18:15 -04:00
Tooltip.DEFAULTS = {
animation: true
, placement: 'top'
, selector: false
, template: '<div class="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'
, trigger: 'hover focus'
, title: ''
, delay: 0
, html: false
, container: false
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.init = function (type, element, options) {
this.enabled = true
2013-05-16 20:44:50 -04:00
this.type = type
2013-05-16 20:18:15 -04:00
this.$element = $(element)
2013-05-16 20:44:50 -04:00
this.options = this.getOptions(options)
2013-05-16 20:18:15 -04:00
var triggers = this.options.trigger.split(' ')
2013-05-16 20:18:15 -04: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' : 'focus'
var eventOut = trigger == 'hover' ? 'mouseleave' : 'blur'
2013-08-10 17:09:05 -04:00
this.$element.on(eventIn + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
2013-05-16 20:18:15 -04:00
this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
}
2013-05-16 20:18:15 -04: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-16 20:18:15 -04:00
if (options.delay && typeof options.delay == 'number') {
options.delay = {
show: options.delay
, hide: options.delay
}
}
2013-05-16 20:18:15 -04:00
return options
}
2013-08-10 17:09:05 -04:00
Tooltip.prototype.getDelegateOptions = function () {
2013-05-16 20:18:15 -04:00
var options = {}
2013-08-10 17:09:05 -04:00
var defaults = this.getDefaults()
2013-05-16 20:18:15 -04:00
this._options && $.each(this._options, function (key, value) {
if (defaults[key] != value) options[key] = value
2013-05-22 18:18:30 -04:00
})
2013-08-10 17:09:05 -04:00
return options
}
Tooltip.prototype.enter = function (obj) {
2013-05-27 15:45:13 -04:00
var self = obj instanceof this.constructor ?
2013-08-10 17:09:05 -04:00
obj : $(obj.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type)
2013-07-24 01:58:14 -04:00
clearTimeout(self.timeout)
2013-07-24 23:10:16 -04:00
if (!self.options.delay || !self.options.delay.show) return self.show()
2013-05-16 20:18:15 -04:00
self.hoverState = 'in'
2013-07-24 01:58:14 -04:00
self.timeout = setTimeout(function () {
2013-05-16 20:18:15 -04:00
if (self.hoverState == 'in') self.show()
}, self.options.delay.show)
}
2013-05-27 15:45:13 -04:00
Tooltip.prototype.leave = function (obj) {
var self = obj instanceof this.constructor ?
2013-08-10 17:09:05 -04:00
obj : $(obj.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type)
2013-05-27 15:45:13 -04:00
2013-07-24 01:58:14 -04:00
clearTimeout(self.timeout)
2013-05-16 20:18:15 -04:00
if (!self.options.delay || !self.options.delay.hide) return self.hide()
2013-05-16 20:18:15 -04:00
self.hoverState = 'out'
2013-07-24 01:58:14 -04:00
self.timeout = setTimeout(function () {
2013-05-16 20:18:15 -04:00
if (self.hoverState == 'out') self.hide()
}, self.options.delay.hide)
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.show = function () {
var e = $.Event('show.bs.'+ this.type)
2011-08-27 21:03:01 -04:00
2013-05-16 20:18:15 -04:00
if (this.hasContent() && this.enabled) {
this.$element.trigger(e)
2011-08-27 21:03:01 -04:00
2013-05-16 20:18:15 -04:00
if (e.isDefaultPrevented()) return
2013-05-16 20:18:15 -04:00
var $tip = this.tip()
2012-12-23 04:18:16 -05:00
2013-05-16 20:18:15 -04:00
this.setContent()
2013-05-16 20:18:15 -04:00
if (this.options.animation) $tip.addClass('fade')
2013-05-16 20:18:15 -04:00
var placement = typeof this.options.placement == 'function' ?
this.options.placement.call(this, $tip[0], this.$element[0]) :
this.options.placement
2011-11-20 21:19:50 -05:00
var autoToken = /\s?auto?\s?/i
var autoPlace = autoToken.test(placement)
if (autoPlace) placement = placement.replace(autoToken, '') || 'top'
2013-05-16 20:18:15 -04:00
$tip
.detach()
.css({ top: 0, left: 0, display: 'block' })
.addClass(placement)
2013-05-16 20:18:15 -04: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 $parent = this.$element.parent()
var orgPlacement = placement
var docScroll = document.documentElement.scrollTop || document.body.scrollTop
var parentWidth = this.options.container == 'body' ? window.innerWidth : $parent.outerWidth()
var parentHeight = this.options.container == 'body' ? window.innerHeight : $parent.outerHeight()
var parentLeft = this.options.container == 'body' ? 0 : $parent.offset().left
placement = placement == 'bottom' && pos.top + pos.height + actualHeight - docScroll > parentHeight ? 'top' :
placement == 'top' && pos.top - docScroll - actualHeight < 0 ? 'bottom' :
placement == 'right' && pos.right + actualWidth > parentWidth ? 'left' :
placement == 'left' && pos.left - actualWidth < parentLeft ? 'right' :
placement
$tip
.removeClass(orgPlacement)
.addClass(placement)
}
var calculatedOffset = this.getCalculatedOffset(placement, pos, actualWidth, actualHeight)
2013-05-16 20:18:15 -04:00
2013-08-04 20:22:49 -04:00
this.applyPlacement(calculatedOffset, placement)
this.$element.trigger('shown.bs.' + this.type)
}
2013-05-16 20:44:50 -04:00
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.applyPlacement = function(offset, placement) {
2013-05-16 20:44:50 -04:00
var replace
2013-05-16 20:18:15 -04:00
var $tip = this.tip()
var width = $tip[0].offsetWidth
var height = $tip[0].offsetHeight
2013-01-26 07:50:26 -05:00
// manually read margins because getBoundingClientRect includes difference
2013-08-04 20:22:49 -04: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
2013-05-16 20:18:15 -04:00
$tip
.offset(offset)
.addClass('in')
2013-01-26 07:50:26 -05:00
2013-08-04 20:22:49 -04:00
// check to see if placing tip in new offset caused the tip to resize itself
2013-05-16 20:18:15 -04:00
var actualWidth = $tip[0].offsetWidth
var actualHeight = $tip[0].offsetHeight
2013-02-06 01:29:59 -05:00
2013-05-16 20:18:15 -04:00
if (placement == 'top' && actualHeight != height) {
2013-05-16 20:44:50 -04:00
replace = true
2013-08-04 20:22:49 -04:00
offset.top = offset.top + height - actualHeight
2013-05-16 20:18:15 -04:00
}
2013-08-04 20:22:49 -04:00
if (/bottom|top/.test(placement)) {
2013-05-16 20:18:15 -04:00
var delta = 0
2013-01-26 07:50:26 -05:00
2013-08-04 20:22:49 -04:00
if (offset.left < 0) {
2013-05-16 20:18:15 -04:00
delta = offset.left * -2
offset.left = 0
2013-01-26 07:50:26 -05:00
2013-05-16 20:18:15 -04:00
$tip.offset(offset)
2013-01-26 07:50:26 -05:00
2013-05-16 20:18:15 -04:00
actualWidth = $tip[0].offsetWidth
actualHeight = $tip[0].offsetHeight
2013-02-06 01:29:59 -05:00
}
2013-01-26 07:50:26 -05:00
2013-05-16 20:18:15 -04:00
this.replaceArrow(delta - width + actualWidth, actualWidth, 'left')
} else {
this.replaceArrow(actualHeight - height, actualHeight, 'top')
2013-02-06 01:29:59 -05:00
}
2013-05-16 20:18:15 -04:00
if (replace) $tip.offset(offset)
}
2013-05-16 20:44:50 -04:00
Tooltip.prototype.replaceArrow = function(delta, dimension, position) {
2013-05-16 20:18:15 -04:00
this.arrow().css(position, delta ? (50 * (1 - delta / dimension) + "%") : '')
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.setContent = function () {
var $tip = this.tip()
var title = this.getTitle()
2011-08-27 20:22:49 -04:00
2013-05-16 20:18:15 -04:00
$tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
$tip.removeClass('fade in top bottom left right')
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.hide = function () {
var that = this
var $tip = this.tip()
var e = $.Event('hide.bs.' + this.type)
2013-08-01 01:28:05 -04:00
function complete() { $tip.detach() }
2013-05-16 20:18:15 -04:00
this.$element.trigger(e)
2013-05-16 20:18:15 -04:00
if (e.isDefaultPrevented()) return
2013-05-16 20:18:15 -04:00
$tip.removeClass('in')
$.support.transition && this.$tip.hasClass('fade') ?
$tip
2013-08-01 01:28:05 -04:00
.one($.support.transition.end, complete)
.emulateTransitionEnd(150) :
2013-08-01 01:28:05 -04:00
complete()
this.$element.trigger('hidden.bs.' + this.type)
2013-05-16 20:18:15 -04:00
return this
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.fixTitle = function () {
var $e = this.$element
if ($e.attr('title') || typeof($e.attr('data-original-title')) != 'string') {
$e.attr('data-original-title', $e.attr('title') || '').attr('title', '')
2011-11-20 21:19:50 -05:00
}
2013-05-16 20:18:15 -04:00
}
2011-11-20 21:19:50 -05:00
2013-05-16 20:18:15 -04:00
Tooltip.prototype.hasContent = function () {
return this.getTitle()
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.getPosition = function () {
var el = this.$element[0]
return $.extend({}, (typeof el.getBoundingClientRect == 'function') ? el.getBoundingClientRect() : {
width: el.offsetWidth
, height: el.offsetHeight
}, this.$element.offset())
}
Tooltip.prototype.getCalculatedOffset = function (placement, pos, actualWidth, actualHeight) {
2013-08-04 20:22:49 -04: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 }
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.getTitle = function () {
var title
var $e = this.$element
var o = this.options
2013-05-16 20:18:15 -04:00
title = $e.attr('data-original-title')
|| (typeof o.title == 'function' ? o.title.call($e[0]) : o.title)
2013-05-16 20:18:15 -04:00
return title
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.tip = function () {
return this.$tip = this.$tip || $(this.options.template)
}
2013-01-26 07:50:26 -05:00
2013-08-04 20:36:08 -04:00
Tooltip.prototype.arrow = function () {
2013-08-04 20:22:49 -04:00
return this.$arrow = this.$arrow || this.tip().find('.tooltip-arrow')
2013-05-16 20:18:15 -04:00
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.validate = function () {
if (!this.$element[0].parentNode) {
this.hide()
this.$element = null
this.options = null
}
2013-05-16 20:18:15 -04:00
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.enable = function () {
this.enabled = true
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.disable = function () {
this.enabled = false
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.toggleEnabled = function () {
this.enabled = !this.enabled
}
2011-11-20 21:19:50 -05:00
2013-05-16 20:18:15 -04:00
Tooltip.prototype.toggle = function (e) {
2013-08-10 17:09:05 -04:00
var self = e ? $(e.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type) : this
2013-05-27 15:45:13 -04:00
self.tip().hasClass('in') ? self.leave(self) : self.enter(self)
2013-05-16 20:18:15 -04:00
}
2013-05-16 20:18:15 -04:00
Tooltip.prototype.destroy = function () {
this.hide().$element.off('.' + this.type).removeData('bs.' + this.type)
}
2013-05-16 20:18:15 -04:00
// TOOLTIP PLUGIN DEFINITION
// =========================
var old = $.fn.tooltip
2013-05-16 20:44:50 -04:00
$.fn.tooltip = function (option) {
return this.each(function () {
2013-05-16 20:18:15 -04:00
var $this = $(this)
var data = $this.data('bs.tooltip')
2013-05-16 20:18:15 -04:00
var options = typeof option == 'object' && option
if (!data) $this.data('bs.tooltip', (data = new Tooltip(this, options)))
if (typeof option == 'string') data[option]()
})
}
$.fn.tooltip.Constructor = Tooltip
2011-08-27 20:22:49 -04:00
2013-05-16 20:18:15 -04:00
// TOOLTIP NO CONFLICT
// ===================
$.fn.tooltip.noConflict = function () {
$.fn.tooltip = old
return this
}
2012-12-20 04:34:28 -05:00
}(window.jQuery);