Home Reference Source

cables_dev/cables_ui/src/ui/elements/notification.js

  1. import { utils } from "cables";
  2. import { gui } from "../gui.js";
  4. let lastNotify = "";
  5. let lastText = "";
  7. let lastNotifyErr = "";
  8. let lastTextErr = "";
  10. let lastNotifyWarn = "";
  11. let lastTextWarn = "";
  13. /**
  14.  * configuration object for loading a patch
  15.  * @typedef {Object} NotificationDisplayOptions
  16.  * @hideconstructor
  17.  * @property {Number|Boolean} [timeout=2000] fade out notification after x ms, `false` to disable
  18.  * @property {Boolean} [closeable=false] show closing button on notification
  19.  * @property {Boolean} [force=false] force showing of notification even if last one was the same
  20.  */
  22. /**
  23.  * notifyError displays an error as a toast-notification
  24.  *
  25.  *
  26.  * @param title
  27.  * @param text
  28.  * @param {NotificationDisplayOptions} options The option object.
  29.  * @example
  30.  * notifyError("error", "something broke",
  31.  * {
  32.  *     "timeout": false,
  33.  *     "closeable": true,
  34.  * });
  35.  */
  36. export function notifyError(title, text, options = {})
  37. {
  38.     const timeout = options.hasOwnProperty("timeout") ? options.timeout : 2000;
  39.     const closeable = options.closeable || false;
  40.     const force = options.force;
  42.     if (!force)
  43.     {
  44.         if (title === lastNotifyErr && text === lastTextErr)
  45.         {
  46.             setTimeout(function ()
  47.             {
  48.                 lastNotifyErr = "";
  49.                 lastTextErr = "";
  50.             }, 1000);
  51.             return;
  52.         }
  53.     }
  55.     lastNotifyErr = title;
  56.     lastTextErr = text;
  58.     const toastId = utils.uuid();
  60.     iziToast.error(
  61.         {
  62.             "id": toastId,
  63.             "position": "bottomRight", // bottomRight, bottomLeft, topRight, topLeft, topCenter, bottomCenter, center
  64.             "theme": "dark",
  65.             "title": title,
  66.             "message": text || "",
  67.             "progressBar": false,
  68.             "animateInside": false,
  69.             "close": closeable,
  70.             "timeout": timeout
  71.         });
  73.     return toastId;
  74. }
  76. export function notifyWarn(title, text = "", options = {})
  77. {
  78.     const timeout = options.hasOwnProperty("timeout") ? options.timeout : 2000;
  79.     const closeable = options.closeable || false;
  80.     const force = options.hasOwnProperty("force") ? options.force : true;
  82.     if (!force)
  83.     {
  84.         if (title === lastNotifyWarn && text === lastTextWarn)
  85.         {
  86.             setTimeout(function ()
  87.             {
  88.                 lastNotifyWarn = "";
  89.                 lastTextWarn = "";
  90.             }, 1000);
  91.             return;
  92.         }
  93.     }
  95.     lastNotifyWarn = title;
  96.     lastTextWarn = text;
  98.     const toastId = utils.uuid();
  100.     iziToast.warning(
  101.         {
  102.             "id": toastId,
  103.             "position": "bottomRight", // bottomRight, bottomLeft, topRight, topLeft, topCenter, bottomCenter, center
  104.             "theme": "dark",
  105.             "title": title,
  106.             "message": text || "",
  107.             "progressBar": false,
  108.             "animateInside": false,
  109.             "close": closeable,
  110.             "timeout": timeout
  111.         });
  113.     return toastId;
  114. }
  116. /**
  117.  * notify displays a toast-notification
  118.  *
  119.  *
  120.  * @param title
  121.  * @param text
  122.  * @param {NotificationDisplayOptions} options The option object.
  123.  * @example
  124.  * notify("update", "cables has been updated",
  125.  * {
  126.  *     "timeout": 1000,
  127.  *     "closeable": false
  128.  * });
  129.  */
  130. export function notify(title, text = "", options = {})
  131. {
  132.     if (gui.isRemoteClient) return;
  134.     const timeout = options.timeout || 2000;
  135.     const closeable = options.closeable || false;
  136.     const force = options.force || true;
  138.     if (!force)
  139.     {
  140.         if (title == lastNotify && text == lastText)
  141.         {
  142.             setTimeout(function ()
  143.             {
  144.                 lastNotify = "";
  145.                 lastText = "";
  146.             }, 1000);
  147.             return;
  148.         }
  149.     }
  151.     lastNotify = title;
  152.     lastText = text;
  154.     const toastId = utils.uuid();
  156.     iziToast.show(
  157.         {
  158.             "id": toastId,
  159.             "position": "bottomRight", // bottomRight, bottomLeft, topRight, topLeft, topCenter, bottomCenter, center
  160.             "theme": "dark",
  161.             "title": title,
  162.             "message": text || "",
  163.             "progressBar": false,
  164.             "animateInside": false,
  165.             "close": closeable,
  166.             "timeout": timeout,
  167.             "buttons": options.buttons || []
  168.         });
  169.     return toastId;
  170. }
  172. export function hideNotificaton(toastId)
  173. {
  174.     let toast = document.getElementById(toastId);
  175.     if (toast) iziToast.hide({}, toast);
  176. }