primeng 16.0.0-rc.1 → 16.0.0

package/tree/tree.interface.d.ts

@@ -0,0 +1,193 @@
+import { TemplateRef } from '@angular/core';
+import { TreeNode } from 'primeng/api';
+import { ScrollerOptions } from 'primeng/api';
+/**
+ * Custom node select event.
+ * @see {@link Tree.onNodeSelect}
+ * @group Events
+ */
+export interface TreeNodeSelectEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Node instance.
+     */
+    node: TreeNode;
+}
+/**
+ * Custom node unselect event.
+ * @see {@link Tree.onNodeUnSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+export interface TreeNodeUnSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node expand event.
+ * @see {@link Tree.onNodeExpand}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+export interface TreeNodeExpandEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node collapse event.
+ * @see {@link Tree.onNodeCollapse}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+export interface TreeNodeCollapseEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom context menu select event.
+ * @see {@link Tree.onNodeContextMenuSelect}
+ * @extends {TreeNodeSelectEvent}
+ * @group Events
+ */
+export interface TreeNodeContextMenuSelectEvent extends TreeNodeSelectEvent {
+}
+/**
+ * Custom node drop event.
+ * @see {@link Tree.onNodeDrop}
+ * @group Events
+ */
+export interface TreeNodeDropEvent {
+    /**
+     * Browser drag event.
+     */
+    originalEvent?: DragEvent;
+    /**
+     * Dragged node instance.
+     */
+    dragNode?: TreeNode | null;
+    /**
+     * Dropped node instance.
+     */
+    dropNode?: TreeNode | null;
+    /**
+     * Index of the dragged node.
+     */
+    index?: number;
+    /**
+     * Callback to invoke on drop.
+     */
+    accept?: Function;
+}
+/**
+ * Custom lazy load event.
+ * @see {@link Tree.onLazyLoad}
+ * @group Events
+ */
+export interface TreeLazyLoadEvent {
+    /**
+     * First element index in viewport.
+     */
+    first: number;
+    /**
+     * Last element index in viewport.
+     */
+    last: number;
+}
+/**
+ * Custom scroll index change event.
+ * @see {@link Tree.onScrollIndexChange}
+ * @group Events
+ */
+export interface TreeScrollIndexChangeEvent extends TreeLazyLoadEvent {
+}
+/**
+ * Custom scroll event.
+ * @see {@link Tree.onScroll}
+ * @group Events
+ */
+export interface TreeScrollEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Custom filter event.
+ * @see {@link Tree.onFilter}
+ * @group Events
+ */
+export interface TreeFilterEvent {
+    /**
+     * Filter value.
+     */
+    filter: string;
+    /**
+     * Filtered nodes.
+     */
+    filteredValue: TreeNode[] | null | undefined;
+}
+/**
+ * Defines valid templates in Tree.
+ * @group Templates
+ */
+export interface TreeTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom empty message template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom loader template.
+     * @param {Object} context - loader options.
+     */
+    loader(context: {
+        /**
+         * Scroller options.
+         * @see {@link ScrollerOptions}
+         */
+        options: ScrollerOptions;
+    }): TemplateRef<{
+        options: ScrollerOptions;
+    }>;
+    /**
+     * Custom toggler icon template.
+     * @param {Object} context - expand data.
+     */
+    togglericon(context: {
+        /**
+         * Expanded state of the node.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom checkbox icon template.
+     * @param {Object} context - node data.
+     */
+    checkboxicon(context: {
+        /**
+         * Checked state of the node.
+         */
+        $implicit: boolean;
+        /**
+         * Partial selection state of the node.
+         */
+        partialSelected: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+        partialSelected: boolean;
+    }>;
+    /**
+     * Custom loading icon template.
+     */
+    loadingicon(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+}

package/treeselect/public_api.d.ts

@@ -1 +1,2 @@
 export * from './treeselect';
+export * from './treeselect.interface';

package/treeselect/treeselect.d.ts

@@ -1,8 +1,10 @@
 import { AnimationEvent } from '@angular/animations';
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, QueryList, TemplateRef } from '@angular/core';
-import { OverlayOptions, OverlayService, PrimeNGConfig, TreeNode } from 'primeng/api';
+import { OverlayOptions, OverlayService, PrimeNGConfig, PrimeTemplate, TreeNode } from 'primeng/api';
 import { Overlay } from 'primeng/overlay';
 import { Tree } from 'primeng/tree';
+import { Nullable } from 'primeng/ts-helpers';
+import { TreeSelectNodeCollapseEvent, TreeSelectNodeExpandEvent } from './treeselect.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/overlay";
@@ -13,84 +15,264 @@ import * as i6 from "primeng/icons/search";
 import * as i7 from "primeng/icons/times";
 import * as i8 from "primeng/icons/chevrondown";
 export declare const TREESELECT_VALUE_ACCESSOR: any;
+/**
+ * TreeSelect is a form component to choose from hierarchical data.
+ * @group Components
+ */
 export declare class TreeSelect implements AfterContentInit {
     config: PrimeNGConfig;
     cd: ChangeDetectorRef;
     el: ElementRef;
     overlayService: OverlayService;
-    type: string;
-    inputId: string;
+    /**
+     * Identifier of the underlying input element.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Height of the viewport, a scrollbar is defined if height of list exceeds this value.
+     * @group Props
+     */
     scrollHeight: string;
-    disabled: boolean;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: 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;
-    display: string;
-    selectionMode: string;
-    tabindex: string;
-    ariaLabelledBy: string;
-    placeholder: string;
-    panelClass: string;
-    panelStyle: any;
-    panelStyleClass: string;
-    containerStyle: object;
-    containerStyleClass: string;
-    labelStyle: object;
-    labelStyleClass: string;
-    overlayOptions: OverlayOptions;
+    /**
+     * Defines how the selected items are displayed.
+     * @group Props
+     */
+    display: 'comma' | 'chip';
+    /**
+     * Defines the selection mode.
+     * @group Props
+     */
+    selectionMode: 'single' | 'multiple' | 'checkbox';
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: 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;
+    /**
+     * Label to display when there are no selections.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * Style class of the overlay panel.
+     * @group Props
+     */
+    panelClass: string | string[] | Set<string> | {
+        [klass: string]: any;
+    } | undefined;
+    /**
+     * Inline style of the panel element.
+     * @group Props
+     */
+    panelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the panel element.
+     * @group Props
+     */
+    panelStyleClass: string | undefined;
+    /**
+     * Inline style of the container element.
+     * @group Props
+     */
+    containerStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the container element.
+     * @group Props
+     */
+    containerStyleClass: string | undefined;
+    /**
+     * Inline style of the label element.
+     * @group Props
+     */
+    labelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the label element.
+     * @group Props
+     */
+    labelStyleClass: string | undefined;
+    /**
+     * Specifies the options for the overlay.
+     * @group Props
+     */
+    overlayOptions: OverlayOptions | undefined;
+    /**
+     * Text to display when there are no options available. Defaults to value from PrimeNG locale configuration.
+     * @group Props
+     */
     emptyMessage: string;
-    appendTo: any;
+    /**
+     * A valid query selector or an HTMLElement to specify where the overlay gets attached. Special keywords are "body" for document body and "self" for the element itself.
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * When specified, displays an input field to filter the items.
+     * @group Props
+     */
     filter: boolean;
+    /**
+     * 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;
-    filterLocale: string;
+    /**
+     * Placeholder text to show when filter input is empty.
+     * @group Props
+     */
+    filterPlaceholder: string | undefined;
+    /**
+     * Locale to use in filtering. The default locale is the host environment's current locale.
+     * @group Props
+     */
+    filterLocale: string | undefined;
+    /**
+     * Determines whether the filter input should be automatically focused when the component is rendered.
+     * @group Props
+     */
     filterInputAutoFocus: boolean;
+    /**
+     * Whether checkbox selections propagate to descendant nodes.
+     * @group Props
+     */
     propagateSelectionDown: boolean;
+    /**
+     * Whether checkbox selections propagate to ancestor nodes.
+     * @group Props
+     */
     propagateSelectionUp: boolean;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     showClear: boolean;
+    /**
+     * Clears the filter value when hiding the dropdown.
+     * @group Props
+     */
     resetFilterOnHide: boolean;
-    get options(): any[];
-    set options(options: any[]);
-    templates: QueryList<any>;
-    containerEl: ElementRef;
-    focusInput: ElementRef;
-    filterViewChild: ElementRef;
-    treeViewChild: Tree;
-    panelEl: ElementRef;
-    overlayViewChild: Overlay;
-    onNodeExpand: EventEmitter<any>;
-    onNodeCollapse: EventEmitter<any>;
-    onShow: EventEmitter<any>;
-    onHide: EventEmitter<any>;
+    /**
+     * An array of treenodes.
+     * @defaultValue undefined
+     * @group Props
+     */
+    get options(): TreeNode[] | undefined;
+    set options(options: TreeNode[] | undefined);
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     * @deprecated since v14.2.0 use overlayOptions property instead.
+     */
+    get showTransitionOptions(): string | undefined;
+    set showTransitionOptions(val: string | undefined);
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     * @deprecated since v14.2.0 use overlayOptions property instead.
+     */
+    get hideTransitionOptions(): string | undefined;
+    set hideTransitionOptions(val: string | undefined);
+    /**
+     * Callback to invoke when a node is expanded.
+     * @param {TreeSelectNodeExpandEvent} event - Custom node expand event.
+     * @group Emits
+     */
+    onNodeExpand: EventEmitter<TreeSelectNodeExpandEvent>;
+    /**
+     * Callback to invoke when a node is collapsed.
+     * @param {TreeSelectNodeCollapseEvent} event - Custom node collapse event.
+     * @group Emits
+     */
+    onNodeCollapse: EventEmitter<TreeSelectNodeCollapseEvent>;
+    /**
+     * Callback to invoke when the overlay is shown.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onShow: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the overlay is hidden.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onHide: EventEmitter<Event>;
+    /**
+     * Callback to invoke when input field is cleared.
+     * @group Emits
+     */
     onClear: EventEmitter<any>;
+    /**
+     * Callback to invoke when data is filtered.
+     * @group Emits
+     */
     onFilter: EventEmitter<any>;
-    onNodeUnselect: EventEmitter<any>;
-    onNodeSelect: EventEmitter<any>;
-    _showTransitionOptions: string;
-    get showTransitionOptions(): string;
-    set showTransitionOptions(val: string);
-    _hideTransitionOptions: string;
-    get hideTransitionOptions(): string;
-    set hideTransitionOptions(val: string);
-    filteredNodes: TreeNode[];
-    filterValue: string;
-    serializedValue: any[];
-    valueTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    emptyTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    clearIconTemplate: TemplateRef<any>;
-    triggerIconTemplate: TemplateRef<any>;
-    filterIconTemplate: TemplateRef<any>;
-    closeIconTemplate: TemplateRef<any>;
-    itemTogglerIconTemplate: TemplateRef<any>;
-    itemCheckboxIconTemplate: TemplateRef<any>;
-    itemLoadingIconTemplate: TemplateRef<any>;
-    focused: boolean;
-    overlayVisible: boolean;
-    selfChange: boolean;
-    value: any;
+    /**
+     * Callback to invoke when a node is unselected.
+     * @param {TreeNode} node - Node instance.
+     * @group Emits
+     */
+    onNodeUnselect: EventEmitter<TreeNode>;
+    /**
+     * Callback to invoke when a node is selected.
+     * @param {TreeNode} node - Node instance.
+     * @group Emits
+     */
+    onNodeSelect: EventEmitter<TreeNode>;
+    _showTransitionOptions: string | undefined;
+    _hideTransitionOptions: string | undefined;
+    templates: Nullable<QueryList<PrimeTemplate>>;
+    containerEl: Nullable<ElementRef>;
+    focusInput: Nullable<ElementRef>;
+    filterViewChild: Nullable<ElementRef>;
+    treeViewChild: Nullable<Tree>;
+    panelEl: Nullable<ElementRef>;
+    overlayViewChild: Nullable<Overlay>;
+    filteredNodes: TreeNode[] | undefined | null;
+    filterValue: Nullable<string>;
+    serializedValue: Nullable<any[]>;
+    valueTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    emptyTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    triggerIconTemplate: Nullable<TemplateRef<any>>;
+    filterIconTemplate: Nullable<TemplateRef<any>>;
+    closeIconTemplate: Nullable<TemplateRef<any>>;
+    itemTogglerIconTemplate: Nullable<TemplateRef<any>>;
+    itemCheckboxIconTemplate: Nullable<TemplateRef<any>>;
+    itemLoadingIconTemplate: Nullable<TemplateRef<any>>;
+    focused: Nullable<boolean>;
+    overlayVisible: Nullable<boolean>;
+    selfChange: Nullable<boolean>;
+    value: any | undefined;
     expandedNodes: any[];
-    _options: any[];
+    _options: TreeNode[] | undefined;
     templateMap: any;
     onModelChange: Function;
     onModelTouched: Function;
@@ -98,27 +280,33 @@ export declare class TreeSelect implements AfterContentInit {
     ngOnInit(): void;
     ngAfterContentInit(): void;
     onOverlayAnimationStart(event: AnimationEvent): void;
-    onSelectionChange(event: any): void;
-    onClick(event: any): void;
-    onKeyDown(event: any): void;
-    onFilterInput(event: any): void;
+    onSelectionChange(event: Event): void;
+    onClick(event: Event): void;
+    onKeyDown(event: KeyboardEvent): void;
+    onFilterInput(event: Event): void;
     show(): void;
     hide(event?: any): void;
-    clear(event: any): void;
+    clear(event: Event): void;
     checkValue(): boolean;
     resetFilter(): void;
     updateTreeState(): void;
-    updateTreeBranchState(node: any, path: any, selectedNodes: any): void;
-    expandPath(expandedNodes: any): void;
-    nodeExpand(event: any): void;
-    nodeCollapse(event: any): void;
+    updateTreeBranchState(node: TreeNode | null, path: any, selectedNodes: TreeNode[]): void;
+    expandPath(expandedNodes: TreeNode[]): void;
+    nodeExpand(event: {
+        originalEvent: Event;
+        node: TreeNode;
+    }): void;
+    nodeCollapse(event: {
+        originalEvent: Event;
+        node: TreeNode;
+    }): void;
     resetExpandedNodes(): void;
-    resetPartialSelected(nodes?: any[]): void;
-    findSelectedNodes(node: any, keys: any, selectedNodes: any): void;
+    resetPartialSelected(nodes?: TreeNode[]): void;
+    findSelectedNodes(node: TreeNode, keys: any[], selectedNodes: TreeNode[]): void;
     isSelected(node: TreeNode): boolean;
     findIndexInSelection(node: TreeNode): number;
-    onSelect(node: any): void;
-    onUnselect(node: any): void;
+    onSelect(node: TreeNode): void;
+    onUnselect(node: TreeNode): void;
     onFocus(): void;
     onBlur(): void;
     writeValue(value: any): void;
@@ -140,7 +328,7 @@ export declare class TreeSelect implements AfterContentInit {
     get emptyOptions(): boolean;
     get label(): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<TreeSelect, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TreeSelect, "p-treeSelect", never, { "type": { "alias": "type"; "required": false; }; "inputId": { "alias": "inputId"; "required": false; }; "scrollHeight": { "alias": "scrollHeight"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "metaKeySelection": { "alias": "metaKeySelection"; "required": false; }; "display": { "alias": "display"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "panelClass": { "alias": "panelClass"; "required": false; }; "panelStyle": { "alias": "panelStyle"; "required": false; }; "panelStyleClass": { "alias": "panelStyleClass"; "required": false; }; "containerStyle": { "alias": "containerStyle"; "required": false; }; "containerStyleClass": { "alias": "containerStyleClass"; "required": false; }; "labelStyle": { "alias": "labelStyle"; "required": false; }; "labelStyleClass": { "alias": "labelStyleClass"; "required": false; }; "overlayOptions": { "alias": "overlayOptions"; "required": false; }; "emptyMessage": { "alias": "emptyMessage"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "filter": { "alias": "filter"; "required": false; }; "filterBy": { "alias": "filterBy"; "required": false; }; "filterMode": { "alias": "filterMode"; "required": false; }; "filterPlaceholder": { "alias": "filterPlaceholder"; "required": false; }; "filterLocale": { "alias": "filterLocale"; "required": false; }; "filterInputAutoFocus": { "alias": "filterInputAutoFocus"; "required": false; }; "propagateSelectionDown": { "alias": "propagateSelectionDown"; "required": false; }; "propagateSelectionUp": { "alias": "propagateSelectionUp"; "required": false; }; "showClear": { "alias": "showClear"; "required": false; }; "resetFilterOnHide": { "alias": "resetFilterOnHide"; "required": false; }; "options": { "alias": "options"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; }, { "onNodeExpand": "onNodeExpand"; "onNodeCollapse": "onNodeCollapse"; "onShow": "onShow"; "onHide": "onHide"; "onClear": "onClear"; "onFilter": "onFilter"; "onNodeUnselect": "onNodeUnselect"; "onNodeSelect": "onNodeSelect"; }, ["templates"], never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TreeSelect, "p-treeSelect", never, { "inputId": { "alias": "inputId"; "required": false; }; "scrollHeight": { "alias": "scrollHeight"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "metaKeySelection": { "alias": "metaKeySelection"; "required": false; }; "display": { "alias": "display"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "panelClass": { "alias": "panelClass"; "required": false; }; "panelStyle": { "alias": "panelStyle"; "required": false; }; "panelStyleClass": { "alias": "panelStyleClass"; "required": false; }; "containerStyle": { "alias": "containerStyle"; "required": false; }; "containerStyleClass": { "alias": "containerStyleClass"; "required": false; }; "labelStyle": { "alias": "labelStyle"; "required": false; }; "labelStyleClass": { "alias": "labelStyleClass"; "required": false; }; "overlayOptions": { "alias": "overlayOptions"; "required": false; }; "emptyMessage": { "alias": "emptyMessage"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "filter": { "alias": "filter"; "required": false; }; "filterBy": { "alias": "filterBy"; "required": false; }; "filterMode": { "alias": "filterMode"; "required": false; }; "filterPlaceholder": { "alias": "filterPlaceholder"; "required": false; }; "filterLocale": { "alias": "filterLocale"; "required": false; }; "filterInputAutoFocus": { "alias": "filterInputAutoFocus"; "required": false; }; "propagateSelectionDown": { "alias": "propagateSelectionDown"; "required": false; }; "propagateSelectionUp": { "alias": "propagateSelectionUp"; "required": false; }; "showClear": { "alias": "showClear"; "required": false; }; "resetFilterOnHide": { "alias": "resetFilterOnHide"; "required": false; }; "options": { "alias": "options"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; }, { "onNodeExpand": "onNodeExpand"; "onNodeCollapse": "onNodeCollapse"; "onShow": "onShow"; "onHide": "onHide"; "onClear": "onClear"; "onFilter": "onFilter"; "onNodeUnselect": "onNodeUnselect"; "onNodeSelect": "onNodeSelect"; }, ["templates"], never, false, never>;
 }
 export declare class TreeSelectModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TreeSelectModule, never>;