toast.js 4.91 KB
Newer Older
1
2
/**
 * --------------------------------------------------------------------------
Mark Otto's avatar
Mark Otto committed
3
 * Bootstrap (v4.3.0): toast.js
4
5
6
7
 * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
 * --------------------------------------------------------------------------
 */

8
9
import $ from 'jquery'
import Util from './util'
10

11
12
13
14
15
/**
 * ------------------------------------------------------------------------
 * Constants
 * ------------------------------------------------------------------------
 */
16

17
const NAME               = 'toast'
Mark Otto's avatar
Mark Otto committed
18
const VERSION            = '4.3.0'
19
20
21
22
23
24
25
26
27
28
29
30
31
const DATA_KEY           = 'bs.toast'
const EVENT_KEY          = `.${DATA_KEY}`
const JQUERY_NO_CONFLICT = $.fn[NAME]

const Event = {
  CLICK_DISMISS : `click.dismiss${EVENT_KEY}`,
  HIDE          : `hide${EVENT_KEY}`,
  HIDDEN        : `hidden${EVENT_KEY}`,
  SHOW          : `show${EVENT_KEY}`,
  SHOWN         : `shown${EVENT_KEY}`
}

const ClassName = {
Johann-S's avatar
Johann-S committed
32
33
34
35
  FADE    : 'fade',
  HIDE    : 'hide',
  SHOW    : 'show',
  SHOWING : 'showing'
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
}

const DefaultType = {
  animation : 'boolean',
  autohide  : 'boolean',
  delay     : 'number'
}

const Default = {
  animation : true,
  autohide  : true,
  delay     : 500
}

const Selector = {
  DATA_DISMISS : '[data-dismiss="toast"]'
}
53

54
55
56
57
58
/**
 * ------------------------------------------------------------------------
 * Class Definition
 * ------------------------------------------------------------------------
 */
59

60
61
62
63
64
65
class Toast {
  constructor(element, config) {
    this._element = element
    this._config  = this._getConfig(config)
    this._timeout = null
    this._setListeners()
66
67
  }

68
  // Getters
69

70
71
72
  static get VERSION() {
    return VERSION
  }
73

74
75
76
  static get DefaultType() {
    return DefaultType
  }
77

78
79
80
81
  static get Default() {
    return Default
  }

82
  // Public
83

84
85
  show() {
    $(this._element).trigger(Event.SHOW)
86

87
88
89
    if (this._config.animation) {
      this._element.classList.add(ClassName.FADE)
    }
90

91
    const complete = () => {
Johann-S's avatar
Johann-S committed
92
93
94
      this._element.classList.remove(ClassName.SHOWING)
      this._element.classList.add(ClassName.SHOW)

95
      $(this._element).trigger(Event.SHOWN)
96

97
98
      if (this._config.autohide) {
        this.hide()
99
      }
100
    }
101

Johann-S's avatar
Johann-S committed
102
103
    this._element.classList.remove(ClassName.HIDE)
    this._element.classList.add(ClassName.SHOWING)
104
105
    if (this._config.animation) {
      const transitionDuration = Util.getTransitionDurationFromElement(this._element)
106

107
108
109
110
111
      $(this._element)
        .one(Util.TRANSITION_END, complete)
        .emulateTransitionEnd(transitionDuration)
    } else {
      complete()
112
    }
113
  }
114

115
116
117
118
  hide(withoutTimeout) {
    if (!this._element.classList.contains(ClassName.SHOW)) {
      return
    }
119

120
    $(this._element).trigger(Event.HIDE)
121

122
123
124
125
    if (withoutTimeout) {
      this._close()
    } else {
      this._timeout = setTimeout(() => {
126
        this._close()
127
      }, this._config.delay)
128
    }
129
  }
130

131
132
133
  dispose() {
    clearTimeout(this._timeout)
    this._timeout = null
134

135
136
    if (this._element.classList.contains(ClassName.SHOW)) {
      this._element.classList.remove(ClassName.SHOW)
137
138
    }

139
    $(this._element).off(Event.CLICK_DISMISS)
140

141
142
143
144
    $.removeData(this._element, DATA_KEY)
    this._element = null
    this._config  = null
  }
145

146
  // Private
147

148
149
150
151
152
  _getConfig(config) {
    config = {
      ...Default,
      ...$(this._element).data(),
      ...typeof config === 'object' && config ? config : {}
153
154
    }

155
156
157
158
159
    Util.typeCheckConfig(
      NAME,
      config,
      this.constructor.DefaultType
    )
160

161
162
    return config
  }
163

164
165
166
167
168
169
170
  _setListeners() {
    $(this._element).on(
      Event.CLICK_DISMISS,
      Selector.DATA_DISMISS,
      () => this.hide(true)
    )
  }
171

172
173
  _close() {
    const complete = () => {
Johann-S's avatar
Johann-S committed
174
      this._element.classList.add(ClassName.HIDE)
175
      $(this._element).trigger(Event.HIDDEN)
176
177
    }

178
179
180
    this._element.classList.remove(ClassName.SHOW)
    if (this._config.animation) {
      const transitionDuration = Util.getTransitionDurationFromElement(this._element)
181

182
183
184
185
186
187
188
      $(this._element)
        .one(Util.TRANSITION_END, complete)
        .emulateTransitionEnd(transitionDuration)
    } else {
      complete()
    }
  }
189

190
191
192
193
194
195
196
197
198
199
200
201
  // Static

  static _jQueryInterface(config) {
    return this.each(function () {
      const $element = $(this)
      let data       = $element.data(DATA_KEY)
      const _config  = typeof config === 'object' && config

      if (!data) {
        data = new Toast(this, _config)
        $element.data(DATA_KEY, data)
      }
202

203
204
205
      if (typeof config === 'string') {
        if (typeof data[config] === 'undefined') {
          throw new TypeError(`No method named "${config}"`)
206
207
        }

208
209
210
        data[config](this)
      }
    })
211
  }
212
213
214
215
216
217
218
}

/**
 * ------------------------------------------------------------------------
 * jQuery
 * ------------------------------------------------------------------------
 */
219

220
221
222
223
224
225
$.fn[NAME]             = Toast._jQueryInterface
$.fn[NAME].Constructor = Toast
$.fn[NAME].noConflict  = () => {
  $.fn[NAME] = JQUERY_NO_CONFLICT
  return Toast._jQueryInterface
}
226
227

export default Toast