tooltip.js 11.8 KB
Newer Older
1
/* ========================================================================
2
 * Bootstrap: tooltip.js v3.0.3
3
 * http://getbootstrap.com/javascript/#tooltip
4
 * Inspired by the original jQuery.tipsy by Jason Frame
5
 * ========================================================================
Zlatan Vasović's avatar
Zlatan Vasović committed
6
 * Copyright 2013 Twitter, Inc.
7
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
8
 * ======================================================================== */
Jacob Thornton's avatar
Jacob Thornton committed
9

10

XhmikosR's avatar
XhmikosR committed
11
+function ($) { 'use strict';
12

fat's avatar
fat committed
13
14
  // TOOLTIP PUBLIC CLASS DEFINITION
  // ===============================
15

16
  var Tooltip = function (element, options) {
fat's avatar
fat committed
17
18
19
20
21
22
23
    this.type       =
    this.options    =
    this.enabled    =
    this.timeout    =
    this.hoverState =
    this.$element   = null

24
    this.init('tooltip', element, options)
25
26
  }

fat's avatar
fat committed
27
  Tooltip.DEFAULTS = {
Zlatan Vasović's avatar
Zlatan Vasović committed
28
29
30
31
32
33
34
35
36
    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
fat's avatar
fat committed
37
  }
38

fat's avatar
fat committed
39
40
  Tooltip.prototype.init = function (type, element, options) {
    this.enabled  = true
fat's avatar
fat committed
41
    this.type     = type
fat's avatar
fat committed
42
    this.$element = $(element)
fat's avatar
fat committed
43
    this.options  = this.getOptions(options)
44

fat's avatar
fat committed
45
    var triggers = this.options.trigger.split(' ')
46

fat's avatar
fat committed
47
48
49
50
51
52
    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') {
53
54
        var eventIn  = trigger == 'hover' ? 'mouseenter' : 'focusin'
        var eventOut = trigger == 'hover' ? 'mouseleave' : 'focusout'
fat's avatar
fat committed
55

Jacob Thornton's avatar
Jacob Thornton committed
56
        this.$element.on(eventIn  + '.' + this.type, this.options.selector, $.proxy(this.enter, this))
fat's avatar
fat committed
57
        this.$element.on(eventOut + '.' + this.type, this.options.selector, $.proxy(this.leave, this))
58
      }
fat's avatar
fat committed
59
60
61
62
63
64
65
66
67
68
69
70
71
    }

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

fat's avatar
fat committed
73
74
    if (options.delay && typeof options.delay == 'number') {
      options.delay = {
Zlatan Vasović's avatar
Zlatan Vasović committed
75
76
        show: options.delay,
        hide: options.delay
fat's avatar
fat committed
77
      }
78
79
    }

fat's avatar
fat committed
80
81
    return options
  }
82

Jacob Thornton's avatar
Jacob Thornton committed
83
  Tooltip.prototype.getDelegateOptions = function () {
fat's avatar
fat committed
84
    var options  = {}
Jacob Thornton's avatar
Jacob Thornton committed
85
    var defaults = this.getDefaults()
86

fat's avatar
fat committed
87
88
    this._options && $.each(this._options, function (key, value) {
      if (defaults[key] != value) options[key] = value
fat's avatar
fat committed
89
    })
90

Jacob Thornton's avatar
Jacob Thornton committed
91
92
93
94
    return options
  }

  Tooltip.prototype.enter = function (obj) {
fat's avatar
fat committed
95
    var self = obj instanceof this.constructor ?
Jacob Thornton's avatar
Jacob Thornton committed
96
      obj : $(obj.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type)
97

Jacob Thornton's avatar
Jacob Thornton committed
98
    clearTimeout(self.timeout)
99

100
101
    self.hoverState = 'in'

Jacob Thornton's avatar
Jacob Thornton committed
102
103
    if (!self.options.delay || !self.options.delay.show) return self.show()

104
    self.timeout = setTimeout(function () {
fat's avatar
fat committed
105
106
107
      if (self.hoverState == 'in') self.show()
    }, self.options.delay.show)
  }
108

fat's avatar
fat committed
109
110
  Tooltip.prototype.leave = function (obj) {
    var self = obj instanceof this.constructor ?
Jacob Thornton's avatar
Jacob Thornton committed
111
      obj : $(obj.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type)
fat's avatar
fat committed
112

Jacob Thornton's avatar
Jacob Thornton committed
113
    clearTimeout(self.timeout)
fat's avatar
fat committed
114

115
116
    self.hoverState = 'out'

fat's avatar
fat committed
117
    if (!self.options.delay || !self.options.delay.hide) return self.hide()
118

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

fat's avatar
fat committed
124
  Tooltip.prototype.show = function () {
Chris Rebert's avatar
Chris Rebert committed
125
    var e = $.Event('show.bs.' + this.type)
126

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

fat's avatar
fat committed
130
      if (e.isDefaultPrevented()) return
131
      var that = this;
132

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

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

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

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

143
144
145
146
      var autoToken = /\s?auto?\s?/i
      var autoPlace = autoToken.test(placement)
      if (autoPlace) placement = placement.replace(autoToken, '') || 'top'

fat's avatar
fat committed
147
148
149
      $tip
        .detach()
        .css({ top: 0, left: 0, display: 'block' })
150
        .addClass(placement)
fat's avatar
fat committed
151
152
153
154
155
156
157

      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

158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
      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)
      }

178
      var calculatedOffset = this.getCalculatedOffset(placement, pos, actualWidth, actualHeight)
fat's avatar
fat committed
179

fat's avatar
fat committed
180
      this.applyPlacement(calculatedOffset, placement)
181
      this.hoverState = null
182
183
184
185
186
187

      var complete = function() {
        that.$element.trigger('shown.bs.' + that.type)
      }

      $.support.transition && this.$tip.hasClass('fade') ?
188
189
190
191
        $tip
          .one($.support.transition.end, complete)
          .emulateTransitionEnd(150) :
        complete()
192
    }
fat's avatar
fat committed
193
  }
194

195
  Tooltip.prototype.applyPlacement = function (offset, placement) {
fat's avatar
fat committed
196
    var replace
fat's avatar
fat committed
197
198
199
    var $tip   = this.tip()
    var width  = $tip[0].offsetWidth
    var height = $tip[0].offsetHeight
200

201
    // manually read margins because getBoundingClientRect includes difference
fat's avatar
fat committed
202
203
204
205
206
207
208
209
210
    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
211

212
213
214
215
216
217
218
219
220
221
222
223
    // $.fn.offset doesn't round pixel values
    // so we use setOffset directly with our own function B-0
    jQuery.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')
224

fat's avatar
fat committed
225
    // check to see if placing tip in new offset caused the tip to resize itself
fat's avatar
fat committed
226
227
    var actualWidth  = $tip[0].offsetWidth
    var actualHeight = $tip[0].offsetHeight
fat's avatar
fat committed
228

fat's avatar
fat committed
229
    if (placement == 'top' && actualHeight != height) {
fat's avatar
fat committed
230
      replace = true
fat's avatar
fat committed
231
      offset.top = offset.top + height - actualHeight
fat's avatar
fat committed
232
233
    }

fat's avatar
fat committed
234
    if (/bottom|top/.test(placement)) {
fat's avatar
fat committed
235
      var delta = 0
236

fat's avatar
fat committed
237
      if (offset.left < 0) {
fat's avatar
fat committed
238
239
        delta       = offset.left * -2
        offset.left = 0
240

fat's avatar
fat committed
241
        $tip.offset(offset)
242

fat's avatar
fat committed
243
244
        actualWidth  = $tip[0].offsetWidth
        actualHeight = $tip[0].offsetHeight
fat's avatar
fat committed
245
      }
246

fat's avatar
fat committed
247
248
249
      this.replaceArrow(delta - width + actualWidth, actualWidth, 'left')
    } else {
      this.replaceArrow(actualHeight - height, actualHeight, 'top')
fat's avatar
fat committed
250
251
    }

fat's avatar
fat committed
252
253
    if (replace) $tip.offset(offset)
  }
254

255
  Tooltip.prototype.replaceArrow = function (delta, dimension, position) {
XhmikosR's avatar
XhmikosR committed
256
    this.arrow().css(position, delta ? (50 * (1 - delta / dimension) + '%') : '')
fat's avatar
fat committed
257
  }
258

fat's avatar
fat committed
259
260
261
  Tooltip.prototype.setContent = function () {
    var $tip  = this.tip()
    var title = this.getTitle()
Jacob Thornton's avatar
Jacob Thornton committed
262

fat's avatar
fat committed
263
264
265
    $tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
    $tip.removeClass('fade in top bottom left right')
  }
266

fat's avatar
fat committed
267
268
269
  Tooltip.prototype.hide = function () {
    var that = this
    var $tip = this.tip()
270
    var e    = $.Event('hide.bs.' + this.type)
271

272
273
    function complete() {
      if (that.hoverState != 'in') $tip.detach()
274
      that.$element.trigger('hidden.bs.' + that.type)
275
    }
Jacob Thornton's avatar
Jacob Thornton committed
276

fat's avatar
fat committed
277
    this.$element.trigger(e)
278

fat's avatar
fat committed
279
    if (e.isDefaultPrevented()) return
280

fat's avatar
fat committed
281
282
283
    $tip.removeClass('in')

    $.support.transition && this.$tip.hasClass('fade') ?
284
      $tip
Jacob Thornton's avatar
Jacob Thornton committed
285
        .one($.support.transition.end, complete)
286
        .emulateTransitionEnd(150) :
Jacob Thornton's avatar
Jacob Thornton committed
287
      complete()
288

289
    this.hoverState = null
290

fat's avatar
fat committed
291
292
    return this
  }
293

fat's avatar
fat committed
294
295
296
297
  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', '')
298
    }
fat's avatar
fat committed
299
  }
300

fat's avatar
fat committed
301
302
303
  Tooltip.prototype.hasContent = function () {
    return this.getTitle()
  }
304

fat's avatar
fat committed
305
306
307
  Tooltip.prototype.getPosition = function () {
    var el = this.$element[0]
    return $.extend({}, (typeof el.getBoundingClientRect == 'function') ? el.getBoundingClientRect() : {
Zlatan Vasović's avatar
Zlatan Vasović committed
308
309
      width: el.offsetWidth,
      height: el.offsetHeight
fat's avatar
fat committed
310
311
    }, this.$element.offset())
  }
312

313
  Tooltip.prototype.getCalculatedOffset = function (placement, pos, actualWidth, actualHeight) {
fat's avatar
fat committed
314
315
316
317
318
319
    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   }
  }

fat's avatar
fat committed
320
321
322
323
  Tooltip.prototype.getTitle = function () {
    var title
    var $e = this.$element
    var o  = this.options
324

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

fat's avatar
fat committed
328
329
    return title
  }
330

fat's avatar
fat committed
331
332
333
  Tooltip.prototype.tip = function () {
    return this.$tip = this.$tip || $(this.options.template)
  }
334

Chris Rebert's avatar
Chris Rebert committed
335
  Tooltip.prototype.arrow = function () {
fat's avatar
fat committed
336
    return this.$arrow = this.$arrow || this.tip().find('.tooltip-arrow')
fat's avatar
fat committed
337
  }
338

fat's avatar
fat committed
339
340
341
342
343
  Tooltip.prototype.validate = function () {
    if (!this.$element[0].parentNode) {
      this.hide()
      this.$element = null
      this.options  = null
344
    }
fat's avatar
fat committed
345
  }
346

fat's avatar
fat committed
347
348
349
  Tooltip.prototype.enable = function () {
    this.enabled = true
  }
350

fat's avatar
fat committed
351
352
353
  Tooltip.prototype.disable = function () {
    this.enabled = false
  }
354

fat's avatar
fat committed
355
356
357
  Tooltip.prototype.toggleEnabled = function () {
    this.enabled = !this.enabled
  }
358

fat's avatar
fat committed
359
  Tooltip.prototype.toggle = function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
360
    var self = e ? $(e.currentTarget)[this.type](this.getDelegateOptions()).data('bs.' + this.type) : this
fat's avatar
fat committed
361
    self.tip().hasClass('in') ? self.leave(self) : self.enter(self)
fat's avatar
fat committed
362
  }
363

fat's avatar
fat committed
364
  Tooltip.prototype.destroy = function () {
fat's avatar
nope    
fat committed
365
    clearTimeout(this.timeout)
366
    this.hide().$element.off('.' + this.type).removeData('bs.' + this.type)
367
368
369
  }


fat's avatar
fat committed
370
371
  // TOOLTIP PLUGIN DEFINITION
  // =========================
372

373
374
  var old = $.fn.tooltip

fat's avatar
fat committed
375
  $.fn.tooltip = function (option) {
376
    return this.each(function () {
fat's avatar
fat committed
377
      var $this   = $(this)
378
      var data    = $this.data('bs.tooltip')
fat's avatar
fat committed
379
380
      var options = typeof option == 'object' && option

fat's avatar
fat committed
381
      if (!data && option == 'destroy') return
382
      if (!data) $this.data('bs.tooltip', (data = new Tooltip(this, options)))
383
384
      if (typeof option == 'string') data[option]()
    })
385
386
  }

387
  $.fn.tooltip.Constructor = Tooltip
Jacob Thornton's avatar
Jacob Thornton committed
388

389

fat's avatar
fat committed
390
391
  // TOOLTIP NO CONFLICT
  // ===================
392
393
394
395
396
397

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

398
}(jQuery);