@depup/angular__material 21.2.2-depup.19

package/types/tree-testing.d.ts

@@ -0,0 +1,119 @@
+import * as _angular_cdk_testing from '@angular/cdk/testing';
+import { BaseHarnessFilters, ContentContainerComponentHarness, HarnessPredicate, ComponentHarness } from '@angular/cdk/testing';
+
+/** A set of criteria that can be used to filter a list of tree harness instances */
+interface TreeHarnessFilters extends BaseHarnessFilters {
+}
+/** A set of criteria that can be used to filter a list of node harness instances. */
+interface TreeNodeHarnessFilters extends BaseHarnessFilters {
+    /** Only find instances whose text matches the given value. */
+    text?: string | RegExp;
+    /** Only find instances whose disabled state matches the given value. */
+    disabled?: boolean;
+    /** Only find instances whose expansion state matches the given value. */
+    expanded?: boolean;
+    /** Only find instances whose level matches the given value. */
+    level?: number;
+}
+
+/** Harness for interacting with a standard Angular Material tree node. */
+declare class MatTreeNodeHarness extends ContentContainerComponentHarness<string> {
+    /** The selector of the host element of a `MatTreeNode` instance. */
+    static hostSelector: string;
+    _toggle: () => Promise<_angular_cdk_testing.TestElement | null>;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a tree node with specific attributes.
+     * @param options Options for narrowing the search
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: TreeNodeHarnessFilters): HarnessPredicate<MatTreeNodeHarness>;
+    /** Whether the tree node is expanded. */
+    isExpanded(): Promise<boolean>;
+    /** Whether the tree node is expandable. */
+    isExpandable(): Promise<boolean>;
+    /** Whether the tree node is disabled. */
+    isDisabled(): Promise<boolean>;
+    /** Gets the level of the tree node. Note that this gets the aria-level and is 1 indexed. */
+    getLevel(): Promise<number>;
+    /** Gets the tree node's text. */
+    getText(): Promise<string>;
+    /** Toggles node between expanded/collapsed. Only works when node is not disabled. */
+    toggle(): Promise<void>;
+    /** Expands the node if it is collapsed. Only works when node is not disabled. */
+    expand(): Promise<void>;
+    /** Collapses the node if it is expanded. Only works when node is not disabled. */
+    collapse(): Promise<void>;
+}
+
+type TextTree = {
+    text?: string;
+    children?: TextTree[];
+};
+/** Harness for interacting with a standard mat-tree in tests. */
+declare class MatTreeHarness extends ComponentHarness {
+    /** The selector for the host element of a `MatTableHarness` instance. */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a tree with specific attributes.
+     * @param options Options for narrowing the search
+     * @return a `HarnessPredicate` configured with the given options.
+     */
+    static with(options?: TreeHarnessFilters): HarnessPredicate<MatTreeHarness>;
+    /** Gets all of the nodes in the tree. */
+    getNodes(filter?: TreeNodeHarnessFilters): Promise<MatTreeNodeHarness[]>;
+    /**
+     * Gets an object representation for the visible tree structure
+     * If a node is under an unexpanded node it will not be included.
+     * Eg.
+     * Tree (all nodes expanded):
+     * `
+     * <mat-tree>
+     *   <mat-tree-node>Node 1<mat-tree-node>
+     *   <mat-nested-tree-node>
+     *     Node 2
+     *     <mat-nested-tree-node>
+     *       Node 2.1
+     *       <mat-tree-node>
+     *         Node 2.1.1
+     *       <mat-tree-node>
+     *     <mat-nested-tree-node>
+     *     <mat-tree-node>
+     *       Node 2.2
+     *     <mat-tree-node>
+     *   <mat-nested-tree-node>
+     * </mat-tree>`
+     *
+     * Tree structure:
+     * {
+     *  children: [
+     *    {
+     *      text: 'Node 1',
+     *      children: [
+     *        {
+     *          text: 'Node 2',
+     *          children: [
+     *            {
+     *              text: 'Node 2.1',
+     *              children: [{text: 'Node 2.1.1'}]
+     *            },
+     *            {text: 'Node 2.2'}
+     *          ]
+     *        }
+     *      ]
+     *    }
+     *  ]
+     * };
+     */
+    getTreeStructure(): Promise<TextTree>;
+    /**
+     * Recursively collect the structured text of the tree nodes.
+     * @param nodes A list of tree nodes
+     * @param level The level of nodes that are being accounted for during this iteration
+     * @param parentExpanded Whether the parent of the first node in param nodes is expanded
+     */
+    private _getTreeStructure;
+    private _addChildToNode;
+}
+
+export { MatTreeHarness, MatTreeNodeHarness };
+export type { TextTree, TreeHarnessFilters, TreeNodeHarnessFilters };

package/types/tree.d.ts

@@ -0,0 +1,233 @@
+import * as i1 from '@angular/cdk/tree';
+import { CdkTreeNode, CdkTreeNodeDef, CdkNestedTreeNode, CdkTreeNodePadding, CdkTreeNodeOutlet, CdkTree, CdkTreeNodeToggle, TreeControl, FlatTreeControl } from '@angular/cdk/tree';
+import * as i0 from '@angular/core';
+import { OnInit, OnDestroy, AfterContentInit, ViewContainerRef } from '@angular/core';
+import * as i2 from '@angular/cdk/bidi';
+import { DataSource, CollectionViewer } from '@angular/cdk/collections';
+import { Observable } from 'rxjs';
+
+/**
+ * Wrapper for the CdkTree node with Material design styles.
+ */
+declare class MatTreeNode<T, K = T> extends CdkTreeNode<T, K> implements OnInit, OnDestroy {
+    /**
+     * The tabindex of the tree node.
+     *
+     * @deprecated By default MatTreeNode manages focus using TreeKeyManager instead of tabIndex.
+     *   Recommend to avoid setting tabIndex directly to prevent TreeKeyManager form getting into
+     *   an unexpected state. Tabindex to be removed in a future version.
+     * @breaking-change 21.0.0 Remove this attribute.
+     */
+    get tabIndexInputBinding(): number;
+    set tabIndexInputBinding(value: number);
+    private _tabIndexInputBinding;
+    /**
+     * The default tabindex of the tree node.
+     *
+     * @deprecated By default MatTreeNode manages focus using TreeKeyManager instead of tabIndex.
+     *   Recommend to avoid setting tabIndex directly to prevent TreeKeyManager form getting into
+     *   an unexpected state. Tabindex to be removed in a future version.
+     * @breaking-change 21.0.0 Remove this attribute.
+     */
+    defaultTabIndex: number;
+    protected _getTabindexAttribute(): number | null;
+    /**
+     * Whether the component is disabled.
+     *
+     * @deprecated This is an alias for `isDisabled`.
+     * @breaking-change 21.0.0 Remove this input
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    constructor(...args: unknown[]);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeNode<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTreeNode<any, any>, "mat-tree-node", ["matTreeNode"], { "tabIndexInputBinding": { "alias": "tabIndex"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; }, { "activation": "activation"; "expandedChange": "expandedChange"; }, never, never, true, never>;
+    static ngAcceptInputType_tabIndexInputBinding: unknown;
+    static ngAcceptInputType_disabled: unknown;
+}
+/**
+ * Wrapper for the CdkTree node definition with Material design styles.
+ * Captures the node's template and a when predicate that describes when this node should be used.
+ */
+declare class MatTreeNodeDef<T> extends CdkTreeNodeDef<T> {
+    data: T;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeNodeDef<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTreeNodeDef<any>, "[matTreeNodeDef]", never, { "when": { "alias": "matTreeNodeDefWhen"; "required": false; }; "data": { "alias": "matTreeNode"; "required": false; }; }, {}, never, never, true, never>;
+}
+/**
+ * Wrapper for the CdkTree nested node with Material design styles.
+ */
+declare class MatNestedTreeNode<T, K = T> extends CdkNestedTreeNode<T, K> implements AfterContentInit, OnDestroy, OnInit {
+    node: T;
+    /**
+     * Whether the node is disabled.
+     *
+     * @deprecated This is an alias for `isDisabled`.
+     * @breaking-change 21.0.0 Remove this input
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    /** Tabindex of the node. */
+    get tabIndex(): number;
+    set tabIndex(value: number);
+    private _tabIndex;
+    ngOnInit(): void;
+    ngAfterContentInit(): void;
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatNestedTreeNode<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatNestedTreeNode<any, any>, "mat-nested-tree-node", ["matNestedTreeNode"], { "node": { "alias": "matNestedTreeNode"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; }, { "activation": "activation"; "expandedChange": "expandedChange"; }, never, never, true, never>;
+    static ngAcceptInputType_disabled: unknown;
+    static ngAcceptInputType_tabIndex: unknown;
+}
+
+/**
+ * Wrapper for the CdkTree padding with Material design styles.
+ */
+declare class MatTreeNodePadding<T, K = T> extends CdkTreeNodePadding<T, K> {
+    /** The level of depth of the tree node. The padding will be `level * indent` pixels. */
+    get level(): number;
+    set level(value: number);
+    /** The indent for each level. Default number 40px from material design menu sub-menu spec. */
+    get indent(): number | string;
+    set indent(indent: number | string);
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeNodePadding<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTreeNodePadding<any, any>, "[matTreeNodePadding]", never, { "level": { "alias": "matTreeNodePadding"; "required": false; }; "indent": { "alias": "matTreeNodePaddingIndent"; "required": false; }; }, {}, never, never, true, never>;
+    static ngAcceptInputType_level: unknown;
+}
+
+/**
+ * Outlet for nested CdkNode. Put `[matTreeNodeOutlet]` on a tag to place children dataNodes
+ * inside the outlet.
+ */
+declare class MatTreeNodeOutlet implements CdkTreeNodeOutlet {
+    viewContainer: ViewContainerRef;
+    _node: {} | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeNodeOutlet, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTreeNodeOutlet, "[matTreeNodeOutlet]", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Wrapper for the CdkTable with Material design styles.
+ */
+declare class MatTree<T, K = T> extends CdkTree<T, K> {
+    _nodeOutlet: MatTreeNodeOutlet;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTree<any, any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MatTree<any, any>, "mat-tree", ["matTree"], {}, {}, never, never, true, never>;
+}
+
+/**
+ * Wrapper for the CdkTree's toggle with Material design styles.
+ */
+declare class MatTreeNodeToggle<T, K = T> extends CdkTreeNodeToggle<T, K> {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeNodeToggle<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTreeNodeToggle<any, any>, "[matTreeNodeToggle]", never, { "recursive": { "alias": "matTreeNodeToggleRecursive"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+declare class MatTreeModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatTreeModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<MatTreeModule, never, [typeof i1.CdkTreeModule, typeof MatNestedTreeNode, typeof MatTreeNodeDef, typeof MatTreeNodePadding, typeof MatTreeNodeToggle, typeof MatTree, typeof MatTreeNode, typeof MatTreeNodeOutlet], [typeof i2.BidiModule, typeof MatNestedTreeNode, typeof MatTreeNodeDef, typeof MatTreeNodePadding, typeof MatTreeNodeToggle, typeof MatTree, typeof MatTreeNode, typeof MatTreeNodeOutlet]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<MatTreeModule>;
+}
+
+/**
+ * Tree flattener to convert a normal type of node to node with children & level information.
+ * Transform nested nodes of type `T` to flattened nodes of type `F`.
+ *
+ * For example, the input data of type `T` is nested, and contains its children data:
+ *   SomeNode: {
+ *     key: 'Fruits',
+ *     children: [
+ *       NodeOne: {
+ *         key: 'Apple',
+ *       },
+ *       NodeTwo: {
+ *        key: 'Pear',
+ *      }
+ *    ]
+ *  }
+ *  After flattener flatten the tree, the structure will become
+ *  SomeNode: {
+ *    key: 'Fruits',
+ *    expandable: true,
+ *    level: 1
+ *  },
+ *  NodeOne: {
+ *    key: 'Apple',
+ *    expandable: false,
+ *    level: 2
+ *  },
+ *  NodeTwo: {
+ *   key: 'Pear',
+ *   expandable: false,
+ *   level: 2
+ * }
+ * and the output flattened type is `F` with additional information.
+ *
+ * @deprecated Use MatTree#childrenAccessor and MatTreeNode#isExpandable
+ * instead. To be removed in a future version.
+ * @breaking-change 21.0.0
+ */
+declare class MatTreeFlattener<T, F, K = F> {
+    transformFunction: (node: T, level: number) => F;
+    getLevel: (node: F) => number;
+    isExpandable: (node: F) => boolean;
+    getChildren: (node: T) => Observable<T[]> | T[] | undefined | null;
+    constructor(transformFunction: (node: T, level: number) => F, getLevel: (node: F) => number, isExpandable: (node: F) => boolean, getChildren: (node: T) => Observable<T[]> | T[] | undefined | null);
+    _flattenNode(node: T, level: number, resultNodes: F[], parentMap: boolean[]): F[];
+    _flattenChildren(children: T[], level: number, resultNodes: F[], parentMap: boolean[]): void;
+    /**
+     * Flatten a list of node type T to flattened version of node F.
+     * Please note that type T may be nested, and the length of `structuredData` may be different
+     * from that of returned list `F[]`.
+     */
+    flattenNodes(structuredData: T[]): F[];
+    /**
+     * Expand flattened node with current expansion status.
+     * The returned list may have different length.
+     */
+    expandFlattenedNodes(nodes: F[], treeControl: TreeControl<F, K>): F[];
+}
+/**
+ * Data source for flat tree.
+ * The data source need to handle expansion/collapsion of the tree node and change the data feed
+ * to `MatTree`.
+ * The nested tree nodes of type `T` are flattened through `MatTreeFlattener`, and converted
+ * to type `F` for `MatTree` to consume.
+ *
+ * @deprecated Use one of levelAccessor or childrenAccessor instead. To be removed in a future
+ * version.
+ * @breaking-change 21.0.0
+ */
+declare class MatTreeFlatDataSource<T, F, K = F> extends DataSource<F> {
+    private _treeControl;
+    private _treeFlattener;
+    private readonly _flattenedData;
+    private readonly _expandedData;
+    get data(): T[];
+    set data(value: T[]);
+    private readonly _data;
+    constructor(_treeControl: FlatTreeControl<F, K>, _treeFlattener: MatTreeFlattener<T, F, K>, initialData?: T[]);
+    connect(collectionViewer: CollectionViewer): Observable<F[]>;
+    disconnect(): void;
+}
+
+/**
+ * Data source for nested tree.
+ *
+ * The data source for nested tree doesn't have to consider node flattener, or the way to expand
+ * or collapse. The expansion/collapsion will be handled by TreeControl and each non-leaf node.
+ */
+declare class MatTreeNestedDataSource<T> extends DataSource<T> {
+    /**
+     * Data for the nested tree
+     */
+    get data(): T[];
+    set data(value: T[]);
+    private readonly _data;
+    connect(collectionViewer: CollectionViewer): Observable<T[]>;
+    disconnect(): void;
+}
+
+export { MatNestedTreeNode, MatTree, MatTreeFlatDataSource, MatTreeFlattener, MatTreeModule, MatTreeNestedDataSource, MatTreeNode, MatTreeNodeDef, MatTreeNodeOutlet, MatTreeNodePadding, MatTreeNodeToggle };