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

10

11
+function () { 'use strict';
12

13
14
15
16
  (function (o_o) {
    typeof define  == 'function' && define.amd ? define(['jquery'], o_o) :
    typeof exports == 'object' ? o_o(require('jquery')) : o_o(jQuery)
  })(function ($) {
17

18
19
    // TOOLTIP PUBLIC CLASS DEFINITION
    // ===============================
20

21
22
23
24
25
26
27
    var Tooltip = function (element, options) {
      this.type       =
      this.options    =
      this.enabled    =
      this.timeout    =
      this.hoverState =
      this.$element   = null
fat's avatar
fat committed
28

29
30
      this.init('tooltip', element, options)
    }
fat's avatar
fat committed
31

32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
    Tooltip.VERSION  = '3.1.1'

    Tooltip.DEFAULTS = {
      animation: true,
      placement: 'top',
      selector: false,
      template: '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>',
      trigger: 'hover focus',
      title: '',
      delay: 0,
      html: false,
      container: false,
      viewport: {
        selector: 'body',
        padding: 0
47
      }
fat's avatar
fat committed
48
49
    }

50
51
52
53
54
55
56
57
    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)

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

59
60
      for (var i = triggers.length; i--;) {
        var trigger = triggers[i]
fat's avatar
fat committed
61

62
63
64
65
66
        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'
67

68
69
70
          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))
        }
fat's avatar
fat committed
71
      }
72
73
74
75
76
77
78
79

      this.options.selector ?
        (this._options = $.extend({}, this.options, { trigger: 'manual', selector: '' })) :
        this.fixTitle()
    }

    Tooltip.prototype.getDefaults = function () {
      return Tooltip.DEFAULTS
80
81
    }

82
83
    Tooltip.prototype.getOptions = function (options) {
      options = $.extend({}, this.getDefaults(), this.$element.data(), options)
84

85
86
87
88
89
90
      if (options.delay && typeof options.delay == 'number') {
        options.delay = {
          show: options.delay,
          hide: options.delay
        }
      }
91

92
93
      return options
    }
94

95
96
97
    Tooltip.prototype.getDelegateOptions = function () {
      var options  = {}
      var defaults = this.getDefaults()
Jacob Thornton's avatar
Jacob Thornton committed
98

99
100
101
      this._options && $.each(this._options, function (key, value) {
        if (defaults[key] != value) options[key] = value
      })
102

103
      return options
104
    }
105

106
107
108
    Tooltip.prototype.enter = function (obj) {
      var self = obj instanceof this.constructor ?
        obj : $(obj.currentTarget).data('bs.' + this.type)
109

110
111
112
113
      if (!self) {
        self = new this.constructor(obj.currentTarget, this.getDelegateOptions())
        $(obj.currentTarget).data('bs.' + this.type, self)
      }
114

115
      clearTimeout(self.timeout)
Jacob Thornton's avatar
Jacob Thornton committed
116

117
      self.hoverState = 'in'
118

119
      if (!self.options.delay || !self.options.delay.show) return self.show()
120

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

126
127
128
    Tooltip.prototype.leave = function (obj) {
      var self = obj instanceof this.constructor ?
        obj : $(obj.currentTarget).data('bs.' + this.type)
fat's avatar
fat committed
129

130
131
132
133
      if (!self) {
        self = new this.constructor(obj.currentTarget, this.getDelegateOptions())
        $(obj.currentTarget).data('bs.' + this.type, self)
      }
134

135
      clearTimeout(self.timeout)
136

137
      self.hoverState = 'out'
138

139
      if (!self.options.delay || !self.options.delay.hide) return self.hide()
140

141
142
143
144
      self.timeout = setTimeout(function () {
        if (self.hoverState == 'out') self.hide()
      }, self.options.delay.hide)
    }
145

146
147
    Tooltip.prototype.show = function () {
      var e = $.Event('show.bs.' + this.type)
148

149
150
      if (this.hasContent() && this.enabled) {
        this.$element.trigger(e)
Yohn's avatar
Yohn committed
151

152
153
154
        var inDom = $.contains(document.documentElement, this.$element[0])
        if (e.isDefaultPrevented() || !inDom) return
        var that = this
155

156
        var $tip = this.tip()
157

158
        var tipId = this.getUID(this.type)
159

160
161
162
        this.setContent()
        $tip.attr('id', tipId)
        this.$element.attr('aria-describedby', tipId)
163

164
        if (this.options.animation) $tip.addClass('fade')
165

166
167
168
        var placement = typeof this.options.placement == 'function' ?
          this.options.placement.call(this, $tip[0], this.$element[0]) :
          this.options.placement
fat's avatar
fat committed
169

170
171
172
        var autoToken = /\s?auto?\s?/i
        var autoPlace = autoToken.test(placement)
        if (autoPlace) placement = placement.replace(autoToken, '') || 'top'
fat's avatar
fat committed
173

174
175
176
177
178
        $tip
          .detach()
          .css({ top: 0, left: 0, display: 'block' })
          .addClass(placement)
          .data('bs.' + this.type, this)
fat's avatar
fat committed
179

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

182
183
184
        var pos          = this.getPosition()
        var actualWidth  = $tip[0].offsetWidth
        var actualHeight = $tip[0].offsetHeight
185

186
187
188
189
        if (autoPlace) {
          var orgPlacement = placement
          var $parent      = this.$element.parent()
          var parentDim    = this.getPosition($parent)
190

191
192
193
194
195
          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
fat's avatar
fat committed
196

197
198
199
200
          $tip
            .removeClass(orgPlacement)
            .addClass(placement)
        }
201

202
        var calculatedOffset = this.getCalculatedOffset(placement, pos, actualWidth, actualHeight)
203

204
205
206
207
        this.applyPlacement(calculatedOffset, placement)

        var complete = function () {
          that.$element.trigger('shown.bs.' + that.type)
Erwan Jegouzo's avatar
Erwan Jegouzo committed
208
          that.hoverState = null
209
210
211
212
213
214
215
        }

        $.support.transition && this.$tip.hasClass('fade') ?
          $tip
            .one('bsTransitionEnd', complete)
            .emulateTransitionEnd(150) :
          complete()
216
      }
217
    }
218

219
220
221
222
    Tooltip.prototype.applyPlacement = function (offset, placement) {
      var $tip   = this.tip()
      var width  = $tip[0].offsetWidth
      var height = $tip[0].offsetHeight
223

224
225
226
      // manually read margins because getBoundingClientRect includes difference
      var marginTop = parseInt($tip.css('margin-top'), 10)
      var marginLeft = parseInt($tip.css('margin-left'), 10)
fat's avatar
fat committed
227

228
229
230
      // we must check for NaN for ie 8/9
      if (isNaN(marginTop))  marginTop  = 0
      if (isNaN(marginLeft)) marginLeft = 0
fat's avatar
fat committed
231

232
233
      offset.top  = offset.top  + marginTop
      offset.left = offset.left + marginLeft
234

235
236
237
238
239
240
241
242
243
244
      // $.fn.offset doesn't round pixel values
      // so we use setOffset directly with our own function B-0
      $.offset.setOffset($tip[0], $.extend({
        using: function (props) {
          $tip.css({
            top: Math.round(props.top),
            left: Math.round(props.left)
          })
        }
      }, offset), 0)
245

246
      $tip.addClass('in')
247

248
249
250
      // check to see if placing tip in new offset caused the tip to resize itself
      var actualWidth  = $tip[0].offsetWidth
      var actualHeight = $tip[0].offsetHeight
251

252
253
254
      if (placement == 'top' && actualHeight != height) {
        offset.top = offset.top + height - actualHeight
      }
255

256
      var delta = this.getViewportAdjustedDelta(placement, offset, actualWidth, actualHeight)
Jacob Thornton's avatar
Jacob Thornton committed
257

258
259
      if (delta.left) offset.left += delta.left
      else offset.top += delta.top
260

261
262
263
      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'
264

265
266
267
      $tip.offset(offset)
      this.replaceArrow(arrowDelta, $tip[0][arrowOffsetPosition], arrowPosition)
    }
268

269
270
    Tooltip.prototype.replaceArrow = function (delta, dimension, position) {
      this.arrow().css(position, delta ? (50 * (1 - delta / dimension) + '%') : '')
271
    }
Jacob Thornton's avatar
Jacob Thornton committed
272

273
274
275
    Tooltip.prototype.setContent = function () {
      var $tip  = this.tip()
      var title = this.getTitle()
276

277
278
279
      $tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
      $tip.removeClass('fade in top bottom left right')
    }
280

281
282
283
284
285
286
287
288
289
290
291
    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)
      }
fat's avatar
fat committed
292

293
294
295
296
297
      this.$element.trigger(e)

      if (e.isDefaultPrevented()) return

      $tip.removeClass('in')
298

299
300
301
302
303
      $.support.transition && this.$tip.hasClass('fade') ?
        $tip
          .one('bsTransitionEnd', complete)
          .emulateTransitionEnd(150) :
        complete()
304

305
      this.hoverState = null
306

307
      return this
308
    }
309
310
311
312
313

    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', '')
314
315
316
      }
    }

317
318
319
    Tooltip.prototype.hasContent = function () {
      return this.getTitle()
    }
fat's avatar
fat committed
320

321
322
323
324
325
326
327
328
329
330
    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()
      }, isBody ? { top: 0, left: 0 } : $element.offset())
    }
331

332
333
334
335
336
    Tooltip.prototype.getCalculatedOffset = function (placement, pos, actualWidth, actualHeight) {
      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   }
337

338
    }
339

340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
    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
        }
      }
364

365
366
367
368
369
370
371
      return delta
    }

    Tooltip.prototype.getTitle = function () {
      var title
      var $e = this.$element
      var o  = this.options
372

373
374
      title = $e.attr('data-original-title')
        || (typeof o.title == 'function' ? o.title.call($e[0]) :  o.title)
375

376
      return title
377
378
    }

379
380
381
382
383
    Tooltip.prototype.getUID = function (prefix) {
      do prefix += ~~(Math.random() * 1000000)
      while (document.getElementById(prefix))
      return prefix
    }
384

385
386
387
    Tooltip.prototype.tip = function () {
      return (this.$tip = this.$tip || $(this.options.template))
    }
388

389
390
391
    Tooltip.prototype.arrow = function () {
      return (this.$arrow = this.$arrow || this.tip().find('.tooltip-arrow'))
    }
392

393
394
395
396
397
    Tooltip.prototype.validate = function () {
      if (!this.$element[0].parentNode) {
        this.hide()
        this.$element = null
        this.options  = null
398
399
400
      }
    }

401
402
403
    Tooltip.prototype.enable = function () {
      this.enabled = true
    }
404

405
406
407
    Tooltip.prototype.disable = function () {
      this.enabled = false
    }
408

409
410
411
    Tooltip.prototype.toggleEnabled = function () {
      this.enabled = !this.enabled
    }
412

413
414
415
416
417
418
419
420
421
    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)
        }
      }
422

423
424
425
426
427
428
429
      self.tip().hasClass('in') ? self.leave(self) : self.enter(self)
    }

    Tooltip.prototype.destroy = function () {
      clearTimeout(this.timeout)
      this.hide().$element.off('.' + this.type).removeData('bs.' + this.type)
    }
fat's avatar
fat committed
430

431

432
433
    // TOOLTIP PLUGIN DEFINITION
    // =========================
434

435
436
437
438
439
440
441
442
443
444
445
    function Plugin(option) {
      return this.each(function () {
        var $this   = $(this)
        var data    = $this.data('bs.tooltip')
        var options = typeof option == 'object' && option

        if (!data && option == 'destroy') return
        if (!data) $this.data('bs.tooltip', (data = new Tooltip(this, options)))
        if (typeof option == 'string') data[option]()
      })
    }
Jacob Thornton's avatar
Jacob Thornton committed
446

447
    var old = $.fn.tooltip
448

449
450
451
452
453
454
455
456
457
458
459
    $.fn.tooltip             = Plugin
    $.fn.tooltip.Constructor = Tooltip


    // TOOLTIP NO CONFLICT
    // ===================

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

461
  })
462

463
}();