tooltip.js 9.71 KB
Newer Older
1
/* ===========================================================
fat's avatar
fat committed
2
 * Bootstrap: tooltip.js v3.0.0
Jon Stevens's avatar
Jon Stevens committed
3
 * http://twitter.github.com/bootstrap/javascript.html#tooltips
4
 * Inspired by the original jQuery.tipsy by Jason Frame
5
 * ===========================================================
Mark Otto's avatar
Mark Otto committed
6
 * Copyright 2012 Twitter, Inc.
Jacob Thornton's avatar
Jacob Thornton committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 *
 * 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.
 * ========================================================== */

21

fat's avatar
fat committed
22
!function ($) { "use strict";
23

fat's avatar
fat committed
24
25
  // TOOLTIP PUBLIC CLASS DEFINITION
  // ===============================
26

27
  var Tooltip = function (element, options) {
fat's avatar
fat committed
28
29
30
31
32
33
34
    this.type       =
    this.options    =
    this.enabled    =
    this.timeout    =
    this.hoverState =
    this.$element   = null

35
    this.init('tooltip', element, options)
36
37
  }

fat's avatar
fat committed
38
39
40
41
42
43
44
45
46
47
48
  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
  }
49

fat's avatar
fat committed
50
51
  Tooltip.prototype.init = function (type, element, options) {
    this.enabled  = true
fat's avatar
fat committed
52
    this.type     = type
fat's avatar
fat committed
53
    this.$element = $(element)
fat's avatar
fat committed
54
    this.options  = this.getOptions(options)
55

fat's avatar
fat committed
56
    var triggers = this.options.trigger.split(' ')
57

fat's avatar
fat committed
58
59
60
61
62
63
64
65
66
67
68
    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'

        this.$element.on(eventIn + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
        this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
69
      }
fat's avatar
fat committed
70
71
72
73
74
75
76
77
78
79
80
81
82
    }

    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)
83

fat's avatar
fat committed
84
85
86
87
88
    if (options.delay && typeof options.delay == 'number') {
      options.delay = {
        show: options.delay
      , hide: options.delay
      }
89
90
    }

fat's avatar
fat committed
91
92
    return options
  }
93

fat's avatar
fat committed
94
  Tooltip.prototype.enter = function (e) {
fat's avatar
fat committed
95
    var defaults = this.getDefaults()
fat's avatar
fat committed
96
    var options  = {}
97

fat's avatar
fat committed
98
99
100
    this._options && $.each(this._options, function (key, value) {
      if (defaults[key] != value) options[key] = value
    }, this)
101

102
    var self = $(e.currentTarget)[this.type](options).data('bs.' + this.type)
103

fat's avatar
fat committed
104
    if (!self.options.delay || !self.options.delay.show) return self.show()
105

fat's avatar
fat committed
106
    clearTimeout(this.timeout)
107

fat's avatar
fat committed
108
109
110
111
112
    self.hoverState = 'in'
    this.timeout    = setTimeout(function() {
      if (self.hoverState == 'in') self.show()
    }, self.options.delay.show)
  }
113

fat's avatar
fat committed
114
  Tooltip.prototype.leave = function (e) {
115
    var self = $(e.currentTarget)[this.type](this._options).data('bs.' + this.type)
fat's avatar
fat committed
116
117
118

    if (this.timeout) clearTimeout(this.timeout)
    if (!self.options.delay || !self.options.delay.hide) return self.hide()
119

fat's avatar
fat committed
120
121
122
123
124
    self.hoverState = 'out'
    this.timeout    = setTimeout(function() {
      if (self.hoverState == 'out') self.hide()
    }, self.options.delay.hide)
  }
125

fat's avatar
fat committed
126
  Tooltip.prototype.show = function () {
127
    var e = $.Event('show.bs.'+ this.type)
128

fat's avatar
fat committed
129
130
    if (this.hasContent() && this.enabled) {
      this.$element.trigger(e)
131

fat's avatar
fat committed
132
      if (e.isDefaultPrevented()) return
133

fat's avatar
fat committed
134
      var $tip = this.tip()
Yohn's avatar
Yohn committed
135

fat's avatar
fat committed
136
      this.setContent()
137

fat's avatar
fat committed
138
      if (this.options.animation) $tip.addClass('fade')
139

fat's avatar
fat committed
140
141
142
      var placement = typeof this.options.placement == 'function' ?
        this.options.placement.call(this, $tip[0], this.$element[0]) :
        this.options.placement
143

fat's avatar
fat committed
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
      $tip
        .detach()
        .css({ top: 0, left: 0, display: 'block' })

      this.options.container ? $tip.appendTo(this.options.container) : $tip.insertAfter(this.$element)

      var tp
      var pos          = this.getPosition()
      var actualWidth  = $tip[0].offsetWidth
      var actualHeight = $tip[0].offsetHeight

      switch (placement) {
        case 'bottom':
          tp = {top: pos.top + pos.height, left: pos.left + pos.width / 2 - actualWidth / 2}
          break
        case 'top':
          tp = {top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2}
          break
        case 'left':
          tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth}
          break
        case 'right':
          tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width}
          break
168
      }
fat's avatar
fat committed
169
170

      this.applyPlacement(tp, placement)
171
      this.$element.trigger('shown.bs.' + this.type)
172
    }
fat's avatar
fat committed
173
  }
174

fat's avatar
fat committed
175
  Tooltip.prototype.applyPlacement = function(offset, placement) {
fat's avatar
fat committed
176
    var replace
fat's avatar
fat committed
177
178
179
    var $tip   = this.tip()
    var width  = $tip[0].offsetWidth
    var height = $tip[0].offsetHeight
180

fat's avatar
fat committed
181
182
183
184
    $tip
      .offset(offset)
      .addClass(placement)
      .addClass('in')
185

fat's avatar
fat committed
186
187
    var actualWidth  = $tip[0].offsetWidth
    var actualHeight = $tip[0].offsetHeight
fat's avatar
fat committed
188

fat's avatar
fat committed
189
    if (placement == 'top' && actualHeight != height) {
fat's avatar
fat committed
190
      replace = true
fat's avatar
fat committed
191
192
193
194
195
      offset.top  = offset.top + height - actualHeight
    }

    if (placement == 'bottom' || placement == 'top') {
      var delta = 0
196

fat's avatar
fat committed
197
198
199
      if (offset.left < 0){
        delta       = offset.left * -2
        offset.left = 0
200

fat's avatar
fat committed
201
        $tip.offset(offset)
202

fat's avatar
fat committed
203
204
        actualWidth  = $tip[0].offsetWidth
        actualHeight = $tip[0].offsetHeight
fat's avatar
fat committed
205
      }
206

fat's avatar
fat committed
207
208
209
      this.replaceArrow(delta - width + actualWidth, actualWidth, 'left')
    } else {
      this.replaceArrow(actualHeight - height, actualHeight, 'top')
fat's avatar
fat committed
210
211
    }

fat's avatar
fat committed
212
213
    if (replace) $tip.offset(offset)
  }
214

fat's avatar
fat committed
215
  Tooltip.prototype.replaceArrow = function(delta, dimension, position) {
fat's avatar
fat committed
216
217
    this.arrow().css(position, delta ? (50 * (1 - delta / dimension) + "%") : '')
  }
218

fat's avatar
fat committed
219
220
221
  Tooltip.prototype.setContent = function () {
    var $tip  = this.tip()
    var title = this.getTitle()
Jacob Thornton's avatar
Jacob Thornton committed
222

fat's avatar
fat committed
223
224
225
    $tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
    $tip.removeClass('fade in top bottom left right')
  }
226

fat's avatar
fat committed
227
228
229
  Tooltip.prototype.hide = function () {
    var that = this
    var $tip = this.tip()
230
    var e    = $.Event('hide.bs.' + this.type)
231

fat's avatar
fat committed
232
    this.$element.trigger(e)
233

fat's avatar
fat committed
234
    if (e.isDefaultPrevented()) return
235

fat's avatar
fat committed
236
237
238
239
240
241
    $tip.removeClass('in')

    function removeWithAnimation() {
      var timeout = setTimeout(function () {
        $tip.off($.support.transition.end).detach()
      }, 500)
242

fat's avatar
fat committed
243
244
      $tip.one($.support.transition.end, function () {
        clearTimeout(timeout)
frntz's avatar
frntz committed
245
        $tip.detach()
fat's avatar
fat committed
246
247
      })
    }
Jacob Thornton's avatar
Jacob Thornton committed
248

fat's avatar
fat committed
249
250
251
    $.support.transition && this.$tip.hasClass('fade') ?
      removeWithAnimation() :
      $tip.detach()
252

253
    this.$element.trigger('hidden.bs.' + this.type)
254

fat's avatar
fat committed
255
256
    return this
  }
257

fat's avatar
fat committed
258
259
260
261
  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', '')
262
    }
fat's avatar
fat committed
263
  }
264

fat's avatar
fat committed
265
266
267
  Tooltip.prototype.hasContent = function () {
    return this.getTitle()
  }
268

fat's avatar
fat committed
269
270
271
272
273
274
275
  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())
  }
276

fat's avatar
fat committed
277
278
279
280
  Tooltip.prototype.getTitle = function () {
    var title
    var $e = this.$element
    var o  = this.options
281

fat's avatar
fat committed
282
283
    title = $e.attr('data-original-title')
      || (typeof o.title == 'function' ? o.title.call($e[0]) :  o.title)
284

fat's avatar
fat committed
285
286
    return title
  }
287

fat's avatar
fat committed
288
289
290
  Tooltip.prototype.tip = function () {
    return this.$tip = this.$tip || $(this.options.template)
  }
291

fat's avatar
fat committed
292
293
294
  Tooltip.prototype.arrow =function(){
    return this.$arrow = this.$arrow || this.tip().find(".tooltip-arrow")
  }
295

fat's avatar
fat committed
296
297
298
299
300
  Tooltip.prototype.validate = function () {
    if (!this.$element[0].parentNode) {
      this.hide()
      this.$element = null
      this.options  = null
301
    }
fat's avatar
fat committed
302
  }
303

fat's avatar
fat committed
304
305
306
  Tooltip.prototype.enable = function () {
    this.enabled = true
  }
307

fat's avatar
fat committed
308
309
310
  Tooltip.prototype.disable = function () {
    this.enabled = false
  }
311

fat's avatar
fat committed
312
313
314
  Tooltip.prototype.toggleEnabled = function () {
    this.enabled = !this.enabled
  }
315

fat's avatar
fat committed
316
  Tooltip.prototype.toggle = function (e) {
317
    var self = e ? $(e.currentTarget)[this.type](this._options).data('bs.' + this.type) : this
fat's avatar
fat committed
318
319
    self.tip().hasClass('in') ? self.hide() : self.show()
  }
320

fat's avatar
fat committed
321
  Tooltip.prototype.destroy = function () {
322
    this.hide().$element.off('.' + this.type).removeData('bs.' + this.type)
323
324
325
  }


fat's avatar
fat committed
326
327
  // TOOLTIP PLUGIN DEFINITION
  // =========================
328

329
330
  var old = $.fn.tooltip

fat's avatar
fat committed
331
  $.fn.tooltip = function (option) {
332
    return this.each(function () {
fat's avatar
fat committed
333
      var $this   = $(this)
334
      var data    = $this.data('bs.tooltip')
fat's avatar
fat committed
335
336
      var options = typeof option == 'object' && option

337
      if (!data) $this.data('bs.tooltip', (data = new Tooltip(this, options)))
338
339
      if (typeof option == 'string') data[option]()
    })
340
341
  }

342
  $.fn.tooltip.Constructor = Tooltip
Jacob Thornton's avatar
Jacob Thornton committed
343

344

fat's avatar
fat committed
345
346
  // TOOLTIP NO CONFLICT
  // ===================
347
348
349
350
351
352

  $.fn.tooltip.noConflict = function () {
    $.fn.tooltip = old
    return this
  }

Yohn's avatar
Yohn committed
353
}(window.jQuery);