@truenas/ui-components 0.3.24 → 0.3.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truenas/ui-components",
-  "version": "0.3.24",
+  "version": "0.3.25",
   "publishConfig": {
     "registry": "https://registry.npmjs.org",
     "access": "public"

package/types/truenas-ui-components.d.ts

@@ -6515,7 +6515,7 @@ declare class TnTreeFlattener<T, F> {
  * (and call `filter(query)`) and/or `sortComparer`. Both are opt-in; when unset
  * the datasource behaves exactly as before.
  */
-declare class TnTreeFlatDataSource<T, F> extends DataSource<F> {
+declare class TnTreeFlatDataSource<T, F, K = F> extends DataSource<F> {
     private _treeControl;
     private _treeFlattener;
     /** When set, `filter(query)` re-renders the tree from `filterPredicate(data, query)`. */
@@ -6528,17 +6528,23 @@ declare class TnTreeFlatDataSource<T, F> extends DataSource<F> {
     private _filteredData;
     private filterValue;
     private readonly filterChanged$;
-    private readonly disconnect$;
-    constructor(_treeControl: TnTreeExpansion<F>, _treeFlattener: TnTreeFlattener<T, F>);
+    constructor(_treeControl: TnTreeExpansion<F, K>, _treeFlattener: TnTreeFlattener<T, F>);
     get data(): T[];
     set data(value: T[]);
-    /** The currently filtered (unflattened) data; equals `data` until `filter()` is used. */
+    /** The currently filtered (unflattened) data; equals `data` while no filter query is active. */
     get filteredData(): T[];
     connect(): Observable<F[]>;
     disconnect(): void;
     /** Filters the tree using `filterPredicate` (debounced). No-op until `filterPredicate` is set. */
     filter(query: string): void;
     private flattenData;
+    /**
+     * Deliberately NOT torn down in `disconnect()`: CdkTree disconnects the
+     * datasource when the tree is destroyed, but the same instance may be
+     * reconnected (e.g. a tree behind an `@if`), and filtering must survive that.
+     * The pipeline only references the datasource's own subjects, so it holds no
+     * external resources and is collected with the instance.
+     */
     private detectFilterChanges;
     private _getExpandedNodesWithLevel;
 }
@@ -6571,6 +6577,10 @@ declare class TnNestedTreeNodeComponent<T, K = T> extends CdkNestedTreeNode<T, K
     /**
      * Suppresses the built-in toggle button (and its alignment spacer) so the
      * consumer can render a fully custom toggle in the projected content.
+     *
+     * The built-in button is the only keyboard/AT-operable expand control this
+     * component guarantees — when hiding it, the projected replacement must be
+     * an accessible control (a real button with an aria-label, not a bare icon).
      */
     readonly hideToggle: _angular_core.InputSignalWithTransform<boolean, unknown>;
     private readonly changeDetectorRef;
@@ -6619,13 +6629,20 @@ declare class TnNestedTreeDataSource<T extends {
 }> extends DataSource<T> {
     /** When set, `filter(query)` re-renders the tree from `filterPredicate(data, query)`. */
     filterPredicate?: (data: T[], query: string) => T[];
-    /** When set, incoming `data` is sorted recursively before rendering. */
+    /**
+     * When set, incoming `data` is sorted recursively before rendering.
+     *
+     * Note: sorting REWRITES `children` arrays on the caller's node objects
+     * (a new sorted array is assigned per node). Node object identity is
+     * preserved — deliberately, since tree controls track expansion state by
+     * node identity — but don't pass an object graph that is shared with code
+     * relying on the original child order.
+     */
     sortComparer?: (a: T, b: T) => number;
     private filterValue;
     private readonly filterChanged$;
     private readonly _data;
     private readonly _filteredData;
-    private readonly disconnect$;
     get data(): T[];
     set data(value: T[]);
     constructor(initialData?: T[]);
@@ -6633,6 +6650,13 @@ declare class TnNestedTreeDataSource<T extends {
     disconnect(): void;
     /** Filters the tree using `filterPredicate` (debounced). No-op until `filterPredicate` is set. */
     filter(query: string): void;
+    /**
+     * Deliberately NOT torn down in `disconnect()`: CdkTree disconnects the
+     * datasource when the tree is destroyed, but the same instance may be
+     * reconnected (e.g. a tree behind an `@if`), and filtering must survive that.
+     * The pipeline only references the datasource's own subjects, so it holds no
+     * external resources and is collected with the instance.
+     */
     private detectFilterChanges;
     private sort;
 }
@@ -6777,6 +6801,10 @@ declare class TnTreeNodeHarness extends ComponentHarness {
     /**
      * Toggles the node together with all of its descendants (Alt+click on the
      * built-in nested-node toggle).
+     *
+     * Only nested nodes honor the Alt modifier — on a flat node the row's
+     * `cdkTreeNodeToggle` is not Alt-aware, so this degrades to a plain
+     * single-level toggle.
      */
     toggleWithDescendants(): Promise<void>;
     /**