wunderbaum 0.4.0 → 0.5.1

package/dist/wunderbaum.umd.js

@@ -7,7 +7,7 @@
   /*!
    * Wunderbaum - util
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   /** @module util */
   /** Readable names for `MouseEvent.button` */
@@ -762,7 +762,7 @@
   /*!
    * Wunderbaum - types
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   /**
    * Possible values for {@link WunderbaumNode.update()} and {@link Wunderbaum.update()}.
@@ -801,7 +801,7 @@
       NodeStatusType["loading"] = "loading";
       NodeStatusType["error"] = "error";
       NodeStatusType["noData"] = "noData";
-      // paging = "paging",
+      NodeStatusType["paging"] = "paging";
   })(NodeStatusType || (NodeStatusType = {}));
   /** Define the subregion of a node, where an event occurred. */
   var NodeRegion;
@@ -826,7 +826,7 @@
   /*!
    * Wunderbaum - wb_extension_base
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   class WunderbaumExtension {
       constructor(tree, id, defaults) {
@@ -1181,7 +1181,7 @@
   /*!
    * Wunderbaum - ext-filter
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   const START_MARKER = "\uFFF7";
   const END_MARKER = "\uFFF8";
@@ -1396,7 +1396,6 @@
           let tree = this.tree;
           // statusNode = tree.root.findDirectChild(KEY_NODATA),
           // escapeTitles = tree.options.escapeTitles;
-          // enhanceTitle = tree.options.enhanceTitle,
           tree.enableUpdate(false);
           // if (statusNode) {
           //   statusNode.remove();
@@ -1406,16 +1405,10 @@
           delete tree.root.match;
           delete tree.root.subMatchCount;
           tree.visit((node) => {
-              if (node.match && node._rowElem) {
-                  // #491, #601
-                  let titleElem = node._rowElem.querySelector("span.wb-title");
-                  // if (escapeTitles) {
-                  titleElem.textContent = node.title;
-                  // } else {
-                  //   titleElem.innerHTML = node.title;
-                  // }
-                  node._callEvent("enhanceTitle", { titleElem: titleElem });
-              }
+              // if (node.match && node._rowElem) {
+              //   let titleElem = node._rowElem.querySelector("span.wb-title")!;
+              //   node._callEvent("enhanceTitle", { titleElem: titleElem });
+              // }
               delete node.match;
               delete node.subMatchCount;
               delete node.titleWithHighlight;
@@ -1481,7 +1474,7 @@
   /*!
    * Wunderbaum - ext-keynav
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   const QUICKSEARCH_DELAY = 500;
   class KeynavExtension extends WunderbaumExtension {
@@ -1821,13 +1814,14 @@
   /*!
    * Wunderbaum - ext-logger
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   class LoggerExtension extends WunderbaumExtension {
       constructor(tree) {
           super(tree, "logger", {});
           this.ignoreEvents = new Set([
-              "enhanceTitle",
+              "iconBadge",
+              // "enhanceTitle",
               "render",
               "discard",
           ]);
@@ -1861,7 +1855,7 @@
   /*!
    * Wunderbaum - common
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   const DEFAULT_DEBUGLEVEL = 3; // Replaced by rollup script
   /**
@@ -1889,30 +1883,50 @@
    * Default node icons.
    * Requires bootstrap icons https://icons.getbootstrap.com
    */
-  const iconMap = {
-      error: "bi bi-exclamation-triangle",
-      // loading: "bi bi-hourglass-split wb-busy",
-      loading: "bi bi-chevron-right wb-busy",
-      // loading: "bi bi-arrow-repeat wb-spin",
-      // loading: '<div class="spinner-border spinner-border-sm" role="status"> <span class="visually-hidden">Loading...</span> </div>',
-      // noData: "bi bi-search",
-      noData: "bi bi-question-circle",
-      expanderExpanded: "bi bi-chevron-down",
-      // expanderExpanded: "bi bi-dash-square",
-      expanderCollapsed: "bi bi-chevron-right",
-      // expanderCollapsed: "bi bi-plus-square",
-      expanderLazy: "bi bi-chevron-right wb-helper-lazy-expander",
-      // expanderLazy: "bi bi-chevron-bar-right",
-      checkChecked: "bi bi-check-square",
-      checkUnchecked: "bi bi-square",
-      checkUnknown: "bi bi-dash-square-dotted",
-      radioChecked: "bi bi-circle-fill",
-      radioUnchecked: "bi bi-circle",
-      radioUnknown: "bi bi-record-circle",
-      folder: "bi bi-folder2",
-      folderOpen: "bi bi-folder2-open",
-      folderLazy: "bi bi-folder-symlink",
-      doc: "bi bi-file-earmark",
+  const iconMaps = {
+      bootstrap: {
+          error: "bi bi-exclamation-triangle",
+          // loading: "bi bi-hourglass-split wb-busy",
+          loading: "bi bi-chevron-right wb-busy",
+          // loading: "bi bi-arrow-repeat wb-spin",
+          // loading: '<div class="spinner-border spinner-border-sm" role="status"> <span class="visually-hidden">Loading...</span> </div>',
+          // noData: "bi bi-search",
+          noData: "bi bi-question-circle",
+          expanderExpanded: "bi bi-chevron-down",
+          // expanderExpanded: "bi bi-dash-square",
+          expanderCollapsed: "bi bi-chevron-right",
+          // expanderCollapsed: "bi bi-plus-square",
+          expanderLazy: "bi bi-chevron-right wb-helper-lazy-expander",
+          // expanderLazy: "bi bi-chevron-bar-right",
+          checkChecked: "bi bi-check-square",
+          checkUnchecked: "bi bi-square",
+          checkUnknown: "bi bi-dash-square-dotted",
+          radioChecked: "bi bi-circle-fill",
+          radioUnchecked: "bi bi-circle",
+          radioUnknown: "bi bi-record-circle",
+          folder: "bi bi-folder2",
+          folderOpen: "bi bi-folder2-open",
+          folderLazy: "bi bi-folder-symlink",
+          doc: "bi bi-file-earmark",
+      },
+      fontawesome6: {
+          error: "fa-solid fa-triangle-exclamation",
+          loading: "fa-solid fa-chevron-right fa-beat",
+          noData: "fa-solid fa-circle-question",
+          expanderExpanded: "fa-solid fa-chevron-down",
+          expanderCollapsed: "fa-solid fa-chevron-right",
+          expanderLazy: "fa-solid fa-chevron-right wb-helper-lazy-expander",
+          checkChecked: "fa-regular fa-square-check",
+          checkUnchecked: "fa-regular fa-square",
+          checkUnknown: "fa-regular fa-square-minus",
+          radioChecked: "fa-solid fa-circle",
+          radioUnchecked: "fa-regular fa-circle",
+          radioUnknown: "fa-regular fa-circle-question",
+          folder: "fa-solid fa-folder-closed",
+          folderOpen: "fa-regular fa-folder-open",
+          folderLazy: "fa-solid fa-folder-plus",
+          doc: "fa-regular fa-file",
+      },
   };
   /** Dict keys that are evaluated by source loader (others are added to `tree.data` instead). */
   const RESERVED_TREE_SOURCE_KEYS = new Set([
@@ -2107,7 +2121,7 @@
   /*!
    * Wunderbaum - ext-dnd
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   const nodeMimeType = "application/x-wunderbaum-node";
   class DndExtension extends WunderbaumExtension {
@@ -2304,7 +2318,7 @@
                   n._org_key = n.key;
                   delete n.key;
               });
-              nodeData.treeId = srcNode.tree.id;
+              nodeData._treeId = srcNode.tree.id;
               const json = JSON.stringify(nodeData);
               e.dataTransfer.setData(nodeMimeType, json);
               // e.dataTransfer!.setData("text/html", $(node.span).html());
@@ -2437,7 +2451,7 @@
   /*!
    * Wunderbaum - drag_observer
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   /**
    * Convert mouse- and touch events to 'dragstart', 'drag', and 'dragstop'.
@@ -2573,7 +2587,7 @@
   /*!
    * Wunderbaum - ext-grid
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   class GridExtension extends WunderbaumExtension {
       constructor(tree) {
@@ -2610,7 +2624,7 @@
   /*!
    * Wunderbaum - deferred
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   /**
    * Implement a ES6 Promise, that exposes a resolve() and reject() method.
@@ -2663,7 +2677,7 @@
   /*!
    * Wunderbaum - wunderbaum_node
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   /** WunderbaumNode properties that can be passed with source data.
    * (Any other source properties will be stored as `node.data.PROP`.)
@@ -2685,16 +2699,12 @@
       "tooltip",
       "type",
       "unselectable",
-      // "unselectableIgnore",
-      // "unselectableStatus",
   ]);
   /** WunderbaumNode properties that will be returned by `node.toDict()`.)
    */
   const NODE_DICT_PROPS = new Set(NODE_PROPS);
   NODE_DICT_PROPS.delete("_partsel");
   NODE_DICT_PROPS.delete("unselectable");
-  // NODE_DICT_PROPS.delete("unselectableIgnore");
-  // NODE_DICT_PROPS.delete("unselectableStatus");
   /**
    * A single tree node.
    *
@@ -2711,13 +2721,6 @@
            */
           this.refKey = undefined;
           this.children = null;
-          this.lazy = false;
-          /** Expansion state.
-           * @see {@link isExpandable}, {@link isExpanded}, {@link setExpanded}. */
-          this.expanded = false;
-          /** Selection state.
-           * @see {@link isSelected}, {@link setSelected}, {@link toggleSelected}. */
-          this.selected = false;
           /** Additional classes added to `div.wb-row`.
            * @see {@link hasClass}, {@link setClass}. */
           this.classes = null; //new Set<string>();
@@ -2743,7 +2746,7 @@
           data.icon != null ? (this.icon = data.icon) : 0;
           this.lazy = data.lazy === true;
           data.statusNodeType != null
-              ? (this.statusNodeType = "" + data.statusNodeType)
+              ? (this.statusNodeType = ("" + data.statusNodeType))
               : 0;
           data.colspan != null ? (this.colspan = !!data.colspan) : 0;
           // Selection
@@ -2751,10 +2754,6 @@
           data.radiogroup != null ? (this.radiogroup = !!data.radiogroup) : 0;
           this.selected = data.selected === true;
           data.unselectable === true ? (this.unselectable = true) : 0;
-          // data.unselectableStatus != null
-          //   ? (this.unselectableStatus = !!data.unselectableStatus)
-          //   : 0;
-          // data.unselectableIgnore === true ? (this.unselectableIgnore = true) : 0;
           if (data.classes) {
               this.setClass(data.classes);
           }
@@ -2886,7 +2885,7 @@
               //   if (this.parent && this.parent.children) {
               //     this.fixSelection3FromEndNodes();
               //   } else {
-              //     // my happen when loading __root__;
+              //     // may happen when loading __root__;
               //   }
               // }
               tree.enableUpdate(true);
@@ -3331,7 +3330,7 @@
               return false;
           }
           if (this.children == null) {
-              return this.lazy; // null or undefined can trigger lazy load
+              return !!this.lazy; // null or undefined can trigger lazy load
           }
           if (this.children.length === 0) {
               return !!this.tree.options.emptyChildListExpandable;
@@ -3387,6 +3386,10 @@
           return !this.selected && !!this._partsel;
       }
       /** Return true if this node has DOM representaion, i.e. is displayed in the viewport. */
+      isRadio() {
+          return this.checkbox === "radio" || !!this.parent.radiogroup;
+      }
+      /** Return true if this node has DOM representaion, i.e. is displayed in the viewport. */
       isRendered() {
           return !!this._rowElem;
       }
@@ -3500,6 +3503,7 @@
           else if (isPlainObject(source)) {
               // source is a plain object with `.url` property.
               ({ url, params, body, options, ...rest } = source);
+              assert(!rest || Object.keys(rest).length === 0, `Unexpected source properties: ${Object.keys(rest)}. Use 'options' instead.`);
               assert(typeof url === "string", `expected source.url as string`);
               if (isPlainObject(options)) {
                   fetchOpts = options;
@@ -3898,7 +3902,7 @@
               renderColInfosById: renderColInfosById,
           };
       }
-      _createIcon(parentElem, replaceChild, showLoading) {
+      _createIcon(iconMap, parentElem, replaceChild, showLoading) {
           let iconSpan;
           let icon = this.getOption("icon");
           if (this._errorInfo) {
@@ -3952,6 +3956,30 @@
           else {
               parentElem.appendChild(iconSpan);
           }
+          // Event handler `tree.iconBadge` can return a badge text or HTMLSpanElement
+          let cbRes = this._callEvent("iconBadge", { iconSpan: iconSpan });
+          let badge = null;
+          if (cbRes != null && cbRes !== false) {
+              let classes = "";
+              let tooltip = "";
+              if (isPlainObject(cbRes)) {
+                  badge = "" + cbRes.badge;
+                  classes = cbRes.badgeClass ? " " + cbRes.badgeClass : "";
+                  tooltip = cbRes.badgeTooltip ? ` title="${cbRes.badgeTooltip}"` : "";
+              }
+              else if (typeof cbRes === "number") {
+                  badge = "" + cbRes;
+              }
+              else {
+                  badge = cbRes; // string or HTMLSpanElement
+              }
+              if (typeof badge === "string") {
+                  badge = elemFromHtml(`<span class="wb-badge${classes}"${tooltip}>${escapeHtml(badge)}</span>`);
+              }
+              if (badge) {
+                  iconSpan.append(badge);
+              }
+          }
           // this.log("_createIcon: ", iconSpan);
           return iconSpan;
       }
@@ -4011,14 +4039,14 @@
           }
           // Render the icon (show a 'loading' icon if we do not have an expander that
           // we would prefer).
-          iconSpan = this._createIcon(nodeElem, null, !expanderSpan);
+          iconSpan = this._createIcon(tree.iconMap, nodeElem, null, !expanderSpan);
           if (iconSpan) {
               ofsTitlePx += ICON_WIDTH;
           }
           titleSpan = document.createElement("span");
           titleSpan.classList.add("wb-title");
           nodeElem.appendChild(titleSpan);
-          this._callEvent("enhanceTitle", { titleSpan: titleSpan });
+          // this._callEvent("enhanceTitle", { titleSpan: titleSpan });
           // Store the width of leading icons with the node, so we can calculate
           // the width of the embedded title span later
           nodeElem._ofsTitlePx = ofsTitlePx;
@@ -4145,6 +4173,7 @@
       _render_status(opts) {
           // this.log("_render_status", opts);
           const tree = this.tree;
+          const iconMap = tree.iconMap;
           const treeOptions = tree.options;
           const typeInfo = this.type ? tree.types[this.type] : null;
           const rowDiv = this._rowElem;
@@ -4230,7 +4259,7 @@
               // Update icon (if not opts.isNew, which would rebuild markup anyway)
               const iconSpan = nodeElem.querySelector("i.wb-icon");
               if (iconSpan) {
-                  this._createIcon(nodeElem, iconSpan, !expanderSpan);
+                  this._createIcon(tree.iconMap, nodeElem, iconSpan, !expanderSpan);
               }
           }
           // Adjust column width
@@ -4555,7 +4584,7 @@
       /** Toggle the check/uncheck state. */
       toggleSelected(options) {
           let flag = this.isSelected();
-          if (flag === undefined) {
+          if (flag === undefined && !this.isRadio()) {
               flag = this._anySelectable();
           }
           else {
@@ -4959,7 +4988,7 @@
   /*!
    * Wunderbaum - ext-edit
    * Copyright (c) 2021-2023, Martin Wendt. Released under the MIT license.
-   * v0.4.0, Wed, 06 Sep 2023 08:21:56 GMT (https://github.com/mar10/wunderbaum)
+   * v0.5.1, Sat, 16 Sep 2023 19:08:55 GMT (https://github.com/mar10/wunderbaum)
    */
   // const START_MARKER = "\uFFF7";
   class EditExtension extends WunderbaumExtension {
@@ -5255,8 +5284,8 @@
    * https://github.com/mar10/wunderbaum
    *
    * Released under the MIT license.
-   * @version v0.4.0
-   * @date Wed, 06 Sep 2023 08:21:56 GMT
+   * @version v0.5.1
+   * @date Sat, 16 Sep 2023 19:08:55 GMT
    */
   // import "./wunderbaum.scss";
   class WbSystemRoot extends WunderbaumNode {
@@ -5328,6 +5357,7 @@
               header: null,
               // headerHeightPx: ROW_HEIGHT,
               rowHeightPx: ROW_HEIGHT,
+              iconMap: "bootstrap",
               columns: null,
               types: null,
               // escapeTitles: true,
@@ -5345,10 +5375,11 @@
               navigationModeOption: null,
               quicksearch: true,
               // --- Events ---
-              change: noop,
-              enhanceTitle: noop,
-              error: noop,
-              receive: noop,
+              iconBadge: null,
+              change: null,
+              // enhanceTitle: null,
+              error: null,
+              receive: null,
               // --- Strings ---
               strings: {
                   loadError: "Error",
@@ -5642,6 +5673,16 @@
           }
           return null;
       }
+      /**
+       * Return the icon-function -> icon-definition mapping.
+       */
+      get iconMap() {
+          const map = this.options.iconMap;
+          if (typeof map === "string") {
+              return iconMaps[map];
+          }
+          return map;
+      }
       /**
        * Return a WunderbaumNode instance from element or event.
        */
@@ -7378,7 +7419,7 @@
   }
   Wunderbaum.sequence = 0;
   /** Wunderbaum release version number "MAJOR.MINOR.PATCH". */
-  Wunderbaum.version = "v0.4.0"; // Set to semver by 'grunt release'
+  Wunderbaum.version = "v0.5.1"; // Set to semver by 'grunt release'
   /** Expose some useful methods of the util.ts module as `Wunderbaum.util`. */
   Wunderbaum.util = util;