primeng 16.0.0-rc.1 → 16.0.0

package/megamenu/megamenu.d.ts

@@ -1,5 +1,6 @@
-import { ElementRef, Renderer2, ChangeDetectorRef, AfterContentInit, QueryList, TemplateRef } from '@angular/core';
-import { MegaMenuItem, MenuItem } from 'primeng/api';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { MegaMenuItem, MenuItem, PrimeTemplate } from 'primeng/api';
+import { VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -8,26 +9,48 @@ import * as i4 from "primeng/tooltip";
 import * as i5 from "primeng/api";
 import * as i6 from "primeng/icons/angledown";
 import * as i7 from "primeng/icons/angleright";
+/**
+ * MegaMenu is navigation component that displays submenus together.
+ * @group Components
+ */
 export declare class MegaMenu implements AfterContentInit {
     private document;
     private platformId;
     el: ElementRef;
     renderer: Renderer2;
     cd: ChangeDetectorRef;
-    model: MegaMenuItem[];
-    style: any;
-    styleClass: string;
-    orientation: string;
-    templates: QueryList<any>;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MegaMenuItem[] | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Defines the orientation.
+     * @group Props
+     */
+    orientation: 'horizontal' | 'vertical';
+    templates: QueryList<PrimeTemplate> | undefined;
     activeItem: any;
-    documentClickListener: () => void | null;
-    startTemplate: TemplateRef<any>;
-    endTemplate: TemplateRef<any>;
-    submenuIconTemplate: TemplateRef<any>;
+    documentClickListener: VoidListener;
+    startTemplate: TemplateRef<any> | undefined;
+    endTemplate: TemplateRef<any> | undefined;
+    submenuIconTemplate: TemplateRef<any> | undefined;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef);
     ngAfterContentInit(): void;
-    onCategoryMouseEnter(event: any, menuitem: MegaMenuItem): void;
-    onCategoryClick(event: any, item: MenuItem | MegaMenuItem): void;
+    onCategoryMouseEnter(event: MouseEvent, menuitem: MegaMenuItem): void;
+    onCategoryClick(event: MouseEvent, item: MenuItem | MegaMenuItem): void;
     itemClick(event: MouseEvent, item: MenuItem | MegaMenuItem): void;
     getColumnClass(menuitem: MegaMenuItem): any;
     bindDocumentClickListener(): void;

package/megamenu/megamenu.interface.d.ts

@@ -0,0 +1,19 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in MegaMenu.
+ * @group Templates
+ */
+export interface MegaMenuTemplates {
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<any>;
+}

package/megamenu/public_api.d.ts

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

package/menu/menu.d.ts

@@ -1,22 +1,27 @@
-import { ElementRef, OnDestroy, EventEmitter, Renderer2, ChangeDetectorRef } from '@angular/core';
+import { ElementRef, OnDestroy, EventEmitter, Renderer2, ChangeDetectorRef, TemplateRef } from '@angular/core';
 import { AnimationEvent } from '@angular/animations';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
 import { MenuItem, OverlayService, PrimeNGConfig } from 'primeng/api';
+import { VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
 import * as i3 from "primeng/ripple";
 import * as i4 from "primeng/tooltip";
 export declare class MenuItemContent {
-    item: MenuItem;
+    item: MenuItem | undefined;
     menu: Menu;
-    constructor(menu: any);
+    constructor(menu: Menu);
     onItemKeyDown(event: any): void;
     findNextItem(item: any): any;
     findPrevItem(item: any): any;
     static ɵfac: i0.ɵɵFactoryDeclaration<MenuItemContent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MenuItemContent, "[pMenuItemContent]", never, { "item": { "alias": "pMenuItemContent"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Menu is a navigation / command component that supports dynamic and static positioning.
+ * @group Components
+ */
 export declare class Menu implements OnDestroy {
     private document;
     private platformId;
@@ -25,28 +30,83 @@ export declare class Menu implements OnDestroy {
     private cd;
     config: PrimeNGConfig;
     overlayService: OverlayService;
-    model: MenuItem[];
-    popup: boolean;
-    style: any;
-    styleClass: string;
-    appendTo: any;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Defines if menu would displayed as a popup.
+     * @group Props
+     */
+    popup: boolean | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @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;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    containerViewChild: ElementRef;
+    /**
+     * Callback to invoke when overlay menu is shown.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Callback to invoke when overlay menu is hidden.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    container: HTMLDivElement;
-    scrollHandler: ConnectedOverlayScrollHandler | null;
-    documentClickListener: () => void | null;
-    documentResizeListener: () => void | null;
-    preventDocumentDefault: boolean;
+    container: HTMLDivElement | undefined;
+    scrollHandler: ConnectedOverlayScrollHandler | null | undefined;
+    documentClickListener: VoidListener;
+    documentResizeListener: VoidListener;
+    preventDocumentDefault: boolean | undefined;
     target: any;
-    visible: boolean;
-    relativeAlign: boolean;
+    visible: boolean | undefined;
+    relativeAlign: boolean | undefined;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, overlayService: OverlayService);
-    toggle(event: any): void;
+    /**
+     * Toggles the visibility of the popup menu.
+     * @param {Event} event - Browser event.
+     * @group Method
+     */
+    toggle(event: Event): void;
+    /**
+     * Displays the popup menu.
+     * @param {Event} event - Browser event.
+     * @group Method
+     */
     show(event: any): void;
     onOverlayAnimationStart(event: AnimationEvent): void;
     onOverlayAnimationEnd(event: AnimationEvent): void;
@@ -54,10 +114,14 @@ export declare class Menu implements OnDestroy {
     appendOverlay(): void;
     restoreOverlayAppend(): void;
     moveOnTop(): void;
+    /**
+     * Hides the popup menu.
+     * @group Method
+     */
     hide(): void;
     onWindowResize(): void;
     itemClick(event: MouseEvent, item: MenuItem): void;
-    onOverlayClick(event: any): void;
+    onOverlayClick(event: Event): void;
     bindDocumentClickListener(): void;
     unbindDocumentClickListener(): void;
     bindDocumentResizeListener(): void;

package/menubar/menubar.d.ts

@@ -1,5 +1,6 @@
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
-import { MenuItem, PrimeNGConfig } from 'primeng/api';
+import { MenuItem, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { VoidListener } from 'primeng/ts-helpers';
 import { Subject, Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
@@ -11,8 +12,8 @@ import * as i6 from "primeng/icons/bars";
 import * as i7 from "primeng/icons/angledown";
 import * as i8 from "primeng/icons/angleright";
 export declare class MenubarService {
-    autoHide: boolean;
-    autoHideDelay: number;
+    autoHide: boolean | undefined;
+    autoHideDelay: number | undefined;
     readonly mouseLeaves: Subject<boolean>;
     readonly mouseLeft$: import("rxjs").Observable<boolean>;
     static ɵfac: i0.ɵɵFactoryDeclaration<MenubarService, never>;
@@ -26,25 +27,25 @@ export declare class MenubarSub implements OnInit, OnDestroy {
     private cd;
     private menubarService;
     private menubar;
-    item: MenuItem;
-    root: boolean;
+    item: MenuItem | undefined;
+    root: boolean | undefined;
     autoZIndex: boolean;
     baseZIndex: number;
-    mobileActive: boolean;
-    autoDisplay: boolean;
+    mobileActive: boolean | undefined;
+    autoDisplay: boolean | undefined;
     get parentActive(): boolean;
     set parentActive(value: boolean);
     leafClick: EventEmitter<any>;
-    _parentActive: boolean;
-    documentClickListener: (event?: Event) => void | null;
+    _parentActive: boolean | undefined;
+    documentClickListener: VoidListener;
     menuHoverActive: boolean;
     activeItem: any;
-    mouseLeaveSubscriber: Subscription;
+    mouseLeaveSubscriber: Subscription | undefined;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, menubarService: MenubarService, menubar: Menubar);
     ngOnInit(): void;
-    onItemClick(event: any, item: any): void;
-    onItemMouseLeave(event: any, item: any): void;
-    onItemMouseEnter(event: any, item: any): void;
+    onItemClick(event: MouseEvent, item: MenuItem): void;
+    onItemMouseLeave(): void;
+    onItemMouseEnter(event: MouseEvent, item: MenuItem): void;
     onLeafClick(): void;
     bindDocumentClickListener(): void;
     unbindDocumentClickListener(): void;
@@ -52,6 +53,10 @@ export declare class MenubarSub implements OnInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<MenubarSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MenubarSub, "p-menubarSub", never, { "item": { "alias": "item"; "required": false; }; "root": { "alias": "root"; "required": false; }; "autoZIndex": { "alias": "autoZIndex"; "required": false; }; "baseZIndex": { "alias": "baseZIndex"; "required": false; }; "mobileActive": { "alias": "mobileActive"; "required": false; }; "autoDisplay": { "alias": "autoDisplay"; "required": false; }; "parentActive": { "alias": "parentActive"; "required": false; }; }, { "leafClick": "leafClick"; }, never, never, false, never>;
 }
+/**
+ * Menubar is a horizontal menu component.
+ * @group Components
+ */
 export declare class Menubar implements AfterContentInit, OnDestroy, OnInit {
     private document;
     private platformId;
@@ -60,28 +65,62 @@ export declare class Menubar implements AfterContentInit, OnDestroy, OnInit {
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
     private menubarService;
-    model: MenuItem[];
-    style: any;
-    styleClass: string;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    autoDisplay: boolean;
-    autoHide: boolean;
+    /**
+     * Whether to show a root submenu on mouse over.
+     * @group Props
+     */
+    autoDisplay: boolean | undefined;
+    /**
+     * Whether to hide a root submenu when mouse leaves.
+     * @group Props
+     */
+    autoHide: boolean | undefined;
+    /**
+     * Delay to hide the root submenu in milliseconds when mouse leaves.
+     * @group Props
+     */
     autoHideDelay: number;
-    templates: QueryList<any>;
-    menubutton: ElementRef;
-    rootmenu: MenubarSub;
-    startTemplate: TemplateRef<any>;
-    endTemplate: TemplateRef<any>;
-    menuIconTemplate: TemplateRef<any>;
-    submenuIconTemplate: TemplateRef<any>;
-    mobileActive: boolean;
-    outsideClickListener: (event?: Event) => void | null;
-    mouseLeaveSubscriber: Subscription;
+    templates: QueryList<PrimeTemplate> | undefined;
+    menubutton: ElementRef | undefined;
+    rootmenu: MenubarSub | undefined;
+    startTemplate: TemplateRef<any> | undefined;
+    endTemplate: TemplateRef<any> | undefined;
+    menuIconTemplate: TemplateRef<any> | undefined;
+    submenuIconTemplate: TemplateRef<any> | undefined;
+    mobileActive: boolean | undefined;
+    outsideClickListener: VoidListener;
+    mouseLeaveSubscriber: Subscription | undefined;
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, menubarService: MenubarService);
     ngOnInit(): void;
     ngAfterContentInit(): void;
-    toggle(event: any): void;
+    toggle(event: MouseEvent): void;
     bindOutsideClickListener(): void;
     hide(): void;
     onLeafClick(): void;

package/menubar/menubar.interface.d.ts

@@ -0,0 +1,23 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Menubar.
+ * @group Templates
+ */
+export interface MenubarTemplates {
+    /**
+     * Custom template of start.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<any>;
+    /**
+     * Custom template of menuicon.
+     */
+    menuicon(): TemplateRef<any>;
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon(): TemplateRef<any>;
+}

package/menubar/public_api.d.ts

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

package/message/message.d.ts

@@ -4,12 +4,38 @@ import * as i2 from "primeng/icons/check";
 import * as i3 from "primeng/icons/infocircle";
 import * as i4 from "primeng/icons/timescircle";
 import * as i5 from "primeng/icons/exclamationtriangle";
+/**
+ * Message groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class UIMessage {
-    severity: string;
-    text: string;
+    /**
+     * Severity level of the message.
+     * @group Props
+     */
+    severity: 'success' | 'info' | 'warn' | 'error' | string | undefined;
+    /**
+     * Text content.
+     * @group Props
+     */
+    text: string | undefined;
+    /**
+     * Whether displaying messages would be escaped or not.
+     * @group Props
+     */
     escape: boolean;
-    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;
     get icon(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<UIMessage, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<UIMessage, "p-message", never, { "severity": { "alias": "severity"; "required": false; }; "text": { "alias": "text"; "required": false; }; "escape": { "alias": "escape"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; }, {}, never, never, false, never>;

package/messages/messages.d.ts

@@ -1,5 +1,5 @@
-import { OnDestroy, EventEmitter, AfterContentInit, ElementRef, QueryList, TemplateRef, ChangeDetectorRef } from '@angular/core';
-import { Message, MessageService } from 'primeng/api';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, QueryList, TemplateRef } from '@angular/core';
+import { Message, MessageService, PrimeTemplate } from 'primeng/api';
 import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
@@ -9,33 +9,84 @@ import * as i4 from "primeng/icons/infocircle";
 import * as i5 from "primeng/icons/timescircle";
 import * as i6 from "primeng/icons/exclamationtriangle";
 import * as i7 from "primeng/icons/times";
+/**
+ * Messages is used to display alerts inline.
+ * @group Components
+ */
 export declare class Messages implements AfterContentInit, OnDestroy {
     messageService: MessageService;
     el: ElementRef;
     cd: ChangeDetectorRef;
+    /**
+     * An array of messages to display.
+     * @group Props
+     */
     set value(messages: Message[]);
+    /**
+     * Defines if message box can be closed by the click icon.
+     * @group Props
+     */
     closable: boolean;
-    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;
+    /**
+     * Whether displaying services messages are enabled.
+     * @group Props
+     */
     enableService: boolean;
-    key: string;
+    /**
+     * Id to match the key of the message to enable scoping in service based messaging.
+     * @group Props
+     */
+    key: string | undefined;
+    /**
+     * Whether displaying messages would be escaped or not.
+     * @group Props
+     */
     escape: boolean;
-    severity: string;
+    /**
+     * Severity level of the message.
+     * @group Props
+     */
+    severity: string | undefined;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    templates: QueryList<any>;
+    /**
+     * This function is executed when the value changes.
+     * @param {Message[]} value - messages value.
+     * @group Emits
+     */
     valueChange: EventEmitter<Message[]>;
-    messages: Message[];
-    messageSubscription: Subscription;
-    clearSubscription: Subscription;
+    templates: QueryList<PrimeTemplate> | undefined;
+    messages: Message[] | null | undefined;
+    messageSubscription: Subscription | undefined;
+    clearSubscription: Subscription | undefined;
     timerSubscriptions: Subscription[];
-    contentTemplate: TemplateRef<any>;
+    contentTemplate: TemplateRef<any> | undefined;
     constructor(messageService: MessageService, el: ElementRef, cd: ChangeDetectorRef);
     ngAfterContentInit(): void;
     hasMessages(): boolean;
     clear(): void;
     removeMessage(i: number): void;
-    get icon(): string;
+    get icon(): string | null;
     ngOnDestroy(): void;
     private startMessageLifes;
     private startMessageLife;

package/messages/messages.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Messages.
+ * @group Templates
+ */
+export interface MessagesTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+}

package/messages/public_api.d.ts

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