@daffodil/design 0.91.0 → 0.92.3-rc.1

package/tree/index.d.ts

@@ -1,41 +1,8 @@
-import * as i0 from '@angular/core';
-import { OnDestroy, OnInit, OnChanges, TemplateRef, SimpleChanges } from '@angular/core';
+import * as _angular_core from '@angular/core';
+import { TemplateRef } from '@angular/core';
 import * as i1$1 from '@angular/common';
-import * as rxjs from 'rxjs';
 import * as i1 from '@daffodil/design';
 
-/**
- * This service is used by tree items to notify their parent
- * that the tree has to be recomputed.
- *
- * This service is a multiton associated with each tree instance.
- * It follows the same lifecycle as the tree it is associated with.
- */
-declare class DaffTreeNotifierService implements OnDestroy {
-    /**
-     * @docs-private
-     */
-    private _notice;
-    /**
-     * An observable that emits when the tree needs to be re-computed.
-     */
-    notice$: rxjs.Observable<boolean>;
-    /**
-     * `notify` can be called to trigger a re-computation of the tree
-     * if data has changed unexpectedly and a re-render did not occur.
-     *
-     * This should be used sparingly. Instead, prefer updating `data` on the tree
-     * itself for performance reasons.
-     */
-    notify(): void;
-    /**
-     * Cleanup when the tree is destroyed.
-     *
-     * @docs-private
-     */
-    ngOnDestroy(): void;
-}
-
 /**
  * A basic tree type supporting supplemental data on a tree node.
  *
@@ -65,13 +32,6 @@ interface DaffTreeData<T> {
     data: T;
 }
 
-/**
- * Represents the mode of rendering for nodes in a tree UI.
- * - `in-dom`: Closed nodes are present in the Document Object Model (DOM).
- * - `not-in-dom`: Closed nodes are not present in the Document Object Model (DOM).
- */
-type DaffTreeRenderMode = 'in-dom' | 'not-in-dom';
-
 /**
  * A DaffTreeUi is the internal data structure used during tree rendering.
  *
@@ -98,6 +58,13 @@ interface DaffTreeFlatNode {
     _treeRef: DaffTreeUi<unknown>;
 }
 
+/**
+ * Represents the mode of rendering for nodes in a tree UI.
+ * - `in-dom`: Closed nodes are present in the Document Object Model (DOM).
+ * - `not-in-dom`: Closed nodes are not present in the Document Object Model (DOM).
+ */
+type DaffTreeRenderMode = 'in-dom' | 'not-in-dom';
+
 /**
  * The `DaffTreeComponent` allows you to render tree structures as interactable UI.
  *
@@ -117,7 +84,7 @@ interface DaffTreeFlatNode {
  * where `tree` is a {@link DaffTreeData}.
  *
  */
-declare class DaffTreeComponent implements OnInit, OnChanges {
+declare class DaffTreeComponent {
     private notifier;
     /**
      * The rendering mode for nodes in the tree.
@@ -128,48 +95,48 @@ declare class DaffTreeComponent implements OnInit, OnChanges {
      * but there may be use-cases (like SEO) where having the tree in the DOM
      * is relevant.
      */
-    renderMode: DaffTreeRenderMode;
+    readonly renderMode: _angular_core.InputSignal<DaffTreeRenderMode>;
+    /**
+     * A unique identifier for the tree instance.
+     * Used as a prefix for all node IDs in the tree.
+     * If not provided, an auto-incrementing number is used.
+     */
+    readonly id: _angular_core.InputSignal<string>;
+    /**
+     * The tree data you would like to render.
+     */
+    readonly tree: _angular_core.InputSignal<DaffTreeData<unknown>>;
     /**
      * The internal tree element.
      */
     private _tree;
+    /**
+     * A revision counter incremented by notifications from tree items.
+     * Used to trigger re-flattening when tree item state changes.
+     */
+    readonly _revision: _angular_core.WritableSignal<number>;
     /**
      * @docs-private
      *
      * The flattened tree data. For debugging purposes, you can iterate through this if you want to inspect
      * the resulting array structure we computed to render the tree.
      */
-    flatTree: DaffTreeFlatNode[];
-    /**
-     * The tree data you would like to render.
-     */
-    tree: DaffTreeData<unknown>;
+    readonly flatTree: _angular_core.Signal<DaffTreeFlatNode[]>;
     /**
      * The template used to render tree-nodes that themselves have children.
      *
      * @docs-private
      */
-    withChildrenTemplate: TemplateRef<any>;
+    readonly withChildrenTemplate: _angular_core.Signal<TemplateRef<any>>;
     /**
      * The template used to render tree-nodes that have no children.
      *
      * @docs-private
      */
-    treeItemTemplate: TemplateRef<any>;
-    /**
-     * @docs-private
-     */
-    constructor(notifier: DaffTreeNotifierService);
-    /**
-     * @docs-private
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * @docs-private
-     */
-    ngOnInit(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DaffTreeComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DaffTreeComponent, "ul[daff-tree]", never, { "renderMode": { "alias": "renderMode"; "required": false; }; "tree": { "alias": "tree"; "required": false; }; }, {}, ["withChildrenTemplate", "treeItemTemplate"], never, true, [{ directive: typeof i1.DaffArticleEncapsulatedDirective; inputs: {}; outputs: {}; }]>;
+    readonly treeItemTemplate: _angular_core.Signal<TemplateRef<any>>;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DaffTreeComponent, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<DaffTreeComponent, "ul[daff-tree]", never, { "renderMode": { "alias": "renderMode"; "required": false; "isSignal": true; }; "id": { "alias": "id"; "required": false; "isSignal": true; }; "tree": { "alias": "tree"; "required": false; "isSignal": true; }; }, {}, ["withChildrenTemplate", "treeItemTemplate"], never, true, [{ directive: typeof i1.DaffArticleEncapsulatedDirective; inputs: {}; outputs: {}; }]>;
 }
 
 /**
@@ -195,40 +162,40 @@ declare class DaffTreeComponent implements OnInit, OnChanges {
 declare class DaffTreeItemDirective {
     private document;
     private treeNotifier;
-    private isParent;
     /**
-     * The html `id` of the tree item. This is derived from the {@link DaffTreeData}.
-     *
+     * The {@link DaffTreeFlatNode} associated with this specific tree item.
      */
-    private id;
+    readonly node: _angular_core.InputSignal<DaffTreeFlatNode>;
     /**
-     * Accessibility property, notifying users about whether
-     * or not the tree item is open.
+     * Whether or not the tree item is the currently active item.
+     * Note that there is no requirement that there only be one active item at a time.
+     *
+     * When a tree item becomes selected, all of its ancestor nodes
+     * will be automatically opened so that the selected item is visible.
      */
-    private ariaExpanded;
+    readonly selected: _angular_core.InputSignal<boolean>;
     /**
-     * A property indicating the depth of the tree.
+     * The html `id` of the tree item. This is derived from the {@link DaffTreeData}.
      */
-    private depth;
+    protected readonly id: _angular_core.Signal<string>;
     /**
-     * Indicates whether or not the tree is `open`.
+     * A property indicating the depth of the tree.
      */
-    private open;
+    protected readonly depth: _angular_core.Signal<number>;
     /**
-     * The {@link DaffTreeFlatNode} associated with this specific tree item.
+     * Whether or not this node has children.
      */
-    private _node;
+    protected readonly isParent: _angular_core.Signal<boolean>;
     /**
-     * The {@link DaffTreeFlatNode} associated with this specific tree item.
+     * Indicates whether or not the tree is `open`.
      */
-    get node(): DaffTreeFlatNode;
-    set node(val: DaffTreeFlatNode);
+    protected readonly open: _angular_core.Signal<boolean>;
     /**
-     * Whether or not the tree item is the currently active item.
-     * Note that there is no requirement there there only be one active item at a time.
+     * Accessibility property, notifying users about whether
+     * or not the tree item is open.
      */
-    selected: boolean;
-    constructor(document: any, treeNotifier: DaffTreeNotifierService);
+    protected readonly ariaExpanded: _angular_core.Signal<"true" | "false">;
+    constructor();
     /**
      * @docs-private
      */
@@ -245,17 +212,17 @@ declare class DaffTreeItemDirective {
      * Toggle the open state of this specific subtree tree.
      */
     toggleTree(node: DaffTreeFlatNode): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DaffTreeItemDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<DaffTreeItemDirective, "[daffTreeItem]", never, { "node": { "alias": "node"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DaffTreeItemDirective, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<DaffTreeItemDirective, "[daffTreeItem]", never, { "node": { "alias": "node"; "required": true; "isSignal": true; }; "selected": { "alias": "selected"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
 /**
  * @deprecated in favor of {@link DAFF_TREE_COMPONENTS}. Deprecated in version 0.78.0. Will be removed in version 1.0.0.
  */
 declare class DaffTreeModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<DaffTreeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DaffTreeModule, never, [typeof i1$1.CommonModule, typeof DaffTreeComponent, typeof DaffTreeItemDirective], [typeof DaffTreeComponent, typeof DaffTreeItemDirective]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<DaffTreeModule>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<DaffTreeModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<DaffTreeModule, never, [typeof i1$1.CommonModule, typeof DaffTreeComponent, typeof DaffTreeItemDirective], [typeof DaffTreeComponent, typeof DaffTreeItemDirective]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<DaffTreeModule>;
 }
 
 type RecursiveTreeKeyOfType<T> = keyof {