@difizen/libro-common 0.3.4 → 1.0.0

package/es/app/tree/tree-view-decoration.d.ts

@@ -0,0 +1,286 @@
+export declare const TreeViewDecorationStyles: {
+    CAPTION_HIGHLIGHT_CLASS: string;
+    CAPTION_PREFIX_CLASS: string;
+    CAPTION_SUFFIX_CLASS: string;
+    ICON_WRAPPER_CLASS: string;
+    DECORATOR_SIZE_CLASS: string;
+    DECORATOR_SIDEBAR_SIZE_CLASS: string;
+    TOP_RIGHT_CLASS: string;
+    BOTTOM_RIGHT_CLASS: string;
+    BOTTOM_RIGHT_SIDEBAR_CLASS: string;
+    BOTTOM_LEFT_CLASS: string;
+    TOP_LEFT_CLASS: string;
+};
+/**
+ * Enumeration for the quadrant to overlay the image on.
+ */
+export declare enum IconOverlayPosition {
+    /**
+     * Overlays the top right quarter of the original image.
+     */
+    TOP_RIGHT = 0,
+    /**
+     * Overlays the bottom right of the original image.
+     */
+    BOTTOM_RIGHT = 1,
+    /**
+     * Overlays the bottom left segment of the original image.
+     */
+    BOTTOM_LEFT = 2,
+    /**
+     * Occupies the top left quarter of the original icon.
+     */
+    TOP_LEFT = 3
+}
+export declare namespace IconOverlayPosition {
+    /**
+     * Returns with the CSS class style for the enum.
+     */
+    function getStyle(position: IconOverlayPosition, inSideBar?: boolean): string;
+}
+export declare namespace CaptionHighlight {
+    /**
+     * A pair of offset and length that has to be highlighted as a range.
+     */
+    type Range = {
+        /**
+         * Zero based offset of the highlighted region.
+         */
+        readonly offset: number;
+        /**
+         * The length of the highlighted region.
+         */
+        readonly length: number;
+    };
+    namespace Range {
+        /**
+         * `true` if the `arg` is contained in the range. The ranges are closed ranges, hence the check is inclusive.
+         */
+        function contains(arg: number, range: Range): boolean;
+    }
+    /**
+     * The result of a caption splitting based on the highlighting information.
+     */
+    type Fragment = {
+        /**
+         * The text data of the fragment.
+         */
+        readonly data: string;
+        /**
+         * Has to be highlighted if defined.
+         */
+        readonly highlight?: true;
+    };
+    /**
+     * Splits the `caption` argument based on the ranges from the `highlight` argument.
+     */
+    function split(caption: string, highlight: CaptionHighlight): Fragment[];
+}
+/**
+ * The caption highlighting with the highlighted ranges and an optional background color.
+ */
+export type CaptionHighlight = {
+    /**
+     * The ranges to highlight in the caption.
+     */
+    readonly ranges: CaptionHighlight.Range[];
+    /**
+     * The optional color of the text data that is being highlighted. Falls back to the default `mark` color values defined under a widget segment class.
+     */
+    readonly color?: TreeViewDecoration.Color;
+    /**
+     * The optional background color of the text data that is being highlighted.
+     */
+    readonly backgroundColor?: TreeViewDecoration.Color;
+};
+/**
+ * Namespace for the decoration data and the styling refinements for the decorated widgets.
+ */
+export declare namespace TreeViewDecoration {
+    /**
+     * For the sake of simplicity, we have merged the `font-style`, `font-weight`, and the `text-decoration` together.
+     */
+    type FontStyle = 'normal' | 'bold' | 'italic' | 'oblique' | 'underline' | 'line-through';
+    /**
+     * A string that could be:
+     *
+     *  - one of the browser colors, (E.g.: `blue`, `red`, `magenta`),
+     *  - the case insensitive hexadecimal color code, (for instance, `#ee82ee`, `#20B2AA`, `#f09` ), or
+     *  - either the `rgb()` or the `rgba()` functions.
+     *
+     * For more details, see: https://developer.mozilla.org/en-US/docs/Web/CSS/color_value.
+     *
+     * Note, it is highly recommended to use one of the predefined colors of Mana, so the desired color will
+     * look nice with both the `light` and the `dark` theme too.
+     */
+    type Color = string;
+    /**
+     * Encapsulates styling information of the font.
+     */
+    type FontData = {
+        /**
+         * Zero to any font style.
+         */
+        readonly style?: FontStyle | FontStyle[];
+        /**
+         * The color of the font.
+         */
+        readonly color?: Color;
+    };
+    /**
+     * Arbitrary information that has to be shown either before or after the caption as a prefix or a suffix.
+     */
+    type CaptionAffix = {
+        /**
+         * The text content of the prefix or the suffix.
+         */
+        readonly data: string;
+        /**
+         * Font data for customizing the prefix of the suffix.
+         */
+        readonly fontData?: FontData;
+    };
+    type BaseTailDecoration = {
+        /**
+         * Optional tooltip for the tail decoration.
+         */
+        readonly tooltip?: string;
+    };
+    /**
+     * Unlike caption suffixes, tail decorations appears right-aligned after the caption and the caption suffixes (is any).
+     */
+    type TailDecoration = {
+        /**
+         * The text content of the tail decoration.
+         */
+        readonly data: string;
+        /**
+         * Font data for customizing the content.
+         */
+        readonly fontData?: FontData;
+    } & BaseTailDecoration;
+    type TailDecorationIcon = {
+        /**
+         * This should be the name of the Font Awesome icon with out the `fa fa-` prefix, just the name, for instance `paw`.
+         * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/.
+         */
+        readonly icon: string;
+        /**
+         * The color of the icon.
+         */
+        readonly color?: Color;
+    } & BaseTailDecoration;
+    type TailDecorationIconClass = {
+        /**
+         * This should be the entire Font Awesome class array, for instance ['fa', 'fa-paw']
+         * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/.
+         */
+        readonly iconClass: string[];
+        /**
+         * The color of the icon.
+         */
+        readonly color?: Color;
+    } & BaseTailDecoration;
+    /**
+     * A shape that can be optionally rendered behind the overlay icon. Can be used to further refine colors.
+     */
+    type IconOverlayBackground = {
+        /**
+         * Either `circle` or `square`.
+         */
+        readonly shape: 'circle' | 'square';
+        /**
+         * The color of the background shape.
+         */
+        readonly color?: Color;
+    };
+    /**
+     * Has not effect if the widget being decorated has no associated icon.
+     */
+    type BaseOverlay = {
+        /**
+         * The position where the decoration will be placed on the top of the original icon.
+         */
+        readonly position: IconOverlayPosition;
+        /**
+         * The color of the overlaying icon. If not specified, then the default icon color will be used.
+         */
+        readonly color?: Color;
+        /**
+         * The optional background color of the overlay icon.
+         */
+        readonly background?: IconOverlayBackground;
+    };
+    type IconOverlay = {
+        /**
+         * This should be the name of the Font Awesome icon with out the `fa fa-` prefix, just the name, for instance `paw`.
+         * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/.
+         */
+        readonly icon: string;
+    } & BaseOverlay;
+    type IconClassOverlay = {
+        /**
+         * This should be the entire Font Awesome class array, for instance ['fa', 'fa-paw']
+         * For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/.
+         */
+        readonly iconClass: string[];
+    } & BaseOverlay;
+}
+/**
+ * Encapsulates styling information that has to be applied on the widget which we decorate.
+ */
+export type TreeViewDecorationData = {
+    /**
+     * The higher number has higher priority. If not specified, treated as `0`.
+     * When multiple decorators are available for the same item, and decoration data cannot be merged together,
+     * then the higher priority item will be applied on the decorated element and the lower priority will be ignored.
+     */
+    readonly priority?: number;
+    /**
+     * The font data for the caption.
+     */
+    readonly fontData?: TreeViewDecoration.FontData;
+    /**
+     * The background color of the entire row.
+     */
+    readonly backgroundColor?: TreeViewDecoration.Color;
+    /**
+     * Optional, leading prefixes right before the caption.
+     */
+    readonly captionPrefixes?: TreeViewDecoration.CaptionAffix[];
+    /**
+     * Suffixes that might come after the caption as an additional information.
+     */
+    readonly captionSuffixes?: TreeViewDecoration.CaptionAffix[];
+    /**
+     * Optional right-aligned decorations that appear after the widget caption and after the caption suffixes (is any).
+     */
+    readonly tailDecorations?: (TreeViewDecoration.TailDecoration | TreeViewDecoration.TailDecorationIcon | TreeViewDecoration.TailDecorationIconClass)[];
+    /**
+     * Custom tooltip for the decorated item. Tooltip will be appended to the original tooltip, if any.
+     */
+    readonly tooltip?: string;
+    /**
+     * Sets the color of the icon. Ignored if the decorated item has no icon.
+     */
+    readonly iconColor?: TreeViewDecoration.Color;
+    /**
+     * Has not effect if given, but the widget does not have an associated image.
+     */
+    readonly iconOverlay?: TreeViewDecoration.IconOverlay | TreeViewDecoration.IconClassOverlay;
+    /**
+     * An array of ranges to highlight the caption.
+     */
+    readonly highlight?: CaptionHighlight;
+    /**
+     * A count badge for widgets.
+     */
+    readonly badge?: number;
+};
+export declare namespace TreeViewDecorationData {
+    /**
+     * Compares the decoration data based on the priority. Lowest priorities come first.
+     */
+    const comparePriority: (left: TreeViewDecorationData, right: TreeViewDecorationData) => number;
+}
+//# sourceMappingURL=tree-view-decoration.d.ts.map

package/es/app/tree/tree-view-decoration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-view-decoration.d.ts","sourceRoot":"","sources":["../../../src/app/tree/tree-view-decoration.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB;;;;;;;;;;;;CAYpC,CAAC;AACF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,SAAS,IAAA;IACT;;OAEG;IACH,YAAY,IAAA;IACZ;;OAEG;IACH,WAAW,IAAA;IACX;;OAEG;IACH,QAAQ,IAAA;CACT;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,SAAgB,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAenF;CACF;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAY,KAAK,GAAG;QAClB;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB;;WAEG;QACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB,CAAC;IACF,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,SAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAE3D;KACF;IACD;;OAEG;IACH,KAAY,QAAQ,GAAG;QACrB;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,QAAQ,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC;KAC3B,CAAC;IACF;;OAEG;IACH,SAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,gBAAgB,GAAG,QAAQ,EAAE,CA6B9E;CACF;AACD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;CACrD,CAAC;AACF;;GAEG;AACH,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,KAAY,SAAS,GACjB,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,cAAc,CAAC;IACnB;;;;;;;;;;;OAWG;IACH,KAAY,KAAK,GAAG,MAAM,CAAC;IAC3B;;OAEG;IACH,KAAY,QAAQ,GAAG;QACrB;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,SAAS,EAAE,CAAC;QACzC;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,KAAY,YAAY,GAAG;QACzB;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;KAC9B,CAAC;IACF,KAAY,kBAAkB,GAAG;QAC/B;;WAEG;QACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF;;OAEG;IACH,KAAY,cAAc,GAAG;QAC3B;;WAEG;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;KAC9B,GAAG,kBAAkB,CAAC;IACvB,KAAY,kBAAkB,GAAG;QAC/B;;;WAGG;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;KACxB,GAAG,kBAAkB,CAAC;IACvB,KAAY,uBAAuB,GAAG;QACpC;;;WAGG;QACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAC7B;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;KACxB,GAAG,kBAAkB,CAAC;IAEvB;;OAEG;IACH,KAAY,qBAAqB,GAAG;QAClC;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,QAAQ,CAAC;QACpC;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,KAAY,WAAW,GAAG;QACxB;;WAEG;QACH,QAAQ,CAAC,QAAQ,EAAE,mBAAmB,CAAC;QACvC;;WAEG;QACH,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;QACvB;;WAEG;QACH,QAAQ,CAAC,UAAU,CAAC,EAAE,qBAAqB,CAAC;KAC7C,CAAC;IACF,KAAY,WAAW,GAAG;QACxB;;;WAGG;QACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;KACvB,GAAG,WAAW,CAAC;IAChB,KAAY,gBAAgB,GAAG;QAC7B;;;WAGG;QACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;KAC9B,GAAG,WAAW,CAAC;CACjB;AACD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAChD;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;IACpD;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,YAAY,EAAE,CAAC;IAC7D;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,YAAY,EAAE,CAAC;IAC7D;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CACvB,kBAAkB,CAAC,cAAc,GACjC,kBAAkB,CAAC,kBAAkB,GACrC,kBAAkB,CAAC,uBAAuB,CAC7C,EAAE,CAAC;IACJ;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EACjB,kBAAkB,CAAC,WAAW,GAC9B,kBAAkB,CAAC,gBAAgB,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,gBAAgB,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACI,MAAM,eAAe,SACpB,sBAAsB,SACrB,sBAAsB,KAC5B,MAAsD,CAAC;CAC3D"}

package/es/app/tree/tree-view-decoration.js

@@ -0,0 +1,127 @@
+export var TreeViewDecorationStyles = {
+  CAPTION_HIGHLIGHT_CLASS: 'mana-caption-highlight',
+  CAPTION_PREFIX_CLASS: 'mana-caption-prefix',
+  CAPTION_SUFFIX_CLASS: 'mana-caption-suffix',
+  ICON_WRAPPER_CLASS: 'mana-icon-wrapper',
+  DECORATOR_SIZE_CLASS: 'mana-decorator-size',
+  DECORATOR_SIDEBAR_SIZE_CLASS: 'mana-decorator-sidebar-size',
+  TOP_RIGHT_CLASS: 'mana-top-right',
+  BOTTOM_RIGHT_CLASS: 'mana-bottom-right',
+  BOTTOM_RIGHT_SIDEBAR_CLASS: 'mana-bottom-right-sidebar',
+  BOTTOM_LEFT_CLASS: 'mana-bottom-left',
+  TOP_LEFT_CLASS: 'mana-top-left'
+};
+/**
+ * Enumeration for the quadrant to overlay the image on.
+ */
+export var IconOverlayPosition = /*#__PURE__*/function (IconOverlayPosition) {
+  /**
+   * Overlays the top right quarter of the original image.
+   */
+  IconOverlayPosition[IconOverlayPosition["TOP_RIGHT"] = 0] = "TOP_RIGHT";
+  /**
+   * Overlays the bottom right of the original image.
+   */
+  IconOverlayPosition[IconOverlayPosition["BOTTOM_RIGHT"] = 1] = "BOTTOM_RIGHT";
+  /**
+   * Overlays the bottom left segment of the original image.
+   */
+  IconOverlayPosition[IconOverlayPosition["BOTTOM_LEFT"] = 2] = "BOTTOM_LEFT";
+  /**
+   * Occupies the top left quarter of the original icon.
+   */
+  IconOverlayPosition[IconOverlayPosition["TOP_LEFT"] = 3] = "TOP_LEFT";
+  return IconOverlayPosition;
+}({});
+(function (_IconOverlayPosition) {
+  function getStyle(position, inSideBar) {
+    switch (position) {
+      case IconOverlayPosition.TOP_RIGHT:
+        return TreeViewDecorationStyles.TOP_RIGHT_CLASS;
+      case IconOverlayPosition.BOTTOM_RIGHT:
+        return inSideBar ? TreeViewDecorationStyles.BOTTOM_RIGHT_SIDEBAR_CLASS : TreeViewDecorationStyles.BOTTOM_RIGHT_CLASS;
+      case IconOverlayPosition.BOTTOM_LEFT:
+        return TreeViewDecorationStyles.BOTTOM_LEFT_CLASS;
+      case IconOverlayPosition.TOP_LEFT:
+        return TreeViewDecorationStyles.TOP_LEFT_CLASS;
+      default:
+        return '';
+    }
+  }
+  _IconOverlayPosition.getStyle = getStyle;
+})(IconOverlayPosition || (IconOverlayPosition = {}));
+export var CaptionHighlight;
+(function (_CaptionHighlight) {
+  /**
+   * A pair of offset and length that has to be highlighted as a range.
+   */
+  var Range;
+  (function (_Range) {
+    function contains(arg, range) {
+      return arg >= range.offset && arg <= range.offset + range.length;
+    }
+    _Range.contains = contains;
+  })(Range || (Range = _CaptionHighlight.Range || (_CaptionHighlight.Range = {})));
+  /**
+   * The result of a caption splitting based on the highlighting information.
+   */
+  /**
+   * Splits the `caption` argument based on the ranges from the `highlight` argument.
+   */
+  function split(caption, highlight) {
+    var result = [];
+    var ranges = highlight.ranges.slice();
+    var containerOf = function containerOf(index) {
+      return ranges.findIndex(function (range) {
+        return Range.contains(index, range);
+      });
+    };
+    var data = '';
+    for (var i = 0; i < caption.length; i += 1) {
+      var containerIndex = containerOf(i);
+      if (containerIndex === -1) {
+        data += caption[i];
+      } else {
+        if (data.length > 0) {
+          result.push({
+            data: data
+          });
+        }
+        var _ref = ranges.splice(containerIndex, 1).shift(),
+          length = _ref.length;
+        result.push({
+          data: caption.substr(i, length),
+          highlight: true
+        });
+        data = '';
+        i = i + length - 1;
+      }
+    }
+    if (data.length > 0) {
+      result.push({
+        data: data
+      });
+    }
+    if (ranges.length !== 0) {
+      throw new Error('Error occurred when splitting the caption. There was a mismatch between the caption and the corresponding highlighting ranges.');
+    }
+    return result;
+  }
+  _CaptionHighlight.split = split;
+})(CaptionHighlight || (CaptionHighlight = {}));
+/**
+ * The caption highlighting with the highlighted ranges and an optional background color.
+ */
+/**
+ * Namespace for the decoration data and the styling refinements for the decorated widgets.
+ */
+export var TreeViewDecoration;
+/**
+ * Encapsulates styling information that has to be applied on the widget which we decorate.
+ */
+export var TreeViewDecorationData;
+(function (_TreeViewDecorationData) {
+  var comparePriority = _TreeViewDecorationData.comparePriority = function (left, right) {
+    return (left.priority || 0) - (right.priority || 0);
+  };
+})(TreeViewDecorationData || (TreeViewDecorationData = {}));

package/es/app/tree/tree.d.ts

@@ -0,0 +1,166 @@
+/// <reference types="react" />
+import type { Event, Disposable, CancellationToken, WaitUntilEvent } from '../../common/index.js';
+import type { NodeProps, TreeProps } from './tree-protocol.js';
+export declare const Tree: unique symbol;
+/**
+ * The tree - an abstract data type.
+ */
+export type Tree = {
+    /**
+     * A root node of this tree.
+     * Undefined if there is no root node.
+     * Setting a root node refreshes the tree.
+     */
+    root: TreeNode | undefined;
+    /**
+     * Emit when the tree is changed.
+     */
+    readonly onChanged: Event<void>;
+    /**
+     * Return a node for the given identifier or undefined if such does not exist.
+     */
+    getNode: (id: string | undefined) => TreeNode | undefined;
+    /**
+     * Return a valid node in this tree matching to the given; otherwise undefined.
+     */
+    validateNode: (node: TreeNode | undefined) => TreeNode | undefined;
+    /**
+     * Refresh children of the r../../../../examples/application-react/utils.
+     *
+     * Return a valid refreshed composite root or `undefined` if such does not exist.
+     */
+    refresh: (() => Promise<Readonly<CompositeTreeNode> | undefined>) & ((parent: Readonly<CompositeTreeNode>) => Promise<Readonly<CompositeTreeNode> | undefined>);
+    /**
+     * Emit when the children of the given node are refreshed.
+     */
+    readonly onNodeRefreshed: Event<Readonly<CompositeTreeNode> & WaitUntilEvent>;
+    /**
+     * Emits when the busy state of the given node is changed.
+     */
+    readonly onDidChangeBusy: Event<TreeNode>;
+    /**
+     * Marks the give node as busy after a specified number of milliseconds.
+     * A token source of the given token should be canceled to unmark.
+     */
+    markAsBusy: (node: Readonly<TreeNode>, ms: number, token: CancellationToken) => Promise<void>;
+} & Disposable;
+/**
+ * The tree node.
+ */
+export type TreeNode = {
+    /**
+     * An unique id of this node.
+     */
+    readonly id: string;
+    readonly icon?: string;
+    readonly description?: string;
+    /**
+     * Test whether this node should be rendered.
+     * If undefined then node will be rendered.
+     */
+    readonly visible?: boolean;
+    /**
+     * A parent node of this tree node.
+     * Undefined if this node is root.
+     */
+    readonly parent: Readonly<CompositeTreeNode> | undefined;
+    /**
+     * A previous sibling of this tree node.
+     */
+    readonly previousSibling?: TreeNode;
+    /**
+     * A next sibling of this tree node.
+     */
+    readonly nextSibling?: TreeNode;
+    /**
+     * Whether this node is busy. Greater than 0 then busy; otherwise not.
+     */
+    readonly busy?: number;
+    readonly name?: string;
+};
+export declare namespace TreeNode {
+    function is(node: Record<any, any> | undefined): node is TreeNode;
+    function equals(left: TreeNode | undefined, right: TreeNode | undefined): boolean;
+    function isVisible(node: TreeNode | undefined): boolean;
+}
+/**
+ * The composite tree node.
+ */
+export type CompositeTreeNode = {
+    /**
+     * Child nodes of this tree node.
+     */
+    children: readonly TreeNode[];
+} & TreeNode;
+export declare namespace CompositeTreeNode {
+    function is(node: Record<any, any> | undefined): node is CompositeTreeNode;
+    function getFirstChild(parent: CompositeTreeNode): TreeNode | undefined;
+    function getLastChild(parent: CompositeTreeNode): TreeNode | undefined;
+    function isAncestor(parent: CompositeTreeNode, child: TreeNode | undefined): boolean;
+    function indexOf(parent: CompositeTreeNode, node: TreeNode | undefined): number;
+    function addChildren(parent: CompositeTreeNode, children: TreeNode[]): CompositeTreeNode;
+    function addChild(parent: CompositeTreeNode, child: TreeNode): CompositeTreeNode;
+    function removeChild(parent: CompositeTreeNode, child: TreeNode): void;
+    function setParent(child: TreeNode, index: number, parent: CompositeTreeNode): void;
+}
+/**
+ * Representation of a tree node row.
+ */
+export type NodeRow = {
+    /**
+     * The node row index.
+     */
+    index: number;
+    /**
+     * The actual node.
+     */
+    node: TreeNode;
+    /**
+     * A root relative number representing the hierarchical depth of the actual node. Root is `0`, its children have `1` and so on.
+     */
+    depth: number;
+};
+export interface TreeNodeProps {
+    node: TreeNode;
+    nodeProps: NodeProps;
+}
+export interface TreeNodeCaptionAffixesProps extends TreeNodeProps {
+    affixKey: 'captionPrefixes' | 'captionSuffixes';
+}
+export interface TreeNodeIconDecoratorProps extends TreeNodeProps {
+    icon: React.ReactNode;
+}
+export interface TreeNodeComponents {
+    TreeNodeExpansion: React.FC<TreeNodeProps>;
+    TreeNode: React.FC<TreeNodeProps>;
+    TreeNodeIcon: React.FC<TreeNodeProps>;
+    TreeNodeCaption: React.FC<TreeNodeProps>;
+    TreeNodeCaptionAffixes: React.FC<TreeNodeCaptionAffixesProps>;
+    TreeNodeTailDecorations: React.FC<TreeNodeProps>;
+    TreeNodeIconDecorator: React.FC<TreeNodeIconDecoratorProps>;
+    TreeIdent: React.FC<TreeNodeProps>;
+    TreeSwitchIcon: React.FC<TreeNodeProps>;
+}
+export declare const TreeNodeComponents: unique symbol;
+/**
+ * Bare minimum common interface of the keyboard and the mouse event with respect to the key maskings.
+ */
+export type ModifierAwareEvent = {
+    /**
+     * Determines if the modifier aware event has the `meta` key masking.
+     */
+    readonly metaKey: boolean;
+    /**
+     * Determines if the modifier aware event has the `ctrl` key masking.
+     */
+    readonly ctrlKey: boolean;
+    /**
+     * Determines if the modifier aware event has the `shift` key masking.
+     */
+    readonly shiftKey: boolean;
+};
+/**
+ * The default tree properties.
+ */
+export declare const DefaultTreeProps: TreeProps;
+//# sourceMappingURL=tree.d.ts.map

package/es/app/tree/tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.d.ts","sourceRoot":"","sources":["../../../src/app/tree/tree.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,KAAK,EACL,UAAU,EACV,iBAAiB,EACjB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAE/B,OAAO,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/D,eAAO,MAAM,IAAI,eAAiB,CAAC;AAEnC;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;;;OAIG;IACH,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAChC;;OAEG;IACH,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,KAAK,QAAQ,GAAG,SAAS,CAAC;IAC1D;;OAEG;IACH,YAAY,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,KAAK,QAAQ,GAAG,SAAS,CAAC;IACnE;;;;OAIG;IACH,OAAO,EAAE,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,CAAC,GAC/D,CAAC,CACC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,KAChC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IACzD;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,cAAc,CAAC,CAAC;IAC9E;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1C;;;OAGG;IACH,UAAU,EAAE,CACV,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,EACxB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,iBAAiB,KACrB,OAAO,CAAC,IAAI,CAAC,CAAC;CACpB,GAAG,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;IACzD;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,yBAAiB,QAAQ,CAAC;IACxB,SAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,IAAI,IAAI,QAAQ,CAEvE;IAED,SAAgB,MAAM,CACpB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAET;IAED,SAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAE7D;CACF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,QAAQ,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC/B,GAAG,QAAQ,CAAC;AAEb,yBAAiB,iBAAiB,CAAC;IACjC,SAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,GAAG,IAAI,IAAI,iBAAiB,CAEhF;IAED,SAAgB,aAAa,CAAC,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,CAE7E;IAED,SAAgB,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,QAAQ,GAAG,SAAS,CAE5E;IAED,SAAgB,UAAU,CACxB,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAQT;IAED,SAAgB,OAAO,CACrB,MAAM,EAAE,iBAAiB,EACzB,IAAI,EAAE,QAAQ,GAAG,SAAS,GACzB,MAAM,CAKR;IAED,SAAgB,WAAW,CACzB,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,QAAQ,EAAE,GACnB,iBAAiB,CAKnB;IAED,SAAgB,QAAQ,CACtB,MAAM,EAAE,iBAAiB,EACzB,KAAK,EAAE,QAAQ,GACd,iBAAiB,CAWnB;IAED,SAAgB,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI,CAc5E;IAED,SAAgB,SAAS,CACvB,KAAK,EAAE,QAAQ,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,iBAAiB,GACxB,IAAI,CAUN;CACF;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,QAAQ,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE,QAAQ,EAAE,iBAAiB,GAAG,iBAAiB,CAAC;CACjD;AAED,MAAM,WAAW,0BAA2B,SAAQ,aAAa;IAC/D,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IAC3C,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IAClC,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACtC,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACzC,sBAAsB,EAAE,KAAK,CAAC,EAAE,CAAC,2BAA2B,CAAC,CAAC;IAC9D,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACjD,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,0BAA0B,CAAC,CAAC;IAC5D,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;IACnC,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC;CACzC;AACD,eAAO,MAAM,kBAAkB,eAA+B,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAG9B,CAAC"}