bootstrap-tooltip.js 7.81 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
/* ===========================================================
Mark Otto's avatar
Mark Otto committed
2
 * bootstrap-tooltip.js v2.3.0
Jacob Thornton's avatar
Jacob Thornton committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 * http://twitter.github.com/bootstrap/javascript.html#tooltips
 * Inspired by the original jQuery.tipsy by Jason Frame
 * ===========================================================
 * Copyright 2012 Twitter, Inc.
 *
 * 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 ;_;
Jacob Thornton's avatar
Jacob Thornton committed
25
26
27
28
29


 /* TOOLTIP PUBLIC CLASS DEFINITION
  * =============================== */

30
  var Tooltip = function (element, options) {
Jacob Thornton's avatar
Jacob Thornton committed
31
32
33
34
35
36
37
    this.init('tooltip', element, options)
  }

  Tooltip.prototype = {

    constructor: Tooltip

38
  , init: function (type, element, options) {
Jacob Thornton's avatar
Jacob Thornton committed
39
40
      var eventIn
        , eventOut
41
42
43
        , triggers
        , trigger
        , i
Jacob Thornton's avatar
Jacob Thornton committed
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))
        }
Jacob Thornton's avatar
Jacob Thornton committed
62
63
64
65
66
67
68
      }

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

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

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

      return options
    }

82
  , enter: function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
83
84
      var self = $(e.currentTarget)[this.type](this._options).data(this.type)

85
86
87
88
89
90
91
      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)
Jacob Thornton's avatar
Jacob Thornton committed
92
93
    }

94
  , leave: function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
95
96
      var self = $(e.currentTarget)[this.type](this._options).data(this.type)

Jacob Thornton's avatar
Jacob Thornton committed
97
      if (this.timeout) clearTimeout(this.timeout)
98
99
100
101
102
103
      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)
Jacob Thornton's avatar
Jacob Thornton committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
    }

  , show: function () {
      var $tip
        , pos
        , actualWidth
        , actualHeight
        , placement
        , tp

      if (this.hasContent() && this.enabled) {
        $tip = this.tip()
        this.setContent()

        if (this.options.animation) {
          $tip.addClass('fade')
        }

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

        $tip
Jacob Thornton's avatar
rebuild    
Jacob Thornton committed
127
          .detach()
Jacob Thornton's avatar
Jacob Thornton committed
128
          .css({ top: 0, left: 0, display: 'block' })
129
          .insertAfter(this.$element)
Jacob Thornton's avatar
Jacob Thornton committed
130

131
        pos = this.getPosition()
Jacob Thornton's avatar
Jacob Thornton committed
132
133
134
135

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

136
        switch (placement) {
Jacob Thornton's avatar
Jacob Thornton committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
          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
        }

        $tip
152
          .offset(tp)
Jacob Thornton's avatar
Jacob Thornton committed
153
154
155
156
157
158
159
          .addClass(placement)
          .addClass('in')
      }
    }

  , setContent: function () {
      var $tip = this.tip()
160
161
        , title = this.getTitle()

162
      $tip.find('.tooltip-inner')[this.options.html ? 'html' : 'text'](title)
Jacob Thornton's avatar
Jacob Thornton committed
163
164
165
166
167
168
169
170
171
172
173
      $tip.removeClass('fade in top bottom left right')
    }

  , hide: function () {
      var that = this
        , $tip = this.tip()

      $tip.removeClass('in')

      function removeWithAnimation() {
        var timeout = setTimeout(function () {
Jacob Thornton's avatar
rebuild    
Jacob Thornton committed
174
          $tip.off($.support.transition.end).detach()
Jacob Thornton's avatar
Jacob Thornton committed
175
176
177
178
        }, 500)

        $tip.one($.support.transition.end, function () {
          clearTimeout(timeout)
Jacob Thornton's avatar
rebuild    
Jacob Thornton committed
179
          $tip.detach()
Jacob Thornton's avatar
Jacob Thornton committed
180
181
182
183
184
        })
      }

      $.support.transition && this.$tip.hasClass('fade') ?
        removeWithAnimation() :
Jacob Thornton's avatar
rebuild    
Jacob Thornton committed
185
        $tip.detach()
Jacob Thornton's avatar
Jacob Thornton committed
186
187

      return this
Jacob Thornton's avatar
Jacob Thornton committed
188
189
190
191
192
193
194
195
196
197
198
199
200
    }

  , 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') || '').removeAttr('title')
      }
    }

  , hasContent: function () {
      return this.getTitle()
    }

201
202
  , getPosition: function () {
      var el = this.$element[0]
fat's avatar
fat committed
203
      return $.extend({}, el.getBoundingClientRect ? el.getBoundingClientRect() : {
204
205
206
        width: el.offsetWidth
      , height: el.offsetHeight
      }, this.$element.offset())
Jacob Thornton's avatar
Jacob Thornton committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    }

  , getTitle: function () {
      var title
        , $e = this.$element
        , o = this.options

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

      return title
    }

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

  , validate: function () {
      if (!this.$element[0].parentNode) {
        this.hide()
        this.$element = null
        this.options = null
      }
    }

  , enable: function () {
      this.enabled = true
    }

  , disable: function () {
      this.enabled = false
    }

  , toggleEnabled: function () {
      this.enabled = !this.enabled
    }

Jacob Thornton's avatar
Jacob Thornton committed
244
245
246
  , toggle: function (e) {
      var self = $(e.currentTarget)[this.type](this._options).data(this.type)
      self[self.tip().hasClass('in') ? 'hide' : 'show']()
Jacob Thornton's avatar
Jacob Thornton committed
247
248
    }

Mark Otto's avatar
Mark Otto committed
249
  , destroy: function () {
Jacob Thornton's avatar
Jacob Thornton committed
250
      this.hide().$element.off('.' + this.type).removeData(this.type)
Mark Otto's avatar
Mark Otto committed
251
252
    }

Jacob Thornton's avatar
Jacob Thornton committed
253
254
255
256
257
258
  }


 /* TOOLTIP PLUGIN DEFINITION
  * ========================= */

259
260
  var old = $.fn.tooltip

Jacob Thornton's avatar
Jacob Thornton committed
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
  $.fn.tooltip = function ( option ) {
    return this.each(function () {
      var $this = $(this)
        , data = $this.data('tooltip')
        , options = typeof option == 'object' && option
      if (!data) $this.data('tooltip', (data = new Tooltip(this, options)))
      if (typeof option == 'string') data[option]()
    })
  }

  $.fn.tooltip.Constructor = Tooltip

  $.fn.tooltip.defaults = {
    animation: true
  , placement: 'top'
276
277
  , selector: false
  , template: '<div class="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'
278
  , trigger: 'hover focus'
Jacob Thornton's avatar
Jacob Thornton committed
279
  , title: ''
280
  , delay: 0
281
  , html: false
Jacob Thornton's avatar
Jacob Thornton committed
282
283
  }

284
285
286
287
288
289
290
291
292

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

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

293
}(window.jQuery);