bootstrap-tooltip.js 9.68 KB
Newer Older
1
/* ===========================================================
Mark Otto's avatar
Mark Otto 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

22
23
24
!function ($) {

  "use strict"; // jshint ;_;
25

26

27
28
 /* TOOLTIP PUBLIC CLASS DEFINITION
  * =============================== */
29

30
  var Tooltip = function (element, options) {
31
    this.init('tooltip', element, options)
32
33
  }

34
  Tooltip.prototype = {
35

36
    constructor: Tooltip
37

38
  , init: function (type, element, options) {
39
40
      var eventIn
        , eventOut
41
42
43
        , triggers
        , trigger
        , i
44
45
46
47
48
49

      this.type = type
      this.$element = $(element)
      this.options = this.getOptions(options)
      this.enabled = true

50
51
52
53
54
55
56
57
58
59
60
61
      triggers = this.options.trigger.split(' ')

      for (i = triggers.length; i--;) {
        trigger = triggers[i]
        if (trigger == 'click') {
          this.$element.on('click.' + this.type, this.options.selector, $.proxy(this.toggle, this))
        } else if (trigger != 'manual') {
          eventIn = trigger == 'hover' ? 'mouseenter' : 'focus'
          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))
        }
62
63
64
65
66
67
68
      }

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

69
  , getOptions: function (options) {
70
      options = $.extend({}, $.fn[this.type].defaults, this.$element.data(), options)
71
72
73
74
75
76
77
78
79
80
81

      if (options.delay && typeof options.delay == 'number') {
        options.delay = {
          show: options.delay
        , hide: options.delay
        }
      }

      return options
    }

82
  , enter: function (e) {
83
84
85
86
87
88
89
90
91
      var defaults = $.fn[this.type].defaults
        , options = {}
        , self

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

      self = $(e.currentTarget)[this.type](options).data(this.type)
92

93
94
95
96
97
98
99
      if (!self.options.delay || !self.options.delay.show) return self.show()

      clearTimeout(this.timeout)
      self.hoverState = 'in'
      this.timeout = setTimeout(function() {
        if (self.hoverState == 'in') self.show()
      }, self.options.delay.show)
100
101
    }

102
  , leave: function (e) {
103
104
      var self = $(e.currentTarget)[this.type](this._options).data(this.type)

105
      if (this.timeout) clearTimeout(this.timeout)
106
107
108
109
110
111
      if (!self.options.delay || !self.options.delay.hide) return self.hide()

      self.hoverState = 'out'
      this.timeout = setTimeout(function() {
        if (self.hoverState == 'out') self.hide()
      }, self.options.delay.hide)
112
113
114
115
116
    }

  , show: function () {
      var $tip
        , pos
117
118
119
120
        , actualWidth
        , actualHeight
        , placement
        , tp
121
        , e = $.Event('show')
122

123
      if (this.hasContent() && this.enabled) {
124
        this.$element.trigger(e)
125
        if (e.isDefaultPrevented()) return
126
        $tip = this.tip()
Jacob Thornton's avatar
Jacob Thornton committed
127
        this.setContent()
128

Jacob Thornton's avatar
Jacob Thornton committed
129
        if (this.options.animation) {
130
131
132
          $tip.addClass('fade')
        }

133
        placement = typeof this.options.placement == 'function' ?
134
          this.options.placement.call(this, $tip[0], this.$element[0]) :
135
136
          this.options.placement

137
        $tip
frntz's avatar
frntz committed
138
          .detach()
139
          .css({ top: 0, left: 0, display: 'block' })
Yohn's avatar
Yohn committed
140

Yohn's avatar
Yohn committed
141
        this.options.container ? $tip.appendTo(this.options.container) : $tip.insertAfter(this.$element)
142

143
        pos = this.getPosition()
144
145
146

        actualWidth = $tip[0].offsetWidth
        actualHeight = $tip[0].offsetHeight
147

148
        switch (placement) {
149
          case 'bottom':
150
            tp = {top: pos.top + pos.height, left: pos.left + pos.width / 2 - actualWidth / 2}
151
            break
152
          case 'top':
153
            tp = {top: pos.top - actualHeight, left: pos.left + pos.width / 2 - actualWidth / 2}
154
155
            break
          case 'left':
156
            tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left - actualWidth}
157
158
            break
          case 'right':
159
            tp = {top: pos.top + pos.height / 2 - actualHeight / 2, left: pos.left + pos.width}
160
161
162
            break
        }

Guillaume Gautreau's avatar
Guillaume Gautreau committed
163
        this.applyPlacement(tp, placement)
164
        this.$element.trigger('shown')
165
166
167
      }
    }

168
  , applyPlacement: function(offset, placement){
fat's avatar
fat committed
169
170
171
172
173
174
175
      var $tip = this.tip()
        , width = $tip[0].offsetWidth
        , height = $tip[0].offsetHeight
        , actualWidth
        , actualHeight
        , delta
        , replace
176

fat's avatar
fat committed
177
178
179
180
      $tip
        .offset(offset)
        .addClass(placement)
        .addClass('in')
181

fat's avatar
fat committed
182
183
184
185
186
187
      actualWidth = $tip[0].offsetWidth
      actualHeight = $tip[0].offsetHeight

      if (placement == 'top' && actualHeight != height) {
        offset.top = offset.top + height - actualHeight
        replace = true
188
      }
189

fat's avatar
fat committed
190
191
      if (placement == 'bottom' || placement == 'top') {
        delta = 0
192

fat's avatar
fat committed
193
194
195
196
197
198
199
        if (offset.left < 0){
          delta = offset.left * -2
          offset.left = 0
          $tip.offset(offset)
          actualWidth = $tip[0].offsetWidth
          actualHeight = $tip[0].offsetHeight
        }
200

fat's avatar
fat committed
201
202
203
204
        this.replaceArrow(delta - width + actualWidth, actualWidth, 'left')
      } else {
        this.replaceArrow(actualHeight - height, actualHeight, 'top')
      }
205

fat's avatar
fat committed
206
207
208
209
210
211
212
      if (replace) $tip.offset(offset)
    }

  , replaceArrow: function(delta, dimension, position){
      this
        .arrow()
        .css(position, delta ? (50 * (1 - delta / dimension) + "%") : '')
213
214
    }

Jacob Thornton's avatar
Jacob Thornton committed
215
216
  , setContent: function () {
      var $tip = this.tip()
217
218
        , title = this.getTitle()

219
      $tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
220
      $tip.removeClass('fade in top bottom left right')
Jacob Thornton's avatar
Jacob Thornton committed
221
222
    }

223
  , hide: function () {
224
225
      var that = this
        , $tip = this.tip()
226
        , e = $.Event('hide')
227

228
      this.$element.trigger(e)
229
      if (e.isDefaultPrevented()) return
230

231
      $tip.removeClass('in')
232

233
234
      function removeWithAnimation() {
        var timeout = setTimeout(function () {
frntz's avatar
frntz committed
235
          $tip.off($.support.transition.end).detach()
236
237
238
239
        }, 500)

        $tip.one($.support.transition.end, function () {
          clearTimeout(timeout)
frntz's avatar
frntz committed
240
          $tip.detach()
241
        })
242
243
      }

244
      $.support.transition && this.$tip.hasClass('fade') ?
245
        removeWithAnimation() :
frntz's avatar
frntz committed
246
        $tip.detach()
Jacob Thornton's avatar
Jacob Thornton committed
247

248
249
      this.$element.trigger('hidden')

250
      return this
251
252
    }

253
  , fixTitle: function () {
254
255
      var $e = this.$element
      if ($e.attr('title') || typeof($e.attr('data-original-title')) != 'string') {
Yohn's avatar
Yohn committed
256
        $e.attr('data-original-title', $e.attr('title') || '').attr('title', '')
257
258
259
      }
    }

260
261
262
263
  , hasContent: function () {
      return this.getTitle()
    }

264
265
  , getPosition: function () {
      var el = this.$element[0]
266
      return $.extend({}, (typeof el.getBoundingClientRect == 'function') ? el.getBoundingClientRect() : {
267
268
269
        width: el.offsetWidth
      , height: el.offsetHeight
      }, this.$element.offset())
270
271
    }

272
  , getTitle: function () {
273
274
275
276
      var title
        , $e = this.$element
        , o = this.options

277
278
      title = $e.attr('data-original-title')
        || (typeof o.title == 'function' ? o.title.call($e[0]) :  o.title)
279

280
      return title
281
282
    }

283
  , tip: function () {
284
      return this.$tip = this.$tip || $(this.options.template)
285
286
    }

287
  , arrow: function(){
fat's avatar
fat committed
288
289
      return this.$arrow = this.$arrow || this.tip().find(".tooltip-arrow")
    }
290

291
  , validate: function () {
292
293
294
295
296
297
298
      if (!this.$element[0].parentNode) {
        this.hide()
        this.$element = null
        this.options = null
      }
    }

299
  , enable: function () {
300
301
302
      this.enabled = true
    }

303
  , disable: function () {
304
305
306
      this.enabled = false
    }

307
  , toggleEnabled: function () {
308
309
310
      this.enabled = !this.enabled
    }

311
  , toggle: function (e) {
Yohn's avatar
Yohn committed
312
313
      var self = e ? $(e.currentTarget)[this.type](this._options).data(this.type) : this
      self.tip().hasClass('in') ? self.hide() : self.show()
314
315
    }

316
  , destroy: function () {
Jon Stevens's avatar
Jon Stevens committed
317
      this.hide().$element.off('.' + this.type).removeData(this.type)
318
319
    }

320
321
322
  }


323
324
 /* TOOLTIP PLUGIN DEFINITION
  * ========================= */
325

326
327
  var old = $.fn.tooltip

328
  $.fn.tooltip = function ( option ) {
329
330
    return this.each(function () {
      var $this = $(this)
331
        , data = $this.data('tooltip')
332
        , options = typeof option == 'object' && option
333
      if (!data) $this.data('tooltip', (data = new Tooltip(this, options)))
334
335
      if (typeof option == 'string') data[option]()
    })
336
337
  }

338
  $.fn.tooltip.Constructor = Tooltip
Jacob Thornton's avatar
Jacob Thornton committed
339

340
  $.fn.tooltip.defaults = {
Jacob Thornton's avatar
Jacob Thornton committed
341
    animation: true
342
  , placement: 'top'
343
344
  , selector: false
  , template: '<div class="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'
345
  , trigger: 'hover focus'
346
  , title: ''
347
  , delay: 0
348
  , html: false
Yohn's avatar
Yohn committed
349
  , container: false
350
351
  }

352
353
354
355
356
357
358
359
360

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

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

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