wunderbaum 0.12.0 → 0.13.0

package/dist/wunderbaum.d.ts

@@ -1,8 +1,8 @@
 declare module "debounce" {
     /*!
-     * debounce & throttle, taken from https://github.com/lodash/lodash v4.17.21
-     * MIT License: https://raw.githubusercontent.com/lodash/lodash/4.17.21-npm/LICENSE
-     * Modified for TypeScript type annotations.
+     * Wunderbaum - debounce.ts
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
+     * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     type Procedure = (...args: any[]) => any;
     type DebounceOptions = {
@@ -130,7 +130,7 @@ declare module "debounce" {
 declare module "util" {
     /*!
      * Wunderbaum - util
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     /** @module util */
@@ -422,10 +422,10 @@ declare module "util" {
 declare module "common" {
     /*!
      * Wunderbaum - common
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
-    import { MatcherCallback, SourceObjectType } from "types";
+    import { ApplyCommandType, NavigationType, SourceObjectType, IconMapType, MatcherCallback } from "types";
     import { WunderbaumNode } from "wb_node";
     export const DEFAULT_DEBUGLEVEL = 4;
     /**
@@ -452,13 +452,14 @@ declare module "common" {
      */
     export const TEST_IMG: RegExp;
     /**
-     * Default node icons.
-     * Requires bootstrap icons https://icons.getbootstrap.com
+     * Default node icons for icon libraries
+     *
+     *  - 'bootstrap': {@link https://icons.getbootstrap.com}
+     *  - 'fontawesome6' {@link https://fontawesome.com/icons}
+     *
      */
     export const iconMaps: {
-        [key: string]: {
-            [key: string]: string;
-        };
+        [key: string]: IconMapType;
     };
     export const KEY_NODATA = "__not_found__";
     /** Define which keys are handled by embedded <input> control, and should
@@ -470,8 +471,12 @@ declare module "common" {
     /** Dict keys that are evaluated by source loader (others are added to `tree.data` instead). */
     export const RESERVED_TREE_SOURCE_KEYS: Set<string>;
     /** Map `KeyEvent.key` to navigation action. */
-    export const KEY_TO_ACTION_DICT: {
-        [key: string]: string;
+    export const KEY_TO_NAVIGATION_MAP: {
+        [key: string]: NavigationType;
+    };
+    /** Map `KeyEvent.key` to navigation action. */
+    export const KEY_TO_COMMAND_MAP: {
+        [key: string]: ApplyCommandType;
     };
     /** Return a callback that returns true if the node title matches the string
      * or regular expression.
@@ -496,7 +501,7 @@ declare module "common" {
 declare module "deferred" {
     /*!
      * Wunderbaum - deferred
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     type PromiseCallbackType = (val: any) => void;
@@ -537,7 +542,7 @@ declare module "deferred" {
 }
 declare module "wb_node" {
     import { Wunderbaum } from "wunderbaum";
-    import { AddChildrenOptions, ApplyCommandOptions, ApplyCommandType, ChangeType, CheckboxOption, ExpandAllOptions, IconOption, InsertNodeType, MakeVisibleOptions, MatcherCallback, NavigateOptions, NodeAnyCallback, NodeStatusType, NodeStringCallback, NodeToDictCallback, NodeVisitCallback, NodeVisitResponse, RenderOptions, ResetOrderOptions, ScrollIntoViewOptions, SetActiveOptions, SetExpandedOptions, SetSelectedOptions, SetStatusOptions, SortByPropertyOptions, SortCallback, SourceType, TooltipOption, TristateType, WbNodeData } from "types";
+    import { AddChildrenOptions, ApplyCommandOptions, ApplyCommandType, ChangeType, CheckboxOption, ExpandAllOptions, IconOption, InsertNodeType, MakeVisibleOptions, MatcherCallback, NavigateOptions, NavigationType, NodeAnyCallback, NodeStatusType, NodeStringCallback, NodeToDictCallback, NodeVisitCallback, NodeVisitResponse, RenderOptions, ResetOrderOptions, ScrollIntoViewOptions, SetActiveOptions, SetExpandedOptions, SetSelectedOptions, SetStatusOptions, SortByPropertyOptions, SortCallback, SourceType, TooltipOption, TristateType, WbNodeData } from "types";
     /**
      * A single tree node.
      *
@@ -609,7 +614,11 @@ declare module "wb_node" {
         _errorInfo: any | null;
         _partsel: boolean;
         _partload: boolean;
-        match?: boolean;
+        /**
+         * > 0 if matched (-1 to keep system nodes visible);
+         * Added and removed by filter code.
+         */
+        match?: number;
         subMatchCount?: number;
         /** @internal */
         titleWithHighlight?: string;
@@ -727,7 +736,7 @@ declare module "wb_node" {
          *
          * @see {@link Wunderbaum.findRelatedNode|tree.findRelatedNode()}
          */
-        findRelatedNode(where: string, includeHidden?: boolean): any;
+        findRelatedNode(where: NavigationType, includeHidden?: boolean): any;
         /**
          * Iterator version of {@link WunderbaumNode.format}.
          */
@@ -844,7 +853,7 @@ declare module "wb_node" {
          * @see {@link WunderbaumNode.isAncestorOf}
          */
         isParentOf(other: WunderbaumNode): boolean;
-        /** (experimental) Return true if this node is partially loaded. */
+        /** Return true if this node is partially loaded. @experimental  */
         isPartload(): boolean;
         /** Return true if this node is partially selected (tri-state). */
         isPartsel(): boolean;
@@ -919,7 +928,7 @@ declare module "wb_node" {
          *   e.g. `ArrowLeft` = 'left'.
          * @param options
          */
-        navigate(where: string, options?: NavigateOptions): Promise<any>;
+        navigate(where: NavigationType | string, options?: NavigateOptions): Promise<any>;
         /** Delete this node and all descendants. */
         remove(): void;
         /** Remove all descendants of this node. */
@@ -927,7 +936,7 @@ declare module "wb_node" {
         /** Remove all HTML markup from the DOM. */
         removeMarkup(): void;
         protected _getRenderInfo(): any;
-        protected _createIcon(iconMap: any, parentElem: HTMLElement, replaceChild: HTMLElement | null, showLoading: boolean): HTMLElement | null;
+        protected _createIcon(parentElem: HTMLElement, replaceChild: HTMLElement | null, showLoading: boolean): HTMLElement | null;
         /**
          * Create a whole new `<div class="wb-row">` element.
          * @see {@link WunderbaumNode._render}
@@ -1112,10 +1121,10 @@ declare module "wb_node" {
 declare module "wb_options" {
     /*!
      * Wunderbaum - utils
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
-    import { ColumnDefinitionList, DndOptionsType, DynamicBoolOption, DynamicBoolOrStringOption, DynamicCheckboxOption, DynamicIconOption, EditOptionsType, FilterOptionsType, NavModeEnum, NodeTypeDefinitionMap, SelectModeType, WbActivateEventType, WbButtonClickEventType, WbCancelableEventResultType, WbChangeEventType, WbClickEventType, WbDeactivateEventType, WbErrorEventType, WbExpandEventType, WbIconBadgeCallback, WbIconBadgeEventResultType, WbInitEventType, WbKeydownEventType, WbNodeData, WbNodeEventType, WbReceiveEventType, WbRenderEventType, WbSelectEventType, WbTreeEventType } from "types";
+    import { ColumnDefinitionList, DndOptionsType, DynamicBoolOption, DynamicBoolOrStringOption, DynamicCheckboxOption, DynamicIconOption, EditOptionsType, FilterOptionsType, IconMapType, NavModeEnum, NodeTypeDefinitionMap, SelectModeType, TranslationsType, WbActivateEventType, WbButtonClickEventType, WbCancelableEventResultType, WbChangeEventType, WbClickEventType, WbDeactivateEventType, WbErrorEventType, WbExpandEventType, WbIconBadgeCallback, WbIconBadgeEventResultType, WbInitEventType, WbKeydownEventType, WbNodeData, WbNodeEventType, WbReceiveEventType, WbRenderEventType, WbSelectEventType, WbTreeEventType } from "types";
     /**
      * Available options for {@link wunderbaum.Wunderbaum}.
      *
@@ -1191,7 +1200,7 @@ declare module "wb_options" {
         /**
          * Translation map for some system messages.
          */
-        strings?: any;
+        strings?: TranslationsType;
         /**
          * 0:quiet, 1:errors, 2:warnings, 3:info, 4:verbose
          * Default: 3 (4 in local debug environment)
@@ -1220,9 +1229,7 @@ declare module "wb_options" {
          * Note: the icon font must be loaded separately.
          * Default: "bootstrap"
          */
-        iconMap?: string | {
-            [key: string]: string;
-        };
+        iconMap?: string | IconMapType;
         /**
          * Collapse siblings when a node is expanded.
          * Default: false
@@ -1243,10 +1250,10 @@ declare module "wb_options" {
          */
         adjustHeight?: boolean;
         /**
-         * HTMLElement that receives the top nodes breadcrumb.
+         * HTMLElement or selector that receives the top nodes breadcrumb.
          * Default: undefined
          */
-        connectTopBreadcrumb?: HTMLElement;
+        connectTopBreadcrumb?: HTMLElement | string;
         /**
          * Default:  NavModeEnum.startRow
          */
@@ -1475,7 +1482,7 @@ declare module "wb_options" {
 declare module "types" {
     /*!
      * Wunderbaum - types
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     import { WunderbaumNode } from "wb_node";
@@ -1494,7 +1501,7 @@ declare module "types" {
      * or a boolean value that indicates if the default icon should be used or hidden.
      */
     export type IconOption = boolean | string;
-    /** Show/hide tooltip or display a string. */
+    /** Show/hide default tooltip or display a string. */
     export type TooltipOption = boolean | string;
     export interface SourceAjaxType {
         url: string;
@@ -1548,7 +1555,10 @@ declare module "types" {
      * returns an iteration modifier.
      */
     export type NodeToDictCallback = (dict: WbNodeData, node: WunderbaumNode) => NodeVisitResponse;
-    /** A callback that receives a node instance and returns a string value. */
+    /**
+     * A callback that receives a node instance and may returnsa `false` to prevent
+     * (de)selection.
+     */
     export type NodeSelectCallback = (node: WunderbaumNode) => boolean | void;
     /**
      * See also {@link WunderbaumNode.getOption|WunderbaumNode.getOption()}
@@ -1562,29 +1572,88 @@ declare module "types" {
     export type DynamicTooltipOption = TooltipOption | BoolOrStringOptionResolver;
     /** A plain object (dictionary) that represents a node instance. */
     export interface WbNodeData {
+        /** Defines if the `selected` state is displayed as checkbox, radio button,
+         * or hidden.
+         * Defaults to {@link WunderbaumOptions.checkbox}.
+         */
         checkbox?: CheckboxOption;
+        /** Optional list of child nodes.
+         * If `children` is an empty array, the node is considered a leaf.
+         * If `lazy` is true and `children is undefined or null, the node, is
+         * considered unloaded. Otherwise, the node is considered a leaf.
+         */
         children?: Array<WbNodeData>;
+        /** Additional classes that are added to `<div class='wb-row'>`. */
         classes?: string;
+        /** Only show title in a single, merged column. */
         colspan?: boolean;
+        /** Expand this node. */
         expanded?: boolean;
+        /** Defaults to standard icons (doc, folder, folderOpen, ...)
+         * from {@link WunderbaumOptions.iconMap}.
+         * Can be overridden by {@link WunderbaumOptions.icon}.
+         */
         icon?: IconOption;
+        /** Tooltip for the node icon only. Defaults to {@link WunderbaumOptions.iconTooltip}. */
         iconTooltip?: TooltipOption;
+        /** The node's key. Must be unique for the whole tree. Defaults to a sequence number. */
         key?: string;
+        /** If true (and children are undefined or null), the node is considered lazy
+         * and {@link WunderbaumOptions.lazyLoad} is called when expanded.
+         */
         lazy?: boolean;
         /** Make child nodes single-select radio buttons. */
         radiogroup?: boolean;
+        /** Node's reference key. Unlike {@link WunderbaumNode.key}, this value
+         * may be non-unique. Nodes within the tree that share the same refKey are considered
+         * clones.
+         */
         refKey?: string;
+        /** The node's selection status, typically displayed as a checkbox. */
         selected?: boolean;
+        /** The node's status, typically displayed as merged single row.
+         * @see {@link Wunderbaum.setStatus}
+         */
         statusNodeType?: NodeStatusType;
+        /** The node's title. Will be html escaped to prevent XSS. */
         title: string;
+        /** Pass true to set node tooltip to the node's title. Defaults to {@link WunderbaumOptions.tooltip}. */
         tooltip?: TooltipOption;
+        /** Inherit shared settings from the matching entry in {@link WunderbaumOptions.types}. */
         type?: string;
+        /** Set to `true` to prevent selection. Defaults to {@link WunderbaumOptions.unselectable}. */
         unselectable?: boolean;
         /** @internal */
         _treeId?: string;
         /** Other data is passed to `node.data` and can be accessed via `node.data.NAME` */
         [key: string]: unknown;
     }
+    /** A plain object (dictionary) that defines node icons. */
+    export interface IconMapType {
+        error: string;
+        loading: string;
+        noData: string;
+        expanderExpanded: string;
+        expanderCollapsed: string;
+        expanderLazy: string;
+        checkChecked: string;
+        checkUnchecked: string;
+        checkUnknown: string;
+        radioChecked: string;
+        radioUnchecked: string;
+        radioUnknown: string;
+        folder: string;
+        folderOpen: string;
+        folderLazy: string;
+        doc: string;
+        colSortable: string;
+        colSortAsc: string;
+        colSortDesc: string;
+        colFilter: string;
+        colFilterActive: string;
+        colMenu: string;
+        [key: string]: string;
+    }
     /** A callback that receives a node instance and returns a string value. */
     export type WbCancelableEventResultType = false | void;
     export interface WbTreeEventType {
@@ -1842,6 +1911,19 @@ declare module "types" {
         [key: string]: unknown;
     }
     export type ColumnDefinitionList = Array<ColumnDefinition>;
+    /**
+     * Used by {@link Wunderbaum.getState} and {@link Wunderbaum.setState}.
+     */
+    export interface TreeStateDefinition {
+        /** The active node's key if any. */
+        activeKey: string | null;
+        /** The active column index if any. */
+        activeColIdx: number | null;
+        /** List of selected node's keys. */
+        selectedKeys: Array<string> | undefined;
+        /** List of expanded node's keys. */
+        expandedKeys: Array<string> | undefined;
+    }
     /**
      * Column information (passed to the `render` event).
      */
@@ -1884,9 +1966,10 @@ declare module "types" {
         /** The affected column's span tag if any. */
         colElem?: HTMLSpanElement;
     }
-    export type FilterModeType = null | "dim" | "hide";
+    export type FilterModeType = null | "mark" | "dim" | "hide";
     export type SelectModeType = "single" | "multi" | "hier";
-    export type ApplyCommandType = "addChild" | "addSibling" | "copy" | "cut" | "down" | "first" | "indent" | "last" | "left" | "moveDown" | "moveUp" | "outdent" | "pageDown" | "pageUp" | "parent" | "paste" | "remove" | "rename" | "right" | "up";
+    export type NavigationType = "down" | "first" | "firstCol" | "last" | "lastCol" | "left" | "nextMatch" | "pageDown" | "pageUp" | "parent" | "prevMatch" | "right" | "up";
+    export type ApplyCommandType = NavigationType | "addChild" | "addSibling" | "collapse" | "collapseAll" | "copy" | "cut" | "edit" | "expand" | "expandAll" | "indent" | "moveDown" | "moveUp" | "outdent" | "paste" | "remove" | "rename" | "toggleSelect";
     export type NodeFilterResponse = "skip" | "branch" | boolean | void;
     export type NodeFilterCallback = (node: WunderbaumNode) => NodeFilterResponse;
     /**
@@ -1910,6 +1993,7 @@ declare module "types" {
         /** Vertical scroll event. Update the 'top' property of all rows. */
         scroll = "scroll"
     }
+    /** @internal */
     export enum RenderFlag {
         clearMarkup = "clearMarkup",
         header = "header",
@@ -1936,11 +2020,32 @@ declare module "types" {
     }
     /** Initial navigation mode and possible transition. */
     export enum NavModeEnum {
-        startRow = "startRow",// Start with row mode, but allow cell-nav mode
-        cell = "cell",// Cell-nav mode only
-        startCell = "startCell",// Start in cell-nav mode, but allow row mode
+        /** Start with row mode, but allow cell-nav mode */
+        startRow = "startRow",
+        /** Cell-nav mode only */
+        cell = "cell",
+        /** Start in cell-nav mode, but allow row mode */
+        startCell = "startCell",
+        /** Row mode only */
         row = "row"
     }
+    /** Translatable strings. */
+    export type TranslationsType = {
+        /** @default "Loading..." */
+        loading: string;
+        /** @default "Error" */
+        loadError: string;
+        /** @default "No data" */
+        noData: string;
+        /** @default " » " */
+        breadcrumbDelimiter: string;
+        /** @default "Found ${matches} of ${count}" */
+        queryResult: string;
+        /** @default "No result" */
+        noMatch: string;
+        /** @default "${match} of ${matches}" */
+        matchIndex: string;
+    };
     /** Possible values for {@link WunderbaumNode.addChildren}. */
     export interface AddChildrenOptions {
         /** Insert children before this node (or index)
@@ -2019,6 +2124,18 @@ declare module "types" {
         /** Display a 'no data' status node if result is empty @default true */
         noData?: boolean | string;
     }
+    /** Possible values for {@link Wunderbaum.getState}. */
+    export interface GetStateOptions {
+        /** Include the expanded keys. @default true */
+        expandedKeys?: boolean;
+        /** Include the selected keys. @default true */
+        selectedKeys?: boolean;
+    }
+    /** Possible values for {@link Wunderbaum.setState}. */
+    export interface SetStateOptions {
+        /** Recursively load lazy nodes as needed. @default false */
+        expandLazy?: boolean;
+    }
     /** Possible values for {@link WunderbaumNode.makeVisible}. */
     export interface MakeVisibleOptions {
         /** Do not animate expand (currently not implemented). @default false */
@@ -2194,6 +2311,17 @@ declare module "types" {
          * until the start node is reached again @default false */
         wrap?: boolean;
     }
+    /**
+     * Passed as tree option.filer.connect to configure automatic integration of
+     * filter UI controls. @experimental
+     */
+    export interface FilterConnectType {
+        inputElem: string | HTMLInputElement | null;
+        modeButton?: string | HTMLButtonElement | null;
+        nextButton?: string | HTMLButtonElement | HTMLAnchorElement | null;
+        prevButton?: string | HTMLButtonElement | HTMLAnchorElement | null;
+        matchInfoElem?: string | HTMLElement | null;
+    }
     /**
      * Passed as tree options to configure default filtering behavior.
      *
@@ -2202,10 +2330,12 @@ declare module "types" {
      */
     export type FilterOptionsType = {
         /**
-         * Element or selector of an input control for filter query strings
+         * Element or selector of input controls and buttons for filter query strings.
+         * @experimental
+         * @since 0.13
          * @default null
          */
-        connectInput?: null | string | Element;
+        connect?: null | FilterConnectType;
         /**
          * Re-apply last filter if lazy data is loaded
          * @default true
@@ -2452,6 +2582,7 @@ declare module "types" {
     export type LoggerOptionsType = object;
 }
 declare module "wb_extension_base" {
+    import { WunderbaumOptions } from "wb_options";
     import { Wunderbaum } from "wunderbaum";
     export type ExtensionsDict = {
         [key: string]: WunderbaumExtension<any>;
@@ -2460,7 +2591,7 @@ declare module "wb_extension_base" {
         enabled: boolean;
         readonly id: string;
         readonly tree: Wunderbaum;
-        readonly treeOpts: any;
+        readonly treeOpts: WunderbaumOptions;
         readonly extensionOpts: any;
         constructor(tree: Wunderbaum, id: string, defaults: TOptions);
         /** Called on tree (re)init after all extensions are added, but before loading.*/
@@ -2477,11 +2608,17 @@ declare module "wb_ext_filter" {
     import { Wunderbaum } from "wunderbaum";
     import { WunderbaumExtension } from "wb_extension_base";
     export class FilterExtension extends WunderbaumExtension<FilterOptionsType> {
-        queryInput?: HTMLInputElement;
+        queryInput: HTMLInputElement | null;
+        prevButton: HTMLElement | HTMLAnchorElement | null;
+        nextButton: HTMLElement | HTMLAnchorElement | null;
+        modeButton: HTMLButtonElement | null;
+        matchInfoElem: HTMLElement | null;
         lastFilterArgs: IArguments | null;
         constructor(tree: Wunderbaum);
         init(): void;
         setPluginOption(name: string, value: any): void;
+        _updatedConnectedControls(): void;
+        _connectControls(): void;
         _applyFilterNoUpdate(filter: string | RegExp | NodeFilterCallback, _opts: FilterNodesOptions): number;
         _applyFilterImpl(filter: string | RegExp | NodeFilterCallback, _opts: FilterNodesOptions): number;
         /**
@@ -2510,7 +2647,7 @@ declare module "wb_ext_filter" {
 declare module "wb_ext_keynav" {
     /*!
      * Wunderbaum - ext-keynav
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     import { KeynavOptionsType } from "types";
@@ -2526,7 +2663,7 @@ declare module "wb_ext_keynav" {
 declare module "wb_ext_logger" {
     /*!
      * Wunderbaum - ext-logger
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     import { LoggerOptionsType } from "types";
@@ -2590,7 +2727,7 @@ declare module "wb_ext_dnd" {
 declare module "drag_observer" {
     /*!
      * Wunderbaum - drag_observer
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     export type DragCallbackArgType = {
@@ -2659,7 +2796,7 @@ declare module "drag_observer" {
 declare module "wb_ext_grid" {
     /*!
      * Wunderbaum - ext-grid
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     import { Wunderbaum } from "wunderbaum";
@@ -2679,7 +2816,7 @@ declare module "wb_ext_grid" {
 declare module "wb_ext_edit" {
     /*!
      * Wunderbaum - ext-edit
-     * Copyright (c) 2021-2024, Martin Wendt. Released under the MIT license.
+     * Copyright (c) 2021-2025, Martin Wendt. Released under the MIT license.
      * @VERSION, @DATE (https://github.com/mar10/wunderbaum)
      */
     import { Wunderbaum } from "wunderbaum";
@@ -2718,7 +2855,7 @@ declare module "wunderbaum" {
      *
      * A treegrid control.
      *
-     * Copyright (c) 2021-2024, Martin Wendt (https://wwWendt.de).
+     * Copyright (c) 2021-2025, Martin Wendt (https://wwWendt.de).
      * https://github.com/mar10/wunderbaum
      *
      * Released under the MIT license.
@@ -2727,7 +2864,7 @@ declare module "wunderbaum" {
      */
     import * as util from "util";
     import { ExtensionsDict, WunderbaumExtension } from "wb_extension_base";
-    import { AddChildrenOptions, ApplyCommandOptions, ApplyCommandType, ChangeType, ColumnDefinitionList, DynamicBoolOption, DynamicCheckboxOption, DynamicIconOption, DynamicStringOption, DynamicTooltipOption, ExpandAllOptions, FilterModeType, FilterNodesOptions, MatcherCallback, NavModeEnum, NodeFilterCallback, NodeStatusType, NodeStringCallback, NodeToDictCallback, NodeTypeDefinitionMap, NodeVisitCallback, RenderFlag, ScrollToOptions, SetActiveOptions, SetColumnOptions, SetStatusOptions, SortByPropertyOptions, SortCallback, SourceType, UpdateOptions, VisitRowsOptions, WbEventInfo, WbNodeData } from "types";
+    import { AddChildrenOptions, ApplyCommandOptions, ApplyCommandType, ChangeType, ColumnDefinitionList, DynamicBoolOption, DynamicCheckboxOption, DynamicIconOption, DynamicStringOption, DynamicTooltipOption, ExpandAllOptions, FilterModeType, FilterNodesOptions, IconMapType, GetStateOptions, MatcherCallback, NavigationType, NavModeEnum, NodeFilterCallback, NodeStatusType, NodeStringCallback, NodeToDictCallback, NodeTypeDefinitionMap, NodeVisitCallback, RenderFlag, ScrollToOptions, SetActiveOptions, SetColumnOptions, SetStateOptions, SetStatusOptions, SortByPropertyOptions, SortCallback, SourceType, TreeStateDefinition, UpdateOptions, VisitRowsOptions, WbEventInfo, WbNodeData } from "types";
     import { WunderbaumNode } from "wb_node";
     import { WunderbaumOptions } from "wb_options";
     import { DebouncedFunction } from "debounce";
@@ -2770,11 +2907,11 @@ declare module "wunderbaum" {
         protected _activeNode: WunderbaumNode | null;
         protected _focusNode: WunderbaumNode | null;
         /** Currently active node if any.
-         * Use @link {WunderbaumNode.setActive|setActive} to modify.
+         * Use {@link WunderbaumNode.setActive|setActive} to modify.
          */
         get activeNode(): WunderbaumNode;
         /** Current node hat has keyboard focus if any.
-         * Use @link {WunderbaumNode.setFocus|setFocus()} to modify.
+         * Use {@link WunderbaumNode.setFocus|setFocus()} to modify.
          */
         get focusNode(): WunderbaumNode;
         /** Shared properties, referenced by `node.type`. */
@@ -2803,6 +2940,8 @@ declare module "wunderbaum" {
         /** Expose some useful methods of the util.ts module as `tree._util`. */
         _util: typeof util;
         /** Filter options (used as defaults for calls to {@link Wunderbaum.filterNodes} ) */
+        breadcrumb: HTMLElement | null;
+        /** Filter options (used as defaults for calls to {@link Wunderbaum.filterNodes} ) */
         filterMode: FilterModeType;
         /** @internal Use `setColumn()`/`getActiveColElem()` to access. */
         activeColIdx: number;
@@ -2829,9 +2968,7 @@ declare module "wunderbaum" {
         /**
          * Return the icon-function -> icon-definition mapping.
          */
-        get iconMap(): {
-            [key: string]: string;
-        };
+        get iconMap(): IconMapType;
         /**
          * Return a WunderbaumNode instance from element or event.
          */
@@ -2878,14 +3015,19 @@ declare module "wunderbaum" {
         _callEvent(type: string, extra?: any): any;
         /** Return the node for  given row index. */
         protected _getNodeByRowIdx(idx: number): WunderbaumNode | null;
-        /** Return the topmost visible node in the viewport. */
+        /** Return the topmost visible node in the viewport.
+         * @param complete If `false`, the node is considered visible if at least one
+         * pixel is visible.
+         */
         getTopmostVpNode(complete?: boolean): WunderbaumNode;
         /** Return the lowest visible node in the viewport. */
         getLowestVpNode(complete?: boolean): WunderbaumNode;
-        /** Return preceeding visible node in the viewport. */
-        protected _getPrevNodeInView(node?: WunderbaumNode, ofs?: number): WunderbaumNode;
         /** Return following visible node in the viewport. */
-        protected _getNextNodeInView(node?: WunderbaumNode, ofs?: number): WunderbaumNode;
+        protected _getNextNodeInView(node?: WunderbaumNode, options?: {
+            ofs?: number;
+            reverse?: boolean;
+            cb?: (n: WunderbaumNode) => boolean;
+        }): WunderbaumNode;
         /**
          * Append (or insert) a list of toplevel nodes.
          *
@@ -2959,6 +3101,9 @@ declare module "wunderbaum" {
          * @param visible if true, nodes that are hidden due to collapsed parents are ignored.
          */
         count(visible?: boolean): number;
+        /** Return the number of *unique* nodes in the data model, i.e. unique `node.refKey`.
+         */
+        countUnique(): number;
         /** @internal sanity check. */
         _check(): void;
         /**
@@ -2999,7 +3144,7 @@ declare module "wunderbaum" {
          * and wrap-around at the end.
          * Used by quicksearch and keyboard navigation.
          */
-        findNextNode(match: string | MatcherCallback, startNode?: WunderbaumNode | null): WunderbaumNode | null;
+        findNextNode(match: string | MatcherCallback, startNode?: WunderbaumNode | null, reverse?: boolean): WunderbaumNode | null;
         /**
          * Find a node relative to another node.
          *
@@ -3009,7 +3154,7 @@ declare module "wunderbaum" {
          *   e.g. `$.ui.keyCode.LEFT` = 'left'.
          * @param includeHidden Not yet implemented
          */
-        findRelatedNode(node: WunderbaumNode, where: string, includeHidden?: boolean): any;
+        findRelatedNode(node: WunderbaumNode, where: NavigationType, includeHidden?: boolean): any;
         /**
          * Iterator version of {@link Wunderbaum.format}.
          */
@@ -3053,6 +3198,10 @@ declare module "wunderbaum" {
          * Return the first top level node if any (not the invisible root node).
          */
         getFirstChild(): WunderbaumNode;
+        /**
+         * Return the last top level node if any (not the invisible root node).
+         */
+        getLastChild(): WunderbaumNode;
         /**
          * Return the node that currently has keyboard focus or null.
          * Alias for {@link Wunderbaum.focusNode}.
@@ -3138,6 +3287,10 @@ declare module "wunderbaum" {
         /** Set or remove keyboard focus to the tree container. */
         setFocus(flag?: boolean): void;
         _setFocusNode(node: WunderbaumNode | null): void;
+        /** Return the current selection/expansion/activation status. @experimental */
+        getState(options: GetStateOptions): TreeStateDefinition;
+        /** Apply selection/expansion/activation status. @experimental */
+        setState(state: TreeStateDefinition, options: SetStateOptions): void;
         /**
          * Schedule an update request to reflect a tree change.
          * The render operation is async and debounced unless the `immediate` option
@@ -3198,7 +3351,6 @@ declare module "wunderbaum" {
          * Return true if at least one column width changed.
          */
         _updateColumnWidths(): boolean;
-        protected _insertIcon(icon: string, elem: HTMLElement): void;
         /** Create/update header markup from `this.columns` definition.
          * @internal
          */
@@ -3214,6 +3366,9 @@ declare module "wunderbaum" {
          * pending async changes if any.
          */
         updatePendingModifications(): void;
+        /** @internal */
+        _createNodeIcon(node: WunderbaumNode, showLoading: boolean, showBadge: boolean): HTMLElement | null;
+        private _updateTopBreadcrumb;
         /**
          * This is the actual update method, which is wrapped inside a throttle method.
          * It calls `updateColumns()` and `_updateRows()`.