Changeset 35784 for main/trunk/model-interfaces-dev

Timestamp:

2021-12-09T16:15:55+13:00 (2 years ago)

Author:

cstephen

Message:

Add external timeout selection to Snackbar

File:

• main/trunk/model-interfaces-dev/atea/macron-restoration/src/components/Snackbar.vue (modified) (3 diffs)

main/trunk/model-interfaces-dev/atea/macron-restoration/src/components/Snackbar.vue

@@ -50 +50 @@
 
 export class SnackController {
+    /**
+     * The internal snack queue. Do not manipulate externally.
+     * @type {Array<{c: String, t: Number}>}
+     */
     static queue = [];
+
+    /**
+     * The Snackbar Vue component used by this controller.
+     */
     static bar = null;
+
+    /**
+     * A value defining whether or not a snackbar is active. Do not manipulate externally.
+     */
     static isActive = false;
 
+    /**
+     * Sets the Snackbar Vue component that this controller should use.
+     */
     static setBar(snackBar) {
         this.bar = snackBar;
     }
 
-    static addSnack(content) {
-        this.queue.push(content);
+    /**
+     * Adds a snack to the queue.
+     * @param {String} content The message of the snackbar.
+     * @param {Number} timeoutMS The time in milliseconds for which the snack will be displayed.
+     */
+    static addSnack(content, timeoutMS = 3000) {
+        this.queue.push({
+            c: content,
+            t: timeoutMS
+        });
 
         if (!this.isActive) {
@@ -66 +89 @@
     }
 
+    /**
+     * Do not use this method externally.
+     */
     static eatSnacks() {
         if (this.isActive || this.queue.length === 0) {
@@ -72 +98 @@
 
         this.isActive = true;
-        this.bar.setContent(this.queue.shift());
+        const { c, t } = this.queue.shift();
+        this.bar.setContent(c, t);
 
         setTimeout(function() {
             SnackController.isActive = false;
             SnackController.eatSnacks();
-        }, 3500);
+        }, t + 500);
     }
 }