Create toast JS plugin, add unit tests.

6 files changed, 521 insertions, 1 deletions

diff --git a/js/src/index.js b/js/src/index.js
index 580562907f..6d99ff3918 100644
--- a/js/src/index.js
+++ b/js/src/index.js
@@ -8,6 +8,7 @@ import Modal from './modal'
 import Popover from './popover'
 import Scrollspy from './scrollspy'
 import Tab from './tab'
+import Toast from './toast'
 import Tooltip from './tooltip'
 import Util from './util'
 
@@ -46,5 +47,6 @@ export {
   Popover,
   Scrollspy,
   Tab,
+  Toast,
   Tooltip
 }
diff --git a/js/src/toast.js b/js/src/toast.js
new file mode 100644
index 0000000000..cb6de974b5
--- /dev/null
+++ b/js/src/toast.js
@@ -0,0 +1,211 @@
+import $ from 'jquery'
+import Util from './util'
+
+/**
+ * --------------------------------------------------------------------------
+ * Bootstrap (v4.1.3): toast.js
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
+ * --------------------------------------------------------------------------
+ */
+
+const Toast = (($) => {
+  /**
+   * ------------------------------------------------------------------------
+   * Constants
+   * ------------------------------------------------------------------------
+   */
+
+  const NAME               = 'toast'
+  const VERSION            = '4.1.3'
+  const DATA_KEY           = 'bs.toast'
+  const EVENT_KEY          = `.${DATA_KEY}`
+  const JQUERY_NO_CONFLICT = $.fn[NAME]
+
+  const Event = {
+    HIDE   : `hide${EVENT_KEY}`,
+    HIDDEN : `hidden${EVENT_KEY}`,
+    SHOW   : `show${EVENT_KEY}`,
+    SHOWN  : `shown${EVENT_KEY}`
+  }
+
+  const ClassName = {
+    FADE : 'fade',
+    HIDE : 'hide',
+    SHOW : 'show'
+  }
+
+  const DefaultType = {
+    animation : 'boolean',
+    autohide  : 'boolean',
+    delay     : '(number|object)'
+  }
+
+  const Default = {
+    animation : true,
+    autohide  : true,
+    delay     : {
+      show: 0,
+      hide: 500
+    }
+  }
+
+  /**
+   * ------------------------------------------------------------------------
+   * Class Definition
+   * ------------------------------------------------------------------------
+   */
+
+  class Toast {
+    constructor(element, config) {
+      this._element = element
+      this._config  = this._getConfig(config)
+      this._timeout = null
+    }
+
+    // Getters
+
+    static get VERSION() {
+      return VERSION
+    }
+
+    static get DefaultType() {
+      return DefaultType
+    }
+
+    // Public
+
+    show() {
+      $(this._element).trigger(Event.SHOW)
+
+      if (this._config.animation) {
+        this._element.classList.add(ClassName.FADE)
+      }
+
+      const complete = () => {
+        $(this._element).trigger(Event.SHOWN)
+
+        if (this._config.autohide) {
+          this.hide()
+        }
+      }
+
+      this._timeout = setTimeout(() => {
+        this._element.classList.add(ClassName.SHOW)
+
+        if (this._config.animation) {
+          const transitionDuration = Util.getTransitionDurationFromElement(this._element)
+
+          $(this._element)
+            .one(Util.TRANSITION_END, complete)
+            .emulateTransitionEnd(transitionDuration)
+        } else {
+          complete()
+        }
+      }, this._config.delay.show)
+    }
+
+    hide() {
+      if (!this._element.classList.contains(ClassName.SHOW)) {
+        return
+      }
+
+      $(this._element).trigger(Event.HIDE)
+
+      const complete = () => {
+        $(this._element).trigger(Event.HIDDEN)
+      }
+
+      this._timeout = setTimeout(() => {
+        this._element.classList.remove(ClassName.SHOW)
+
+        if (this._config.animation) {
+          const transitionDuration = Util.getTransitionDurationFromElement(this._element)
+
+          $(this._element)
+            .one(Util.TRANSITION_END, complete)
+            .emulateTransitionEnd(transitionDuration)
+        } else {
+          complete()
+        }
+      }, this._config.delay.hide)
+    }
+
+    dispose() {
+      clearTimeout(this._timeout)
+      this._timeout = null
+
+      if (this._element.classList.contains(ClassName.SHOW)) {
+        this._element.classList.remove(ClassName.SHOW)
+      }
+
+      $.removeData(this._element, DATA_KEY)
+      this._element = null
+      this._config  = null
+    }
+
+    // Private
+
+    _getConfig(config) {
+      config = {
+        ...Default,
+        ...$(this._element).data(),
+        ...typeof config === 'object' && config ? config : {}
+      }
+
+      if (typeof config.delay === 'number') {
+        config.delay = {
+          show: config.delay,
+          hide: config.delay
+        }
+      }
+
+      Util.typeCheckConfig(
+        NAME,
+        config,
+        this.constructor.DefaultType
+      )
+
+      return config
+    }
+
+    // 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)
+        }
+
+        if (typeof config === 'string') {
+          if (typeof data[config] === 'undefined') {
+            throw new TypeError(`No method named "${config}"`)
+          }
+
+          data[config](this)
+        }
+      })
+    }
+  }
+
+  /**
+   * ------------------------------------------------------------------------
+   * jQuery
+   * ------------------------------------------------------------------------
+   */
+
+  $.fn[NAME]             = Toast._jQueryInterface
+  $.fn[NAME].Constructor = Toast
+  $.fn[NAME].noConflict  = () => {
+    $.fn[NAME] = JQUERY_NO_CONFLICT
+    return Toast._jQueryInterface
+  }
+
+  return Toast
+})($)
+
+export default Toast
diff --git a/js/tests/index.html b/js/tests/index.html
index 1bcdc5380e..06bfa2c434 100644
--- a/js/tests/index.html
+++ b/js/tests/index.html
@@ -120,6 +120,7 @@
     <script src="../dist/tab.js"></script>
     <script src="../dist/tooltip.js"></script>
     <script src="../dist/popover.js"></script>
+    <script src="../dist/toast.js"></script>
 
     <!-- Unit Tests -->
     <script src="unit/alert.js"></script>
@@ -133,6 +134,7 @@
     <script src="unit/tooltip.js"></script>
     <script src="unit/popover.js"></script>
     <script src="unit/util.js"></script>
+    <script src="unit/toast.js"></script>
   </head>
   <body>
     <div id="qunit-container">
diff --git a/js/tests/unit/.eslintrc.json b/js/tests/unit/.eslintrc.json
index a7fa64af0e..7a3b99ead0 100644
--- a/js/tests/unit/.eslintrc.json
+++ b/js/tests/unit/.eslintrc.json
@@ -11,7 +11,8 @@
     "Alert": false,
     "Button": false,
     "Carousel": false,
-    "Simulator": false
+    "Simulator": false,
+    "Toast": false
   },
   "parserOptions": {
     "ecmaVersion": 5,
diff --git a/js/tests/unit/toast.js b/js/tests/unit/toast.js
new file mode 100644
index 0000000000..873661c76f
--- /dev/null
+++ b/js/tests/unit/toast.js
@@ -0,0 +1,235 @@
+$(function () {
+  'use strict'
+
+  if (typeof bootstrap !== 'undefined') {
+    window.Toast = bootstrap.Toast
+  }
+
+  QUnit.module('toast plugin')
+
+  QUnit.test('should be defined on jquery object', function (assert) {
+    assert.expect(1)
+    assert.ok($(document.body).toast, 'toast method is defined')
+  })
+
+  QUnit.module('toast', {
+    beforeEach: function () {
+      // Run all tests in noConflict mode -- it's the only way to ensure that the plugin works in noConflict mode
+      $.fn.bootstrapToast = $.fn.toast.noConflict()
+    },
+    afterEach: function () {
+      $.fn.toast = $.fn.bootstrapToast
+      delete $.fn.bootstrapToast
+      $('#qunit-fixture').html('')
+    }
+  })
+
+  QUnit.test('should provide no conflict', function (assert) {
+    assert.expect(1)
+    assert.strictEqual(typeof $.fn.toast, 'undefined', 'toast was set back to undefined (org value)')
+  })
+
+  QUnit.test('should return the current version', function (assert) {
+    assert.expect(1)
+    assert.strictEqual(typeof Toast.VERSION, 'string')
+  })
+
+  QUnit.test('should throw explicit error on undefined method', function (assert) {
+    assert.expect(1)
+    var $el = $('<div/>')
+    $el.bootstrapToast()
+
+    try {
+      $el.bootstrapToast('noMethod')
+    } catch (err) {
+      assert.strictEqual(err.message, 'No method named "noMethod"')
+    }
+  })
+
+  QUnit.test('should return jquery collection containing the element', function (assert) {
+    assert.expect(2)
+
+    var $el = $('<div/>')
+    var $toast = $el.bootstrapToast()
+    assert.ok($toast instanceof $, 'returns jquery collection')
+    assert.strictEqual($toast[0], $el[0], 'collection contains element')
+  })
+
+  QUnit.test('should auto hide', function (assert) {
+    assert.expect(1)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast" data-delay="1">' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    $toast.on('hidden.bs.toast', function () {
+      assert.strictEqual($toast.hasClass('show'), false)
+      done()
+    })
+      .bootstrapToast('show')
+  })
+
+  QUnit.test('should not add fade class', function (assert) {
+    assert.expect(1)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast" data-delay="1" data-animation="false">' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    $toast.on('shown.bs.toast', function () {
+      assert.strictEqual($toast.hasClass('fade'), false)
+      done()
+    })
+      .bootstrapToast('show')
+  })
+
+  QUnit.test('should allow to hide toast manually', function (assert) {
+    assert.expect(1)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast" data-delay="1" data-autohide="false">' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    $toast
+      .on('shown.bs.toast', function () {
+        $toast.bootstrapToast('hide')
+      })
+      .on('hidden.bs.toast', function () {
+        assert.strictEqual($toast.hasClass('show'), false)
+        done()
+      })
+      .bootstrapToast('show')
+  })
+
+  QUnit.test('should do nothing when we call hide on a non shown toast', function (assert) {
+    assert.expect(1)
+
+    var $toast = $('<div />')
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    var spy = sinon.spy($toast[0].classList, 'contains')
+
+    $toast.bootstrapToast('hide')
+
+    assert.strictEqual(spy.called, true)
+  })
+
+  QUnit.test('should allow to destroy toast', function (assert) {
+    assert.expect(2)
+
+    var $toast = $('<div />')
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    assert.ok(typeof $toast.data('bs.toast') !== 'undefined')
+
+    $toast.bootstrapToast('dispose')
+
+    assert.ok(typeof $toast.data('bs.toast') === 'undefined')
+  })
+
+  QUnit.test('should allow to destroy toast and hide it before that', function (assert) {
+    assert.expect(4)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast" data-delay="0" data-autohide="false">' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    $toast.one('shown.bs.toast', function () {
+      setTimeout(function () {
+        assert.ok($toast.hasClass('show'))
+        assert.ok(typeof $toast.data('bs.toast') !== 'undefined')
+
+        $toast.bootstrapToast('dispose')
+
+        assert.ok(typeof $toast.data('bs.toast') === 'undefined')
+        assert.ok($toast.hasClass('show') === false)
+
+        done()
+      }, 1)
+    })
+      .bootstrapToast('show')
+  })
+
+  QUnit.test('should allow to pass delay object in html', function (assert) {
+    assert.expect(1)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast" data-delay=\'{"show": 0, "hide": 1}\'>' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast()
+      .appendTo($('#qunit-fixture'))
+
+    $toast.on('shown.bs.toast', function () {
+      assert.strictEqual($toast.hasClass('show'), true)
+      done()
+    })
+      .bootstrapToast('show')
+  })
+
+  QUnit.test('should allow to config in js', function (assert) {
+    assert.expect(1)
+    var done = assert.async()
+
+    var toastHtml =
+      '<div class="toast">' +
+        '<div class="toast-body">' +
+          'a simple toast' +
+        '</div>' +
+      '</div>'
+
+    var $toast = $(toastHtml)
+      .bootstrapToast({
+        delay: {
+          show: 0,
+          hide: 1
+        }
+      })
+      .appendTo($('#qunit-fixture'))
+
+    $toast.on('shown.bs.toast', function () {
+      assert.strictEqual($toast.hasClass('show'), true)
+      done()
+    })
+      .bootstrapToast('show')
+  })
+})
diff --git a/js/tests/visual/toast.html b/js/tests/visual/toast.html
new file mode 100644
index 0000000000..0daf8b521c
--- /dev/null
+++ b/js/tests/visual/toast.html
@@ -0,0 +1,69 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <link rel="stylesheet" href="../../../dist/css/bootstrap.min.css">
+    <title>Toast</title>
+    <style>
+      .notifications {
+        position: absolute;
+        top: 10px;
+        right: 10px;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <h1>Toast <small>Bootstrap Visual Test</small></h1>
+
+      <div class="row mt-3">
+        <div class="col-md-12">
+          <button id="btnShowToast" class="btn btn-primary">Show toast</button>
+          <button id="btnHideToast" class="btn btn-primary">Hide toast</button>
+        </div>
+      </div>
+    </div>
+
+    <div class="notifications">
+      <div class="toast" data-delay='{"show": 0, "hide": 2000}'>
+        <div class="toast-header">
+          <img class="rounded mr-2" data-src="holder.js/20x20?size=1&text=.&bg=#007aff" alt="">
+          <strong class="mr-auto">Bootstrap</strong>
+          <small>11 mins ago</small>
+        </div>
+        <div class="toast-body">
+          Hello, world! This is a toast message with <strong>autohide</strong> in 2 seconds
+        </div>
+      </div>
+
+      <div class="toast" data-autohide="false">
+        <div class="toast-header">
+          <img class="rounded mr-2" data-src="holder.js/20x20?size=1&text=.&bg=#007aff" alt="">
+          <strong class="mr-auto">Bootstrap</strong>
+          <small class="text-muted">2 seconds ago</small>
+        </div>
+        <div class="toast-body">
+          Heads up, toasts will stack automatically
+        </div>
+      </div>
+    </div>
+
+    <script src="../../../site/docs/4.1/assets/js/vendor/jquery-slim.min.js"></script>
+    <script src="../../dist/util.js"></script>
+    <script src="../../dist/toast.js"></script>
+    <script>
+      $(function () {
+        $('.toast').toast()
+
+        $('#btnShowToast').on('click', function () {
+          $('.toast').toast('show')
+        })
+
+        $('#btnHideToast').on('click', function () {
+          $('.toast').toast('hide')
+        })
+      })
+    </script>
+  </body>
+</html>