primeng 16.0.0-rc.1 → 16.0.0

package/tree/tree.d.ts

@@ -1,7 +1,10 @@
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, OnChanges, OnDestroy, OnInit, QueryList, SimpleChanges, TemplateRef } from '@angular/core';
 import { BlockableUI, PrimeNGConfig, TreeDragDropService, TreeNode } from 'primeng/api';
-import { Scroller, ScrollerOptions } from 'primeng/scroller';
+import { Scroller } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { Subscription } from 'rxjs';
+import { Nullable } from 'primeng/ts-helpers';
+import { TreeFilterEvent, TreeLazyLoadEvent, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreeScrollEvent, TreeScrollIndexChangeEvent } from './tree.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -13,24 +16,25 @@ import * as i7 from "primeng/icons/chevronright";
 import * as i8 from "primeng/icons/minus";
 import * as i9 from "primeng/icons/search";
 import * as i10 from "primeng/icons/spinner";
+import * as i11 from "primeng/icons/plus";
 export declare class UITreeNode implements OnInit {
     static ICON_CLASS: string;
     rowNode: any;
-    node: TreeNode;
-    parentNode: TreeNode;
-    root: boolean;
-    index: number;
-    firstChild: boolean;
-    lastChild: boolean;
-    level: number;
-    indentation: number;
-    itemSize: number;
+    node: TreeNode | undefined;
+    parentNode: TreeNode | undefined;
+    root: boolean | undefined;
+    index: number | undefined;
+    firstChild: boolean | undefined;
+    lastChild: boolean | undefined;
+    level: number | undefined;
+    indentation: number | undefined;
+    itemSize: number | undefined;
     tree: Tree;
     timeout: any;
-    constructor(tree: any);
-    draghoverPrev: boolean;
-    draghoverNext: boolean;
-    draghoverNode: boolean;
+    draghoverPrev: boolean | undefined;
+    draghoverNext: boolean | undefined;
+    draghoverNode: boolean | undefined;
+    constructor(tree: Tree);
     ngOnInit(): void;
     getIcon(): string;
     isLeaf(): boolean;
@@ -42,15 +46,15 @@ export declare class UITreeNode implements OnInit {
     onNodeTouchEnd(): void;
     onNodeRightClick(event: MouseEvent): void;
     isSelected(): boolean;
-    onDropPoint(event: Event, position: number): void;
+    onDropPoint(event: DragEvent, position: number): void;
     processPointDrop(event: any): void;
-    createDropPointEventMetadata(position: any): {
-        dragNode: TreeNode<any>;
+    createDropPointEventMetadata(position: number): {
+        dragNode: TreeNode;
         dragNodeIndex: number;
-        dragNodeSubNodes: TreeNode<any>[];
-        dropNode: TreeNode<any>;
+        dragNodeSubNodes: TreeNode[];
+        dropNode: TreeNode;
         index: number;
-        position: any;
+        position: number;
     };
     onDropPointDragOver(event: any): void;
     onDropPointDragEnter(event: Event, position: number): void;
@@ -60,10 +64,10 @@ export declare class UITreeNode implements OnInit {
     onDropNodeDragOver(event: any): void;
     onDropNode(event: any): void;
     createDropNodeEventMetadata(): {
-        dragNode: TreeNode<any>;
+        dragNode: TreeNode;
         dragNodeIndex: number;
-        dragNodeSubNodes: TreeNode<any>[];
-        dropNode: TreeNode<any>;
+        dragNodeSubNodes: TreeNode[];
+        dropNode: TreeNode;
     };
     processNodeDrop(event: any): void;
     onDropNodeDragEnter(event: any): void;
@@ -71,88 +75,294 @@ export declare class UITreeNode implements OnInit {
     onKeyDown(event: KeyboardEvent): void;
     findNextSiblingOfAncestor(nodeElement: any): any;
     findLastVisibleDescendant(nodeElement: any): any;
-    getParentNodeElement(nodeElement: any): any;
+    getParentNodeElement(nodeElement: HTMLElement): HTMLElement;
     focusNode(element: any): void;
     focusVirtualNode(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<UITreeNode, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<UITreeNode, "p-treeNode", never, { "rowNode": { "alias": "rowNode"; "required": false; }; "node": { "alias": "node"; "required": false; }; "parentNode": { "alias": "parentNode"; "required": false; }; "root": { "alias": "root"; "required": false; }; "index": { "alias": "index"; "required": false; }; "firstChild": { "alias": "firstChild"; "required": false; }; "lastChild": { "alias": "lastChild"; "required": false; }; "level": { "alias": "level"; "required": false; }; "indentation": { "alias": "indentation"; "required": false; }; "itemSize": { "alias": "itemSize"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Tree is used to display hierarchical data.
+ * @group Components
+ */
 export declare class Tree implements OnInit, AfterContentInit, OnChanges, OnDestroy, BlockableUI {
     el: ElementRef;
     dragDropService: TreeDragDropService;
     config: PrimeNGConfig;
     private cd;
-    value: TreeNode[];
-    selectionMode: string;
+    /**
+     * An array of treenodes.
+     * @group Props
+     */
+    value: TreeNode | TreeNode[] | any[] | any;
+    /**
+     * Defines the selection mode.
+     * @group Props
+     */
+    selectionMode: 'single' | 'multiple' | 'checkbox' | null | undefined;
+    /**
+     * A single treenode instance or an array to refer to the selections.
+     * @group Props
+     */
     selection: any;
-    style: any;
-    styleClass: string;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Context menu instance.
+     * @group Props
+     */
     contextMenu: any;
+    /**
+     * Defines the orientation of the tree, valid values are 'vertical' and 'horizontal'.
+     * @group Props
+     */
     layout: string;
+    /**
+     * Scope of the draggable nodes to match a droppableScope.
+     * @group Props
+     */
     draggableScope: any;
+    /**
+     * Scope of the droppable nodes to match a draggableScope.
+     * @group Props
+     */
     droppableScope: any;
-    draggableNodes: boolean;
-    droppableNodes: boolean;
+    /**
+     * Whether the nodes are draggable.
+     * @group Props
+     */
+    draggableNodes: boolean | undefined;
+    /**
+     * Whether the nodes are droppable.
+     * @group Props
+     */
+    droppableNodes: boolean | undefined;
+    /**
+     * Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
+     * @group Props
+     */
     metaKeySelection: boolean;
+    /**
+     * Whether checkbox selections propagate to ancestor nodes.
+     * @group Props
+     */
     propagateSelectionUp: boolean;
+    /**
+     * Whether checkbox selections propagate to descendant nodes.
+     * @group Props
+     */
     propagateSelectionDown: boolean;
-    loading: boolean;
-    loadingIcon: string;
+    /**
+     * Displays a loader to indicate data load is in progress.
+     * @group Props
+     */
+    loading: boolean | undefined;
+    /**
+     * The icon to show while indicating data load is in progress.
+     * @group Props
+     */
+    loadingIcon: string | undefined;
+    /**
+     * Text to display when there is no data.
+     * @group Props
+     */
     emptyMessage: string;
-    ariaLabel: string;
-    togglerAriaLabel: string;
-    ariaLabelledBy: string;
-    validateDrop: boolean;
-    filter: boolean;
+    /**
+     * Used to define a string that labels the tree.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Defines a string that labels the toggler icon for accessibility.
+     * @group Props
+     */
+    togglerAriaLabel: string | undefined;
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * When enabled, drop can be accepted or rejected based on condition defined at onNodeDrop.
+     * @group Props
+     */
+    validateDrop: boolean | undefined;
+    /**
+     * When specified, displays an input field to filter the items.
+     * @group Props
+     */
+    filter: boolean | undefined;
+    /**
+     * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
+     * @group Props
+     */
     filterBy: string;
+    /**
+     * Mode for filtering valid values are "lenient" and "strict". Default is lenient.
+     * @group Props
+     */
     filterMode: string;
-    filterPlaceholder: string;
-    filteredNodes: TreeNode[];
-    filterLocale: string;
-    scrollHeight: string;
+    /**
+     * Placeholder text to show when filter input is empty.
+     * @group Props
+     */
+    filterPlaceholder: string | undefined;
+    /**
+     * No description available.
+     * @group Props
+     */
+    filteredNodes: TreeNode[] | undefined | null;
+    /**
+     * Locale to use in filtering. The default locale is the host environment's current locale.
+     * @group Props
+     */
+    filterLocale: string | undefined;
+    /**
+     * Height of the scrollable viewport.
+     * @group Props
+     */
+    scrollHeight: string | undefined;
+    /**
+     * Defines if data is loaded and interacted with in lazy manner.
+     * @group Props
+     */
     lazy: boolean;
-    virtualScroll: boolean;
-    virtualScrollItemSize: number;
-    virtualScrollOptions: ScrollerOptions;
+    /**
+     * Whether the data should be loaded on demand during scroll.
+     * @group Props
+     */
+    virtualScroll: boolean | undefined;
+    /**
+     * Height of an item in the list for VirtualScrolling.
+     * @group Props
+     */
+    virtualScrollItemSize: number | undefined;
+    /**
+     * Whether to use the scroller feature. The properties of scroller component can be used like an object in it.
+     * @group Props
+     */
+    virtualScrollOptions: ScrollerOptions | undefined;
+    /**
+     * Indentation factor for spacing of the nested node when virtual scrolling is enabled.
+     * @group Props
+     */
     indentation: number;
+    /**
+     * Custom templates of the component.
+     * @group Props
+     */
     _templateMap: any;
+    /**
+     * Function to optimize the node list rendering, default algorithm checks for object identity.
+     * @group Props
+     */
     trackBy: Function;
-    selectionChange: EventEmitter<any>;
-    onNodeSelect: EventEmitter<any>;
-    onNodeUnselect: EventEmitter<any>;
-    onNodeExpand: EventEmitter<any>;
-    onNodeCollapse: EventEmitter<any>;
-    onNodeContextMenuSelect: EventEmitter<any>;
-    onNodeDrop: EventEmitter<any>;
-    onLazyLoad: EventEmitter<any>;
-    onScroll: EventEmitter<any>;
-    onScrollIndexChange: EventEmitter<any>;
-    onFilter: EventEmitter<any>;
-    templates: QueryList<any>;
-    filterViewChild: ElementRef;
-    scroller: Scroller;
-    wrapperViewChild: ElementRef;
-    _virtualNodeHeight: number;
-    get virtualNodeHeight(): number;
-    set virtualNodeHeight(val: number);
-    serializedValue: any[];
-    headerTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    loaderTemplate: TemplateRef<any>;
-    emptyMessageTemplate: TemplateRef<any>;
-    togglerIconTemplate: TemplateRef<any>;
-    checkboxIconTemplate: TemplateRef<any>;
-    loadingIconTemplate: TemplateRef<any>;
-    filterIconTemplate: TemplateRef<any>;
-    nodeTouched: boolean;
-    dragNodeTree: Tree;
-    dragNode: TreeNode;
-    dragNodeSubNodes: TreeNode[];
-    dragNodeIndex: number;
+    /**
+     * Height of the node.
+     * @group Props
+     * @deprecated use virtualScrollItemSize property instead.
+     */
+    _virtualNodeHeight: number | undefined;
+    get virtualNodeHeight(): number | undefined;
+    set virtualNodeHeight(val: number | undefined);
+    /**
+     * Callback to invoke on selection change.
+     * @param {(TreeNode | TreeNode[] | null)} event - Custom selection change event.
+     * @group Emits
+     */
+    selectionChange: EventEmitter<TreeNode[] | TreeNode | null>;
+    /**
+     * Callback to invoke when a node is selected.
+     * @param {TreeNodeSelectEvent} event - Node select event.
+     * @group Emits
+     */
+    onNodeSelect: EventEmitter<TreeNodeSelectEvent>;
+    /**
+     * Callback to invoke when a node is unselected.
+     * @param {TreeNodeUnSelectEvent} event - Node unselect event.
+     * @group Emits
+     */
+    onNodeUnselect: EventEmitter<TreeNodeUnSelectEvent>;
+    /**
+     * Callback to invoke when a node is expanded.
+     * @param {TreeNodeExpandEvent} event - Node expand event.
+     * @group Emits
+     */
+    onNodeExpand: EventEmitter<TreeNodeExpandEvent>;
+    /**
+     * Callback to invoke when a node is collapsed.
+     * @param {TreeNodeCollapseEvent} event - Node collapse event.
+     * @group Emits
+     */
+    onNodeCollapse: EventEmitter<TreeNodeCollapseEvent>;
+    /**
+     * Callback to invoke when a node is selected with right click.
+     * @param {onNodeContextMenuSelect} event - Node context menu select event.
+     * @group Emits
+     */
+    onNodeContextMenuSelect: EventEmitter<TreeNodeContextMenuSelectEvent>;
+    /**
+     * Callback to invoke when a node is dropped.
+     * @param {TreeNodeDropEvent} event - Node drop event.
+     * @group Emits
+     */
+    onNodeDrop: EventEmitter<TreeNodeDropEvent>;
+    /**
+     * Callback to invoke in lazy mode to load new data.
+     * @param {TreeLazyLoadEvent} event - Custom lazy load event.
+     * @group Emits
+     */
+    onLazyLoad: EventEmitter<TreeLazyLoadEvent>;
+    /**
+     * Callback to invoke in virtual scroll mode when scroll position changes.
+     * @param {TreeScrollEvent} event - Custom scroll event.
+     * @group Emits
+     */
+    onScroll: EventEmitter<TreeScrollEvent>;
+    /**
+     * Callback to invoke in virtual scroll mode when scroll position and item's range in view changes.
+     * @param {TreeScrollIndexChangeEvent} event - Scroll index change event.
+     * @group Emits
+     */
+    onScrollIndexChange: EventEmitter<TreeScrollIndexChangeEvent>;
+    /**
+     * Callback to invoke when data is filtered.
+     * @param {TreeFilterEvent} event - Custom filter event.
+     * @group Emits
+     */
+    onFilter: EventEmitter<TreeFilterEvent>;
+    templates: Nullable<QueryList<any>>;
+    filterViewChild: Nullable<ElementRef>;
+    scroller: Nullable<Scroller>;
+    wrapperViewChild: Nullable<ElementRef>;
+    serializedValue: Nullable<TreeNode[]>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    loaderTemplate: Nullable<TemplateRef<any>>;
+    emptyMessageTemplate: Nullable<TemplateRef<any>>;
+    togglerIconTemplate: Nullable<TemplateRef<any>>;
+    checkboxIconTemplate: Nullable<TemplateRef<any>>;
+    loadingIconTemplate: Nullable<TemplateRef<any>>;
+    filterIconTemplate: Nullable<TemplateRef<any>>;
+    nodeTouched: boolean | undefined | null;
+    dragNodeTree: Tree | undefined | null;
+    dragNode: TreeNode | undefined | null;
+    dragNodeSubNodes: TreeNode[] | undefined | null;
+    dragNodeIndex: number | undefined | null;
     dragNodeScope: any;
-    dragHover: boolean;
-    dragStartSubscription: Subscription;
-    dragStopSubscription: Subscription;
+    dragHover: boolean | undefined | null;
+    dragStartSubscription: Subscription | undefined | null;
+    dragStopSubscription: Subscription | undefined | null;
     constructor(el: ElementRef, dragDropService: TreeDragDropService, config: PrimeNGConfig, cd: ChangeDetectorRef);
     ngOnInit(): void;
     ngOnChanges(simpleChange: SimpleChanges): void;
@@ -160,41 +370,51 @@ export declare class Tree implements OnInit, AfterContentInit, OnChanges, OnDest
     get emptyMessageLabel(): string;
     ngAfterContentInit(): void;
     updateSerializedValue(): void;
-    serializeNodes(parent: any, nodes: any, level: any, visible: any): void;
-    onNodeClick(event: any, node: TreeNode): void;
+    serializeNodes(parent: TreeNode | null, nodes: TreeNode[] | any, level: number, visible: boolean): void;
+    onNodeClick(event: Event, node: TreeNode): void;
     onNodeTouchEnd(): void;
     onNodeRightClick(event: MouseEvent, node: TreeNode): void;
     findIndexInSelection(node: TreeNode): number;
-    syncNodeOption(node: any, parentNodes: any, option: any, value?: any): void;
+    syncNodeOption(node: TreeNode, parentNodes: TreeNode[], option: any, value?: any): void;
     hasFilteredNodes(): number;
-    getNodeWithKey(key: string, nodes: TreeNode[]): any;
+    getNodeWithKey(key: string, nodes: TreeNode[]): TreeNode | undefined;
     propagateUp(node: TreeNode, select: boolean): void;
     propagateDown(node: TreeNode, select: boolean): void;
     isSelected(node: TreeNode): boolean;
     isSingleSelectionMode(): boolean;
     isMultipleSelectionMode(): boolean;
     isCheckboxSelectionMode(): boolean;
-    isNodeLeaf(node: any): boolean;
-    getRootNode(): TreeNode<any>[];
-    getTemplateForNode(node: TreeNode): TemplateRef<any>;
-    onDragOver(event: any): void;
-    onDrop(event: any): void;
-    processTreeDrop(dragNode: any, dragNodeIndex: any): void;
+    isNodeLeaf(node: TreeNode): boolean;
+    getRootNode(): any;
+    getTemplateForNode(node: TreeNode): TemplateRef<any> | null;
+    onDragOver(event: DragEvent): void;
+    onDrop(event: DragEvent): void;
+    processTreeDrop(dragNode: TreeNode, dragNodeIndex: number): void;
     onDragEnter(): void;
-    onDragLeave(event: any): void;
-    allowDrop(dragNode: TreeNode, dropNode: TreeNode, dragNodeScope: any): boolean;
+    onDragLeave(event: DragEvent): void;
+    allowDrop(dragNode: TreeNode, dropNode: TreeNode | null, dragNodeScope: any): boolean;
     isValidDragScope(dragScope: any): boolean;
-    _filter(value: any): void;
+    _filter(value: string): void;
+    /**
+     * Resets filter.
+     * @group Method
+     */
     resetFilter(): void;
+    /**
+     * Scrolls to virtual index.
+     * @param {number} number - Index to be scrolled.
+     * @group Method
+     */
     scrollToVirtualIndex(index: number): void;
+    /**
+     * Scrolls to virtual index.
+     * @param {ScrollToOptions} options - Scroll options.
+     * @group Method
+     */
     scrollTo(options: any): void;
-    findFilteredNodes(node: any, paramsWithoutNode: any): boolean;
-    isFilterMatched(node: any, { searchFields, filterText, isStrictMode }: {
-        searchFields: any;
-        filterText: any;
-        isStrictMode: any;
-    }): boolean;
-    getIndex(options: any, index: any): any;
+    findFilteredNodes(node: TreeNode, paramsWithoutNode: any): boolean;
+    isFilterMatched(node: TreeNode, params: any): boolean;
+    getIndex(options: any, index: number): any;
     getBlockableElement(): HTMLElement;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<Tree, [null, { optional: true; }, null, null]>;
@@ -202,6 +422,6 @@ export declare class Tree implements OnInit, AfterContentInit, OnChanges, OnDest
 }
 export declare class TreeModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TreeModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<TreeModule, [typeof Tree, typeof UITreeNode], [typeof i1.CommonModule, typeof i2.SharedModule, typeof i3.RippleModule, typeof i4.ScrollerModule, typeof i5.CheckIcon, typeof i6.ChevronDownIcon, typeof i7.ChevronRightIcon, typeof i8.MinusIcon, typeof i9.SearchIcon, typeof i10.SpinnerIcon], [typeof Tree, typeof i2.SharedModule, typeof i4.ScrollerModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TreeModule, [typeof Tree, typeof UITreeNode], [typeof i1.CommonModule, typeof i2.SharedModule, typeof i3.RippleModule, typeof i4.ScrollerModule, typeof i5.CheckIcon, typeof i6.ChevronDownIcon, typeof i7.ChevronRightIcon, typeof i8.MinusIcon, typeof i9.SearchIcon, typeof i10.SpinnerIcon, typeof i11.PlusIcon], [typeof Tree, typeof i2.SharedModule, typeof i4.ScrollerModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<TreeModule>;
 }