primeng 16.0.0-rc.1 → 16.0.0-rc.2

package/confirmdialog/confirmdialog.d.ts

@@ -1,9 +1,8 @@
-import { ElementRef, OnDestroy, EventEmitter, Renderer2, NgZone, ChangeDetectorRef, QueryList, TemplateRef, AfterContentInit, OnInit } from '@angular/core';
 import { AnimationEvent } from '@angular/animations';
-import { PrimeNGConfig } from 'primeng/api';
-import { Confirmation } from 'primeng/api';
-import { ConfirmationService } from 'primeng/api';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { ConfirmEventType, Confirmation, ConfirmationService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { Subscription } from 'rxjs';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
@@ -19,64 +18,195 @@ export declare class ConfirmDialog implements AfterContentInit, OnInit, OnDestro
     private cd;
     config: PrimeNGConfig;
     private document;
-    header: string;
-    icon: string;
-    message: string;
-    style: any;
-    styleClass: string;
-    maskStyleClass: string;
-    acceptIcon: string;
-    acceptLabel: string;
-    acceptAriaLabel: string;
+    /**
+     * Title text of the dialog.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Icon to display next to message.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Message of the confirmation.
+     * @group Props
+     */
+    message: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Specify the CSS class(es) for styling the mask element
+     * @group Props
+     */
+    maskStyleClass: string | undefined;
+    /**
+     * Icon of the accept button.
+     * @group Props
+     */
+    acceptIcon: string | undefined;
+    /**
+     * Label of the accept button.
+     * @group Props
+     */
+    acceptLabel: string | undefined;
+    /**
+     * Defines a string that labels the accept button for accessibility.
+     * @group Props
+     */
+    acceptAriaLabel: string | undefined;
+    /**
+     * Visibility of the accept button.
+     * @group Props
+     */
     acceptVisible: boolean;
-    rejectIcon: string;
-    rejectLabel: string;
-    rejectAriaLabel: string;
+    /**
+     * Icon of the reject button.
+     * @group Props
+     */
+    rejectIcon: string | undefined;
+    /**
+     * Label of the reject button.
+     * @group Props
+     */
+    rejectLabel: string | undefined;
+    /**
+     * Defines a string that labels the reject button for accessibility.
+     * @group Props
+     */
+    rejectAriaLabel: string | undefined;
+    /**
+     * Visibility of the reject button.
+     * @group Props
+     */
     rejectVisible: boolean;
-    acceptButtonStyleClass: string;
-    rejectButtonStyleClass: string;
+    /**
+     * Style class of the accept button.
+     * @group Props
+     */
+    acceptButtonStyleClass: string | undefined;
+    /**
+     * Style class of the reject button.
+     * @group Props
+     */
+    rejectButtonStyleClass: string | undefined;
+    /**
+     * Specifies if pressing escape key should hide the dialog.
+     * @group Props
+     */
     closeOnEscape: boolean;
-    dismissableMask: boolean;
+    /**
+     * Specifies if clicking the modal background should hide the dialog.
+     * @group Props
+     */
+    dismissableMask: boolean | undefined;
+    /**
+     * Determines whether scrolling behavior should be blocked within the component.
+     * @group Props
+     */
     blockScroll: boolean;
+    /**
+     * When enabled dialog is displayed in RTL direction.
+     * @group Props
+     */
     rtl: boolean;
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     * @group Props
+     */
     closable: boolean;
-    appendTo: any;
-    key: string;
+    /**
+     *  Target element to attach the dialog, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Optional key to match the key of confirm object, necessary to use when component tree has multiple confirm dialogs.
+     * @group Props
+     */
+    key: string | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
+    /**
+     * Transition options of the animation.
+     * @group Props
+     */
     transitionOptions: string;
+    /**
+     * When enabled, can only focus on elements inside the confirm dialog.
+     * @group Props
+     */
     focusTrap: boolean;
-    defaultFocus: string;
+    /**
+     * Element to receive the focus when the dialog gets visible, valid values are "accept", "reject", "close" and "none".
+     * @group Props
+     */
+    defaultFocus: 'accept' | 'reject' | 'close';
+    /**
+     * Object literal to define widths per screen size.
+     * @group Props
+     */
     breakpoints: any;
+    /**
+     * Current visible state as a boolean.
+     * @group Props
+     */
     get visible(): any;
     set visible(value: any);
+    /**
+     *  Allows getting the position of the component.
+     * @group Props
+     */
     get position(): string;
     set position(value: string);
-    onHide: EventEmitter<any>;
-    footer: any;
-    contentViewChild: ElementRef;
-    templates: QueryList<any>;
+    /**
+     * Callback to invoke when dialog is hidden.
+     * @param {ConfirmEventType} enum - confirm event type.
+     * @group Emits
+     */
+    onHide: EventEmitter<ConfirmEventType>;
+    footer: Nullable<TemplateRef<any>>;
+    contentViewChild: Nullable<ElementRef>;
+    templates: QueryList<PrimeTemplate> | undefined;
     ngAfterContentInit(): void;
-    headerTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    rejectIconTemplate: TemplateRef<any>;
-    acceptIconTemplate: TemplateRef<any>;
-    confirmation: Confirmation;
-    _visible: boolean;
-    maskVisible: boolean;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    rejectIconTemplate: Nullable<TemplateRef<any>>;
+    acceptIconTemplate: Nullable<TemplateRef<any>>;
+    confirmation: Nullable<Confirmation>;
+    _visible: boolean | undefined;
+    maskVisible: boolean | undefined;
     documentEscapeListener: any;
-    container: HTMLDivElement;
-    wrapper: HTMLElement;
-    contentContainer: HTMLDivElement;
+    container: Nullable<HTMLDivElement>;
+    wrapper: Nullable<HTMLElement>;
+    contentContainer: Nullable<HTMLDivElement>;
     subscription: Subscription;
-    maskClickListener: Function;
-    preWidth: number;
+    maskClickListener: Function | null | undefined;
+    preWidth: number | undefined;
     _position: string;
     transformOptions: any;
     styleElement: any;
     id: string;
-    confirmationOptions: Confirmation;
-    translationSubscription: Subscription;
+    confirmationOptions: Nullable<Confirmation>;
+    translationSubscription: Subscription | undefined;
     constructor(el: ElementRef, renderer: Renderer2, confirmationService: ConfirmationService, zone: NgZone, cd: ChangeDetectorRef, config: PrimeNGConfig, document: Document);
     ngOnInit(): void;
     option(name: string): any;
@@ -89,11 +219,10 @@ export declare class ConfirmDialog implements AfterContentInit, OnInit, OnDestro
     disableModality(): void;
     createStyle(): void;
     close(event: Event): void;
-    hide(type?: any): void;
+    hide(type?: ConfirmEventType): void;
     moveOnTop(): void;
     getMaskClass(): {
-        'p-dialog-mask p-component-overlay': boolean;
-        'p-dialog-mask-scrollblocker': boolean;
+        [key: string]: boolean;
     };
     getPositionClass(): string;
     bindGlobalListeners(): void;

package/confirmdialog/confirmdialog.interface.d.ts

@@ -0,0 +1,23 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in ConfirmDialog.
+ * @group Templates
+ */
+export interface ConfirmDialogTemplates {
+    /**
+     * Custom template of header.
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom template of footer.
+     */
+    footer: TemplateRef<any> | null;
+    /**
+     * Custom template of rejecticon.
+     */
+    rejecticon: TemplateRef<any> | null;
+    /**
+     * Custom template of accepticon.
+     */
+    accepticon: TemplateRef<any> | null;
+}

package/confirmdialog/public_api.d.ts

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

package/confirmpopup/confirmpopup.d.ts

@@ -1,8 +1,9 @@
-import { ElementRef, ChangeDetectorRef, OnDestroy, Renderer2, TemplateRef, AfterContentInit, QueryList } from '@angular/core';
-import { Confirmation, ConfirmationService, OverlayService, PrimeNGConfig } from 'primeng/api';
-import { Subscription } from 'rxjs';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { Confirmation, ConfirmationService, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
+import { Subscription } from 'rxjs';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/button";
@@ -15,26 +16,64 @@ export declare class ConfirmPopup implements AfterContentInit, OnDestroy {
     config: PrimeNGConfig;
     overlayService: OverlayService;
     private document;
-    key: string;
+    /**
+     * Optional key to match the key of confirm object, necessary to use when component tree has multiple confirm dialogs.
+     * @group Props
+     */
+    key: string | undefined;
+    /**
+     * Element to receive the focus when the popup gets visible, valid values are "accept", "reject", and "none".
+     * @group Props
+     */
     defaultFocus: string;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    style: any;
-    styleClass: string;
-    templates: QueryList<any>;
-    container: HTMLDivElement;
-    subscription: Subscription;
-    confirmation: Confirmation;
-    acceptIconTemplate: TemplateRef<any>;
-    rejectIconTemplate: TemplateRef<any>;
-    _visible: boolean;
-    documentClickListener: VoidFunction | null;
-    documentResizeListener: VoidFunction | null;
-    scrollHandler: ConnectedOverlayScrollHandler | null;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Defines if the component is visible.
+     * @group Props
+     */
     get visible(): any;
     set visible(value: any);
+    templates: QueryList<PrimeTemplate> | undefined;
+    container: Nullable<HTMLDivElement>;
+    subscription: Subscription;
+    confirmation: Nullable<Confirmation>;
+    acceptIconTemplate: Nullable<TemplateRef<any>>;
+    rejectIconTemplate: Nullable<TemplateRef<any>>;
+    _visible: boolean | undefined;
+    documentClickListener: VoidListener;
+    documentResizeListener: VoidListener;
+    scrollHandler: Nullable<ConnectedOverlayScrollHandler>;
     private window;
     constructor(el: ElementRef, confirmationService: ConfirmationService, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, overlayService: OverlayService, document: Document);
     ngAfterContentInit(): void;
@@ -45,7 +84,7 @@ export declare class ConfirmPopup implements AfterContentInit, OnDestroy {
     hide(): void;
     accept(): void;
     reject(): void;
-    onOverlayClick(event: any): void;
+    onOverlayClick(event: MouseEvent): void;
     bindListeners(): void;
     unbindListeners(): void;
     bindDocumentClickListener(): void;

package/confirmpopup/confirmpopup.interface.d.ts

@@ -0,0 +1,15 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in ConfirmPopup.
+ * @group Templates
+ */
+export interface ConfirmPopupTemplates {
+    /**
+     * Custom template of rejecticon.
+     */
+    rejecticon: TemplateRef<any> | null;
+    /**
+     * Custom template of accepticon.
+     */
+    accepticon: TemplateRef<any> | null;
+}

package/confirmpopup/public_api.d.ts

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

package/contextmenu/contextmenu.d.ts

@@ -1,6 +1,7 @@
 import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
-import { ContextMenuService, MenuItem, PrimeNGConfig } from 'primeng/api';
+import { ContextMenuService, MenuItem, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { Subject, Subscription } from 'rxjs';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -9,24 +10,24 @@ import * as i4 from "primeng/tooltip";
 import * as i5 from "primeng/api";
 import * as i6 from "primeng/icons/angleright";
 export declare class ContextMenuSub {
-    item: MenuItem;
-    root: boolean;
+    item: MenuItem | undefined;
+    root: boolean | undefined;
     parentItemKey: any;
     leafClick: EventEmitter<any>;
-    sublistViewChild: ElementRef;
-    menuitemViewChild: ElementRef;
+    sublistViewChild: ElementRef | undefined;
+    menuitemViewChild: ElementRef | undefined;
     contextMenu: ContextMenu;
-    activeItemKey: string;
+    activeItemKey: Nullable<string>;
     hideTimeout: any;
-    activeItemKeyChangeSubscription: Subscription;
-    constructor(contextMenu: any);
+    activeItemKeyChangeSubscription: Subscription | undefined;
+    constructor(contextMenu: ContextMenu);
     ngOnInit(): void;
-    onItemMouseEnter(event: any, item: any, key: any): void;
-    onItemMouseLeave(event: any, item: any): void;
-    onItemClick(event: any, item: any, menuitem: any, key: any): void;
+    onItemMouseEnter(event: Event, item: MenuItem, key: string): void;
+    onItemMouseLeave(event: MouseEvent, item: MenuItem): void;
+    onItemClick(event: MouseEvent, item: MenuItem, menuitem: Element, key: string): void;
     onLeafClick(): void;
-    getKey(index: any): string;
-    isActive(key: any): boolean;
+    getKey(index: number): string;
+    isActive(key: string): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<ContextMenuSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ContextMenuSub, "p-contextMenuSub", never, { "item": { "alias": "item"; "required": false; }; "root": { "alias": "root"; "required": false; }; "parentItemKey": { "alias": "parentItemKey"; "required": false; }; }, { "leafClick": "leafClick"; }, never, never, false, never>;
 }
@@ -38,28 +39,74 @@ export declare class ContextMenu implements AfterViewInit, OnDestroy {
     zone: NgZone;
     contextMenuService: ContextMenuService;
     private config;
-    model: MenuItem[];
-    global: boolean;
-    target: any;
-    style: any;
-    styleClass: string;
-    appendTo: any;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Attaches the menu to document instead of a particular item.
+     * @group Props
+     */
+    global: boolean | undefined;
+    /**
+     * Local template variable name of the element to attach the context menu.
+     * @group Props
+     */
+    target: HTMLElement | string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
+    /**
+     * Event for which the menu must be displayed.
+     * @group Props
+     */
     triggerEvent: string;
+    /**
+     * Displays the popup menu.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Hides the popup menu.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    containerViewChild: ElementRef;
-    documentClickListener: VoidFunction | null;
-    documentTriggerListener: VoidFunction | null;
-    documentKeydownListener: VoidFunction | null;
-    windowResizeListener: VoidFunction | null;
-    triggerEventListener: VoidFunction | null;
+    containerViewChild: ElementRef | undefined;
+    documentClickListener: VoidListener;
+    documentTriggerListener: VoidListener;
+    documentKeydownListener: VoidListener;
+    windowResizeListener: VoidListener;
+    triggerEventListener: VoidListener;
     ngDestroy$: Subject<unknown>;
     preventDocumentDefault: boolean;
     private window;
-    templates: QueryList<any>;
-    submenuIconTemplate: TemplateRef<any>;
+    templates: QueryList<PrimeTemplate> | undefined;
+    submenuIconTemplate: TemplateRef<any> | undefined;
     constructor(document: Document, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, zone: NgZone, contextMenuService: ContextMenuService, config: PrimeNGConfig);
     ngAfterViewInit(): void;
     show(event?: MouseEvent): void;
@@ -67,19 +114,19 @@ export declare class ContextMenu implements AfterViewInit, OnDestroy {
     moveOnTop(): void;
     toggle(event?: MouseEvent): void;
     position(event?: MouseEvent): void;
-    positionSubmenu(sublist: any): void;
-    isItemMatched(menuitem: any): boolean;
-    findNextItem(menuitem: any, isRepeated?: any): any;
-    findPrevItem(menuitem: any, isRepeated?: any): any;
+    positionSubmenu(sublist: HTMLElement): void;
+    isItemMatched(menuitem: Element): boolean;
+    findNextItem(menuitem: Element, isRepeated?: boolean): any;
+    findPrevItem(menuitem: Element, isRepeated?: boolean): any;
     getActiveItem(): any;
     clearActiveItem(): void;
-    removeActiveFromSubLists(el: any): void;
-    removeActiveFromSublist(menuitem: any): void;
+    removeActiveFromSubLists(el: Element): void;
+    removeActiveFromSublist(menuitem: MenuItem): void;
     bindGlobalListeners(): void;
-    findModelItemFromKey(key: any): any;
-    handleItemClick(event: any, item: any, menuitem: any): void;
+    findModelItemFromKey(key: string): any;
+    handleItemClick(event: Event, item: any, menuitem: any): void;
     unbindGlobalListeners(): void;
-    onWindowResize(event: any): void;
+    onWindowResize(): void;
     isOutsideClicked(event: Event): boolean;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ContextMenu, never>;