wunderbaum 0.5.1 → 0.5.3

package/src/common.ts

@@ -193,7 +193,7 @@ function unflattenSource(source: any): void {
     );
   }
   // Inverse keyMap:
-  let longToShort: any = {};
+  const longToShort: any = {};
   if (_keyMap) {
     for (const [key, value] of Object.entries(_keyMap)) {
       longToShort[<string>value] = key;
@@ -277,7 +277,7 @@ export function inflateSourceData(source: any): void {
   delete source._positional;
 
   function _iter(childList: any[]) {
-    for (let node of childList) {
+    for (const node of childList) {
       // Expand short alias names
       if (_keyMap) {
         // Iterate over a list of names, because we modify inside the loop:

package/src/debounce.ts

@@ -270,6 +270,7 @@ export function debounce<F extends Procedure>(
     const isInvoking = shouldInvoke(time);
 
     lastArgs = args;
+    // eslint-disable-next-line  @typescript-eslint/no-this-alias
     lastThis = this;
     lastCallTime = time;
 

package/src/types.ts

@@ -187,7 +187,7 @@ export interface WbIconBadgeEventResultType {
   badge: string | number | HTMLSpanElement | null | false;
   /** Additional class name(s), separate with space. */
   badgeClass?: string;
-  /** Additional class name(s), separate with space. */
+  /** Tooltip for the badge. */
   badgeTooltip?: string;
 }
 
@@ -471,6 +471,8 @@ export interface ExpandAllOptions {
   loadLazy?: boolean;
   /** Ignore `minExpandLevel` option @default false */
   force?: boolean;
+  /** Keep active node visible @default true */
+  keepActiveNodeVisible?: boolean;
 }
 
 /** Possible values for {@link Wunderbaum.filterNodes()} and {@link Wunderbaum.filterBranches()}. */
@@ -613,6 +615,124 @@ export interface VisitRowsOptions {
   wrap?: boolean;
 }
 
+export type FilterOptionsType = {
+  /**
+   * Element or selector of an input control for filter query strings
+   * @default null
+   */
+  connectInput?: null | string | Element;
+  /**
+   * Re-apply last filter if lazy data is loaded
+   * @default true
+   */
+  autoApply?: boolean;
+  /**
+   * Expand all branches that contain matches while filtered
+   * @default false
+   */
+  autoExpand?: boolean;
+  /**
+   * Show a badge with number of matching child nodes near parent icons
+   * @default true
+   */
+  counter?: boolean;
+  /**
+   * Match single characters in order, e.g. 'fb' will match 'FooBar'
+   * @default false
+   */
+  fuzzy?: boolean;
+  /**
+   * Hide counter badge if parent is expanded
+   * @default true
+   */
+  hideExpandedCounter?: boolean;
+  /**
+   * Hide expanders if all child nodes are hidden by filter
+   * @default false;
+   */
+  hideExpanders?: boolean;
+  /**
+   * Highlight matches by wrapping inside <mark> tags
+   * @default true
+   */
+  highlight?: boolean;
+  /**
+   * Match end nodes only
+   * @default false
+   */
+  leavesOnly?: boolean;
+  /**
+   * Grayout unmatched nodes (pass "hide" to remove unmatched node instead)
+   * @default 'dim'
+   */
+  mode?: "dim" | "hide";
+  /**
+   * Display a 'no data' status node if result is empty
+   * @default true
+   */
+  noData?: boolean;
+};
+
+export type EditOptionsType = {
+  /**
+   * @default 100
+   */
+  debounce?: number;
+  /**
+   * @default 1
+   */
+  minlength?: number;
+  /**
+   * @default null;
+   */
+  maxlength?: null | number;
+  /**
+   * ["clickActive", "F2", "macEnter"],
+   * @default []
+   */
+  trigger?: string[];
+  /**
+   * @default true
+   */
+  trim?: boolean;
+  /**
+   * @default true
+   */
+  select?: boolean;
+  /**
+   * Handle 'clickActive' only if last click is less than this old (0: always)
+   * @default 1000
+   */
+  slowClickDelay?: number;
+  /**
+   * Please enter a title",
+   * @default true
+   */
+  validity?: boolean;
+
+  // --- Events ---
+  // (note: there is also the `tree.change` event.)
+  /**
+   * `beforeEdit(e)` may return an input HTML string. Otherwise use a default.
+   */
+  beforeEdit?: null | ((e: WbNodeEventType) => boolean) | string;
+  /**
+   *
+   */
+  edit?:
+    | null
+    | ((e: WbNodeEventType & { inputElem: HTMLInputElement }) => void);
+  /**
+   *
+   */
+  apply?:
+    | null
+    | ((e: WbNodeEventType & { inputElem: HTMLInputElement }) => any)
+    | Promise<any>;
+};
+
+export type GridOptionsType = object;
+
 /* -----------------------------------------------------------------------------
  * wb_ext_dnd
  * ---------------------------------------------------------------------------*/
@@ -641,7 +761,7 @@ export type DndOptionsType = {
    * Expand nodes after n milliseconds of hovering
    * @default 1500
    */
-  autoExpandMS: 1500;
+  autoExpandMS?: 1500;
   // /**
   //  * Additional offset for drop-marker with hitMode = "before"/"after"
   //  * @default
@@ -662,62 +782,67 @@ export type DndOptionsType = {
    * true: Drag multiple (i.e. selected) nodes. Also a callback() is allowed
    * @default false
    */
-  multiSource: false;
+  multiSource?: false;
   /**
    * Restrict the possible cursor shapes and modifier operations (can also be set in the dragStart event)
    * @default "all"
    */
-  effectAllowed: "all";
+  effectAllowed?: "all";
   // /**
   //  * 'copy'|'link'|'move'|'auto'(calculate from `effectAllowed`+modifier keys) or callback(node, data) that returns such string.
   //  * @default
   //  */
   // dropEffect: "auto";
   /**
-   * Default dropEffect ('copy', 'link', or 'move') when no modifier is pressed (overide in dragDrag, dragOver).
+   * Default dropEffect ('copy', 'link', or 'move') when no modifier is pressed (overide in drag, dragOver).
    * @default "move"
    */
-  dropEffectDefault: string;
+  dropEffectDefault?: string;
   /**
    * Prevent dropping nodes from different Wunderbaum trees
    * @default false
    */
-  preventForeignNodes: boolean;
+  preventForeignNodes?: boolean;
   /**
    * Prevent dropping items on unloaded lazy Wunderbaum tree nodes
    * @default true
    */
-  preventLazyParents: boolean;
+  preventLazyParents?: boolean;
   /**
    * Prevent dropping items other than Wunderbaum tree nodes
    * @default false
    */
-  preventNonNodes: boolean;
+  preventNonNodes?: boolean;
   /**
    * Prevent dropping nodes on own descendants
    * @default true
    */
-  preventRecursion: boolean;
+  preventRecursion?: boolean;
   /**
    * Prevent dropping nodes under same direct parent
    * @default false
    */
-  preventSameParent: false;
+  preventSameParent?: false;
   /**
    * Prevent dropping nodes 'before self', etc. (move only)
    * @default true
    */
-  preventVoidMoves: boolean;
+  preventVoidMoves?: boolean;
+  /**
+   * Serialize Node Data to datatransfer object
+   * @default true
+   */
+  serializeClipboardData?: boolean | ((nodeData: WbNodeData) => string);
   /**
    * Enable auto-scrolling while dragging
    * @default true
    */
-  scroll: boolean;
+  scroll?: boolean;
   /**
    * Active top/bottom margin in pixel
    * @default 20
    */
-  scrollSensitivity: 20;
+  scrollSensitivity?: 20;
   // /**
   //  * Scroll events every N microseconds
   //  * @default 50
@@ -727,7 +852,7 @@ export type DndOptionsType = {
    * Pixel per event
    * @default 5
    */
-  scrollSpeed: 5;
+  scrollSpeed?: 5;
   // /**
   //  * Allow dragging of nodes to different IE windows
   //  * @default false
@@ -737,47 +862,56 @@ export type DndOptionsType = {
    * Optional callback passed to `toDict` on dragStart @since 2.38
    * @default null
    */
-  sourceCopyHook: null;
+  sourceCopyHook?: null;
   // Events (drag support)
   /**
    * Callback(sourceNode, data), return true, to enable dnd drag
    * @default null
    */
-  dragStart?: WbNodeEventType;
+  dragStart?: null | ((e: WbNodeEventType & { event: DragEvent }) => boolean);
   /**
    * Callback(sourceNode, data)
    * @default null
    */
-  dragDrag: null;
+  drag?: null | ((e: WbNodeEventType & { event: DragEvent }) => void);
   /**
    * Callback(sourceNode, data)
    * @default null
    */
-  dragEnd: null;
+  dragEnd?: null | ((e: WbNodeEventType & { event: DragEvent }) => void);
   // Events (drop support)
   /**
    * Callback(targetNode, data), return true, to enable dnd drop
    * @default null
    */
-  dragEnter: null;
+  dragEnter?: null | ((e: WbNodeEventType & { event: DragEvent }) => boolean);
   /**
    * Callback(targetNode, data)
    * @default null
    */
-  dragOver: null;
+  dragOver?: null | ((e: WbNodeEventType & { event: DragEvent }) => void);
   /**
    * Callback(targetNode, data), return false to prevent autoExpand
    * @default null
    */
-  dragExpand: null;
+  dragExpand?: null | ((e: WbNodeEventType & { event: DragEvent }) => boolean);
   /**
    * Callback(targetNode, data)
    * @default null
    */
-  dragDrop: null;
+  drop?:
+    | null
+    | ((
+        e: WbNodeEventType & {
+          event: DragEvent;
+          region: DropRegionType;
+          defaultDropMode: string;
+          sourceNode: WunderbaumNode;
+        }
+      ) => void);
   /**
    * Callback(targetNode, data)
    * @default null
    */
-  dragLeave: null;
+  dragLeave?: null;
 };

package/src/util.ts

@@ -137,8 +137,8 @@ export function each(
     // accept `null` or `undefined`
     return obj;
   }
-  let length = obj.length,
-    i = 0;
+  const length = obj.length;
+  let i = 0;
 
   if (typeof length === "number") {
     for (; i < length; i++) {
@@ -147,7 +147,7 @@ export function each(
       }
     }
   } else {
-    for (let k in obj) {
+    for (const k in obj) {
       if (callback.call(obj[i], k, obj[k]) === false) {
         break;
       }
@@ -256,11 +256,13 @@ export function getValueFromElem(elem: HTMLElement, coerce = false): any {
         value = input.valueAsNumber;
         break;
       case "radio":
-        const name = input.name;
-        const checked = input.parentElement!.querySelector(
-          `input[name="${name}"]:checked`
-        );
-        value = checked ? (<HTMLInputElement>checked).value : undefined;
+        {
+          const name = input.name;
+          const checked = input.parentElement!.querySelector(
+            `input[name="${name}"]:checked`
+          );
+          value = checked ? (<HTMLInputElement>checked).value : undefined;
+        }
         break;
       case "text":
       default:
@@ -438,9 +440,9 @@ export function eventTargetFromSelector(
  * ```
  */
 export function eventToString(event: Event): string {
-  let key = (<KeyboardEvent>event).key,
-    et = event.type,
-    s = [];
+  const key = (<KeyboardEvent>event).key;
+  const et = event.type;
+  const s = [];
 
   if ((<KeyboardEvent>event).altKey) {
     s.push("Alt");
@@ -479,11 +481,11 @@ export function eventToString(event: Event): string {
 // TODO: support deep merge --> https://stackoverflow.com/a/42740894
 export function extend(...args: any[]) {
   for (let i = 1; i < args.length; i++) {
-    let arg = args[i];
+    const arg = args[i];
     if (arg == null) {
       continue;
     }
-    for (let key in arg) {
+    for (const key in arg) {
       if (Object.prototype.hasOwnProperty.call(arg, key)) {
         args[0][key] = arg[key];
       }
@@ -604,18 +606,17 @@ export function overrideMethod(
   handler: FunctionType,
   ctx?: any
 ) {
-  let prevSuper: FunctionType,
-    prevSuperApply: FunctionType,
-    self = ctx || instance,
-    prevFunc = instance[methodName],
-    _super = (...args: any[]) => {
-      return prevFunc.apply(self, args);
-    },
-    _superApply = (argsArray: any[]) => {
-      return prevFunc.apply(self, argsArray);
-    };
+  let prevSuper: FunctionType, prevSuperApply: FunctionType;
+  const self = ctx || instance;
+  const prevFunc = instance[methodName];
+  const _super = (...args: any[]) => {
+    return prevFunc.apply(self, args);
+  };
+  const _superApply = (argsArray: any[]) => {
+    return prevFunc.apply(self, argsArray);
+  };
 
-  let wrapper = (...args: any[]) => {
+  const wrapper = (...args: any[]) => {
     try {
       prevSuper = self._super;
       prevSuperApply = self._superApply;
@@ -717,7 +718,7 @@ export function getOption(
     [ext, name] = name.split(".");
     opts = opts[ext];
   }
-  let value = opts ? opts[name] : null;
+  const value = opts ? opts[name] : null;
   // Use value from value options dict, fallback do default
   return value ?? defaultValue;
 }
@@ -728,7 +729,7 @@ export function toSet(val: any): Set<string> {
     return val;
   }
   if (typeof val === "string") {
-    let set = new Set<string>();
+    const set = new Set<string>();
     for (const c of val.split(" ")) {
       set.add(c.trim());
     }
@@ -812,7 +813,7 @@ export function adaptiveThrottle(
       try {
         callback.apply(this, useArgs);
       } catch (error) {
-        console.error(error);
+        console.error(error); // eslint-disable-line no-console
       }
       const elap = Date.now() - start;