wunderbaum 0.11.0 → 0.12.0

package/README.md

@@ -7,12 +7,11 @@
 [![Released with: grunt-yabs](https://img.shields.io/badge/released%20with-grunt--yabs-yellowgreen)](https://github.com/mar10/grunt-yabs)
 [![StackOverflow: wunderbaum](https://img.shields.io/badge/StackOverflow-wunderbaum-blue.svg)](https://stackoverflow.com/questions/tagged/wunderbaum)
 
-<!-- [![Build Status](https://travis-ci.com/mar10/wunderbaum.svg?branch=main)](https://travis-ci.com/github/mar10/wunderbaum) -->
+> A modern tree/treegrid control for the web.
 
-> A modern tree/treegrid control for the web. <br>
-> Potential successor of [Fancytree](https://github.com/mar10/fancytree).
-
-**Status _beta_:<br>API, Markup, Stylesheet, etc. are still subject to change.**
+Designated successor of [Fancytree](https://github.com/mar10/fancytree).<br>
+See the [upgrade guide](https://mar10.github.io/wunderbaum/tutorial/migrate/#what-has-changed)
+for details.
 
 [![Demo](https://mar10.github.io/wunderbaum/assets/teaser_2.png)](https://mar10.github.io/wunderbaum/demo/)
 

package/dist/wunderbaum.css

@@ -16,22 +16,22 @@
   --wb-alternate-row-color: #f7f7f7;
   --wb-alternate-row-color-hover: #f3f3f3;
   --wb-focus-border-color: #275dc5;
-  --wb-drop-source-color: #d3d2ce;
-  --wb-drop-target-color: #d4ecf8;
-  --wb-dim-color: #8c877c;
-  --wb-error-background-color: #f5ddde;
-  --wb-hover-color: #f7fcfe;
-  --wb-hover-border-color: #f7fcfe;
+  --wb-drop-source-color: rgb(211.3703703704, 209.6481481481, 205.6296296296);
+  --wb-drop-target-color: rgb(212.2834645669, 236.2992125984, 247.7165354331);
+  --wb-dim-color: rgb(139.5925925926, 135.037037037, 124.4074074074);
+  --wb-error-background-color: rgb(244.6292372881, 220.8707627119, 221.625);
+  --wb-hover-color: rgb(247.1401574803, 251.5590551181, 253.6598425197);
+  --wb-hover-border-color: rgb(247.1401574803, 251.5590551181, 253.6598425197);
   --wb-grid-color: #dedede;
   --wb-active-color: #e5f3fb;
-  --wb-active-cell-color: #7dc6e9;
+  --wb-active-cell-color: rgb(125.1417322835, 198.1496062992, 232.8582677165);
   --wb-active-border-color: #70c0e7;
   --wb-active-hover-color: #dceff8;
   --wb-active-hover-border-color: #26a0da;
-  --wb-active-column-color: #f7fcfe;
-  --wb-active-header-column-color: #c5c5c5;
+  --wb-active-column-color: rgb(247.1401574803, 251.5590551181, 253.6598425197);
+  --wb-active-header-column-color: rgb(196.5, 196.5, 196.5);
   --wb-active-color-grayscale: #f0f0f0;
-  --wb-active-border-color-grayscale: #acacac;
+  --wb-active-border-color-grayscale: rgb(171.5, 171.5, 171.5);
   --wb-active-hover-color-grayscale: #eaeaea;
   --wb-active-cell-color-grayscale: #b3b3b3;
   --wb-grid-color-grayscale: #dedede;

package/dist/wunderbaum.css.map

@@ -1 +1 @@
-{"version":3,"sourceRoot":"","sources":["../src/wunderbaum.scss"],"names":[],"mappings":";AAAA;AAAA;AAAA;AAAA;AAAA;AA2EA;AAAA;EAME;EAGA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAGA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EAEA;;;AAMF;EACE;;;AAGF;EACE;EACA;EACA;EACA;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EACA;EAGA;AAsBA;AAyBA;AAwRA;AAoHA;AA8BA;AAgEA;AAEA;AAUA;AAoBA;AAYA;;AAjkBA;EAEE;;AAIF;EACE;EACA;;AAGF;EACE;EAEA;;AAMF;EACE;EACA;EACA;EACA;EACA;;AAGF;AAAA;EAEE;;AAKF;EACE;EACA;EACA;EACA;EACA;;AAMA;EACE;EACA;EACA;EACA;;AAIA;EACE;;AAKF;EAEE;;AAGF;EAEE;;AAGF;EACE;;AAOA;EAEE;EACA;;AAEA;EACE;;AAaN;EAEE;EACA;;AAEA;EACE;;AAON;EACE;;AAEA;EACE;;AAOF;EACE;;AAGF;EAEE;;AAGA;EACE;;AAKJ;EACE;EACA;;AAGF;EAEE;EACA;;AAEA;EAEE;;AAIJ;EACE;;AAGF;AAAA;AAAA;EAGE;EAcA;EASA;;AAGF;EAEE;;AAON;EACE;EACA;EACA;EACA;EACA;;AAEA;EACE;EAIA;;AAIF;EACE;EACA;EACA;EACA;;AAGF;EACE;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EACA;;AACA;EACE;;AAKJ;EACE;EACA;;AAEA;EACE;EACA;;AAKN;EACE;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;;AAEA;EACE;;AAIJ;EACE;EACA;AAqBA;;AAhBA;AAAA;AAAA;AAAA;EAIE;EACA;EACA;EACA;;AAGF;AAAA;EAEE;EACA;;AAIF;EACE;;AAGF;EACE;EACA;EACA;;AAMA;EACE;;AAIJ;AAAA;EAEE;EACA;EACA;EACA;;AAGF;EACE;EAEA;EACA;EACA;EACA;EACA;;AAUI;EACE;;AAON;EACE;;AAIJ;EACE;;AAEA;EACE;;AAIF;EACE;;AAGF;EACE;;AAEA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;EAgBE;EACA;EACA;;AAGF;AAAA;EAEE;;AAcA;EACE;;AAWJ;EACE;;AAGF;EACE;;AAEA;EACE;;AAON;EACE;;AAEA;EACE;;AAQJ;EACE;;AASJ;EACE;;AAEA;EACE;;AAGF;EACE;;AAMJ;EACE;;AAaJ;EACE;;AAEA;EACE;;AAIJ;EACE;;AAEA;EACE;EACA;;AAGA;EACE;EACA;;AAEA;EAGE;EACA;EAGA;EACA;EACA;;AAgBR;AAAA;EAIE;EACA;EACA;;AAKF;EACE;;AAUE;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAOJ;EAIE;EACA;;AAGF;AAAA;EAKE;EACA;;AAMF;AAAA;EAEE;EACA;EACA;EACA;;AAOF;EACE;;AAGF;AAAA;EAEE;;AAKA;EACE;;;AAMR;AAEA;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;EACA;;AAEA;EACE;EACA;;;AAQJ;AACA;AAAA;EAEE;;;AAGF;AAAA;EAEE;;;AAIA;AAAA;EAEE;;AAGF;AAAA;EAEE;;;AAIJ;EACE;;AAEA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;;;AAIJ;AAAA;AAAA;AAMA;EACE;EACA;;;AAGF;EAGE;;;AAGF;EACE;;;AAKF;EACE;IACE;;EAGF;IACE;;;AAIJ;EACE;IACE;;EAGF;IACE;;;AAIJ;EACE;IACE;;EAGF;IACE","file":"wunderbaum.css"}
+{"version":3,"sourceRoot":"","sources":["../src/wunderbaum.scss"],"names":[],"mappings":";AAAA;AAAA;AAAA;AAAA;AAAA;AA6EA;AAAA;EAME;EAGA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAGA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;EAEA;;;AAMF;EACE;;;AAGF;EACE;EACA;EACA;EACA;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EACA;EAGA;AAsBA;AAyBA;AAwRA;AAoHA;AA8BA;AAgEA;AAEA;AAUA;AAoBA;AAYA;;AAjkBA;EAEE;;AAIF;EACE;EACA;;AAGF;EACE;EAEA;;AAMF;EACE;EACA;EACA;EACA;EACA;;AAGF;AAAA;EAEE;;AAKF;EACE;EACA;EACA;EACA;EACA;;AAMA;EACE;EACA;EACA;EACA;;AAIA;EACE;;AAKF;EAEE;;AAGF;EAEE;;AAGF;EACE;;AAOA;EAEE;EACA;;AAEA;EACE;;AAaN;EAEE;EACA;;AAEA;EACE;;AAON;EACE;;AAEA;EACE;;AAOF;EACE;;AAGF;EAEE;;AAGA;EACE;;AAKJ;EACE;EACA;;AAGF;EAEE;EACA;;AAEA;EAEE;;AAIJ;EACE;;AAGF;AAAA;AAAA;EAGE;EAcA;EASA;;AAGF;EAEE;;AAON;EACE;EACA;EACA;EACA;EACA;;AAEA;EACE;EAIA;;AAIF;EACE;EACA;EACA;EACA;;AAGF;EACE;EACA;EAEA;EACA;EAEA;EACA;EACA;EACA;EACA;;AACA;EACE;;AAKJ;EACE;EACA;;AAEA;EACE;EACA;;AAKN;EACE;EACA;EAEA;EACA;EACA;EACA;EACA;EACA;;AAEA;EACE;;AAIJ;EACE;EACA;AAqBA;;AAhBA;AAAA;AAAA;AAAA;EAIE;EACA;EACA;EACA;;AAGF;AAAA;EAEE;EACA;;AAIF;EACE;;AAGF;EACE;EACA;EACA;;AAMA;EACE;;AAIJ;AAAA;EAEE;EACA;EACA;EACA;;AAGF;EACE;EAEA;EACA;EACA;EACA;EACA;;AAUI;EACE;;AAON;EACE;;AAIJ;EACE;;AAEA;EACE;;AAIF;EACE;;AAGF;EACE;;AAEA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;EAgBE;EACA;EACA;;AAGF;AAAA;EAEE;;AAcA;EACE;;AAWJ;EACE;;AAGF;EACE;;AAEA;EACE;;AAON;EACE;;AAEA;EACE;;AAQJ;EACE;;AASJ;EACE;;AAEA;EACE;;AAGF;EACE;;AAMJ;EACE;;AAaJ;EACE;;AAEA;EACE;;AAIJ;EACE;;AAEA;EACE;EACA;;AAGA;EACE;EACA;;AAEA;EAGE;EACA;EAGA;EACA;EACA;;AAgBR;AAAA;EAIE;EACA;EACA;;AAKF;EACE;;AAUE;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAFF;AAAA;EAEE;;AAOJ;EAIE;EACA;;AAGF;AAAA;EAKE;EACA;;AAMF;AAAA;EAEE;EACA;EACA;EACA;;AAOF;EACE;;AAGF;AAAA;EAEE;;AAKA;EACE;;;AAMR;AAEA;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;EACA;;AAEA;EACE;EACA;;;AAQJ;AACA;AAAA;EAEE;;;AAGF;AAAA;EAEE;;;AAIA;AAAA;EAEE;;AAGF;AAAA;EAEE;;;AAIJ;EACE;;AAEA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EAEA;EACA;;;AAIJ;AAAA;AAAA;AAMA;EACE;EACA;;;AAGF;EAGE;;;AAGF;EACE;;;AAKF;EACE;IACE;;EAGF;IACE;;;AAIJ;EACE;IACE;;EAGF;IACE;;;AAIJ;EACE;IACE;;EAGF;IACE","file":"wunderbaum.css"}

package/dist/wunderbaum.d.ts

@@ -293,7 +293,7 @@ declare module "util" {
      */
     export function extend(...args: any[]): any;
     /** Return true if `obj` is of type `array`. */
-    export function isArray(obj: any): boolean;
+    export function isArray(obj: any): obj is any[];
     /** Return true if `obj` is of type `Object` and has no properties. */
     export function isEmptyObject(obj: any): boolean;
     /** Return true if `obj` is of type `function`. */
@@ -396,6 +396,13 @@ declare module "util" {
      * ```
      */
     export function toBool(...boolDefaults: (boolean | undefined | null)[]): boolean;
+    /**
+     * Return `val` unless `val` is a number in which case we convert to boolean.
+     * This is useful when a boolean value is stored as a 0/1 (e.g. in JSON) and
+     * we still want to maintain string values. null and undefined are returned as
+     * is. E.g. `checkbox` may be boolean or 'radio'.
+     */
+    export function intToBool(val: boolean | number | string | undefined): boolean | string | undefined;
     /** Return a canonical string representation for an object's type (e.g. 'array', 'number', ...). */
     export function type(obj: any): string;
     /**
@@ -424,7 +431,7 @@ declare module "common" {
     /**
      * Fixed height of a row in pixel. Must match the SCSS variable `$row-outer-height`.
      */
-    export const ROW_HEIGHT = 22;
+    export const DEFAULT_ROW_HEIGHT = 22;
     /**
      * Fixed width of node icons in pixel. Must match the SCSS variable `$icon-outer-width`.
      */
@@ -588,7 +595,9 @@ declare module "wb_node" {
          */
         type?: string;
         /** Tooltip definition (`true`: use node's title). */
-        tooltip?: string | boolean;
+        tooltip?: TooltipOption;
+        /** Icon tooltip definition (`true`: use node's title). */
+        iconTooltip?: TooltipOption;
         /** Additional classes added to `div.wb-row`.
          * @see {@link hasClass}, {@link setClass}. */
         classes: Set<string> | null;
@@ -672,7 +681,14 @@ declare module "wb_node" {
         setClass(className: string | string[] | Set<string>, flag?: boolean): void;
         /** Start editing this node's title. */
         startEditTitle(): void;
-        /** Call `setExpanded()` on all descendant nodes. */
+        /**
+         * Call `setExpanded()` on all descendant nodes.
+         *
+         * @param flag true to expand, false to collapse.
+         * @param options Additional options.
+         * @see {@link Wunderbaum.expandAll}
+         * @see {@link WunderbaumNode.setExpanded}
+         */
         expandAll(flag?: boolean, options?: ExpandAllOptions): Promise<void>;
         /**
          * Find all descendant nodes that match condition (excluding self).
@@ -1552,7 +1568,7 @@ declare module "types" {
         colspan?: boolean;
         expanded?: boolean;
         icon?: IconOption;
-        iconTooltip?: boolean | string;
+        iconTooltip?: TooltipOption;
         key?: string;
         lazy?: boolean;
         /** Make child nodes single-select radio buttons. */
@@ -1561,7 +1577,7 @@ declare module "types" {
         selected?: boolean;
         statusNodeType?: NodeStatusType;
         title: string;
-        tooltip?: boolean | string;
+        tooltip?: TooltipOption;
         type?: string;
         unselectable?: boolean;
         /** @internal */
@@ -1737,8 +1753,8 @@ declare module "types" {
         colspan?: boolean;
         /** Default icon for matching nodes. */
         icon?: IconOption;
-        /** Default icon for matching nodes. */
-        iconTooltip?: string | boolean;
+        /** Default icon tooltip for matching nodes. */
+        iconTooltip?: TooltipOption;
         [key: string]: unknown;
     }
     export type NodeTypeDefinitionMap = {
@@ -1946,12 +1962,34 @@ declare module "types" {
     }
     /** Possible values for {@link Wunderbaum.expandAll} and {@link WunderbaumNode.expandAll}. */
     export interface ExpandAllOptions {
-        /** Restrict expand level @default 99 */
-        depth?: number;
         /** Expand and load lazy nodes @default false  */
         loadLazy?: boolean;
-        /** Ignore `minExpandLevel` option @default false */
+        /** Unload lazily loaded children if any (if collapsing). @default false */
+        resetLazy?: boolean;
+        /** Ignore tree's `minExpandLevel` option @default false */
         force?: boolean;
+        /** Restrict expand level.
+         * Pass 0 to make only toplevel nodes visible, 1 to expand one level deeper, etc.
+         * @default unset (unlimited)
+         */
+        depth?: number;
+        /**
+         * Also collapse child nodes beyond the `depth` level.
+         * Otherwise only the `depth` level is collapsed and the expand state of the
+         * descendants is retained.
+         * Only in combination with collapse and `depth`.
+         * Expanding with `deep` option is not supported as recursion depth implied by
+         * the `depth` option. However a `deep` option will be considered if
+         * `collapseOthers` is set.
+         * @default false
+         */
+        deep?: boolean;
+        /**
+         * Expand up to level=depth and collapse all other branches.
+         * Only in combination with `flag == true`, `depth > 0`.
+         * @default false
+         */
+        collapseOthers?: boolean;
         /** Keep active node visible @default true */
         keepActiveNodeVisible?: boolean;
     }
@@ -2062,7 +2100,7 @@ declare module "types" {
     }
     /** Possible values for {@link WunderbaumNode.setExpanded} `options` argument. */
     export interface SetExpandedOptions {
-        /** Ignore {@link WunderbaumOptions.minExpandLevel}. @default false */
+        /** Ignore {@link WunderbaumOptions}.minExpandLevel. @default false */
         force?: boolean;
         /** Immediately update viewport (async otherwise). @default false */
         immediate?: boolean;
@@ -2070,6 +2108,8 @@ declare module "types" {
         noAnimation?: boolean;
         /** Do not send events. @default false */
         noEvents?: boolean;
+        /** Unload lazily loaded children if any (if collapsing). @default false */
+        resetLazy?: boolean;
         /** Scroll up to bring expanded nodes into viewport. @default false */
         scrollIntoView?: boolean;
     }