primeng 16.0.0-rc.1 → 16.0.0

package/paginator/paginator.d.ts

@@ -1,5 +1,8 @@
-import { OnInit, ChangeDetectorRef, EventEmitter, TemplateRef, OnChanges, SimpleChanges, AfterContentInit, QueryList } from '@angular/core';
+import { OnInit, ChangeDetectorRef, EventEmitter, TemplateRef, OnChanges, SimpleChanges, AfterContentInit, QueryList, ElementRef } from '@angular/core';
 import { SelectItem } from 'primeng/api';
+import { PaginatorState } from './paginator.interface';
+import { Nullable } from 'primeng/ts-helpers';
+import { DropdownChangeEvent } from 'primeng/dropdown';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/dropdown";
@@ -11,35 +14,134 @@ import * as i7 from "primeng/icons/angledoubleleft";
 import * as i8 from "primeng/icons/angledoubleright";
 import * as i9 from "primeng/icons/angleleft";
 import * as i10 from "primeng/icons/angleright";
+/**
+ * Paginator is a generic component to display content in paged format.
+ * @group Components
+ */
 export declare class Paginator implements OnInit, AfterContentInit, OnChanges {
     private cd;
+    /**
+     * Number of page links to display.
+     * @group Props
+     */
     pageLinkSize: number;
-    onPageChange: EventEmitter<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;
+    /**
+     * Whether to show it even there is only one page.
+     * @group Props
+     */
     alwaysShow: boolean;
-    templateLeft: TemplateRef<any>;
-    templateRight: TemplateRef<any>;
-    dropdownAppendTo: any;
+    /**
+     * Target element to attach the dropdown 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
+     */
+    dropdownAppendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Template instance to inject into the left side of the paginator.
+     * @param {PaginatorState} context - Paginator state.
+     * @group Props
+     */
+    templateLeft: TemplateRef<PaginatorState> | undefined;
+    /**
+     * Template instance to inject into the right side of the paginator.
+     * @param {PaginatorState} context - Paginator state.
+     * @group Props
+     */
+    templateRight: TemplateRef<PaginatorState> | undefined;
+    /**
+     * Target element to attach the dropdown 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;
+    /**
+     * Dropdown height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value.
+     * @group Props
+     */
     dropdownScrollHeight: string;
+    /**
+     * Template of the current page report element. Available placeholders are {currentPage},{totalPages},{rows},{first},{last} and {totalRecords}
+     * @group Props
+     */
     currentPageReportTemplate: string;
-    showCurrentPageReport: boolean;
+    /**
+     * Whether to display current page report.
+     * @group Props
+     */
+    showCurrentPageReport: boolean | undefined;
+    /**
+     * When enabled, icons are displayed on paginator to go first and last page.
+     * @group Props
+     */
     showFirstLastIcon: boolean;
+    /**
+     * Number of total records.
+     * @group Props
+     */
     totalRecords: number;
+    /**
+     * Data count to display per page.
+     * @group Props
+     */
     rows: number;
-    rowsPerPageOptions: any[];
-    showJumpToPageDropdown: boolean;
-    showJumpToPageInput: boolean;
+    /**
+     * Array of integer/object values to display inside rows per page dropdown. A object that have 'showAll' key can be added to it to show all data. Exp; [10,20,30,{showAll:'All'}]
+     * @group Props
+     */
+    rowsPerPageOptions: any[] | undefined;
+    /**
+     * Whether to display a dropdown to navigate to any page.
+     * @group Props
+     */
+    showJumpToPageDropdown: boolean | undefined;
+    /**
+     * Whether to display a input to navigate to any page.
+     * @group Props
+     */
+    showJumpToPageInput: boolean | undefined;
+    /**
+     * Whether to show page links.
+     * @group Props
+     */
     showPageLinks: boolean;
-    dropdownItemTemplate: TemplateRef<any>;
-    templates: QueryList<any>;
-    firstPageLinkIconTemplate: TemplateRef<any>;
-    previousPageLinkIconTemplate: TemplateRef<any>;
-    lastPageLinkIconTemplate: TemplateRef<any>;
-    nextPageLinkIconTemplate: TemplateRef<any>;
-    pageLinks: number[];
-    pageItems: SelectItem[];
-    rowsPerPageItems: SelectItem[];
+    /**
+     * Template instance to inject into the dropdown item inside in the paginator.
+     * @param {Object} context - item instance.
+     * @group Props
+     */
+    dropdownItemTemplate: TemplateRef<{
+        $implicit: any;
+    }> | undefined;
+    /**
+     * Zero-relative number of the first row to be displayed.
+     * @group Props
+     */
+    get first(): number;
+    set first(val: number);
+    /**
+     * Callback to invoke when page changes, the event object contains information about the new state.
+     * @param {PaginatorState} event - Paginator state.
+     * @group Emits
+     */
+    onPageChange: EventEmitter<PaginatorState>;
+    templates: Nullable<QueryList<any>>;
+    firstPageLinkIconTemplate: Nullable<TemplateRef<any>>;
+    previousPageLinkIconTemplate: Nullable<TemplateRef<any>>;
+    lastPageLinkIconTemplate: Nullable<TemplateRef<any>>;
+    nextPageLinkIconTemplate: Nullable<TemplateRef<any>>;
+    pageLinks: number[] | undefined;
+    pageItems: SelectItem[] | undefined;
+    rowsPerPageItems: SelectItem[] | undefined;
     paginatorState: any;
     _first: number;
     _page: number;
@@ -47,8 +149,6 @@ export declare class Paginator implements OnInit, AfterContentInit, OnChanges {
     ngOnInit(): void;
     ngAfterContentInit(): void;
     ngOnChanges(simpleChange: SimpleChanges): void;
-    get first(): number;
-    set first(val: number);
     updateRowsPerPageOptions(): void;
     isFirstPage(): boolean;
     isLastPage(): boolean;
@@ -58,19 +158,19 @@ export declare class Paginator implements OnInit, AfterContentInit, OnChanges {
     changePage(p: number): void;
     updateFirst(): void;
     getPage(): number;
-    changePageToFirst(event: any): void;
-    changePageToPrev(event: any): void;
-    changePageToNext(event: any): void;
-    changePageToLast(event: any): void;
-    onPageLinkClick(event: any, page: any): void;
-    onRppChange(event: any): void;
-    onPageDropdownChange(event: any): void;
+    changePageToFirst(event: Event): void;
+    changePageToPrev(event: Event): void;
+    changePageToNext(event: Event): void;
+    changePageToLast(event: Event): void;
+    onPageLinkClick(event: Event, page: number): void;
+    onRppChange(event: Event): void;
+    onPageDropdownChange(event: DropdownChangeEvent): void;
     updatePaginatorState(): void;
     empty(): boolean;
     currentPage(): number;
     get currentPageReport(): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<Paginator, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Paginator, "p-paginator", never, { "pageLinkSize": { "alias": "pageLinkSize"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "alwaysShow": { "alias": "alwaysShow"; "required": false; }; "templateLeft": { "alias": "templateLeft"; "required": false; }; "templateRight": { "alias": "templateRight"; "required": false; }; "dropdownAppendTo": { "alias": "dropdownAppendTo"; "required": false; }; "dropdownScrollHeight": { "alias": "dropdownScrollHeight"; "required": false; }; "currentPageReportTemplate": { "alias": "currentPageReportTemplate"; "required": false; }; "showCurrentPageReport": { "alias": "showCurrentPageReport"; "required": false; }; "showFirstLastIcon": { "alias": "showFirstLastIcon"; "required": false; }; "totalRecords": { "alias": "totalRecords"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "rowsPerPageOptions": { "alias": "rowsPerPageOptions"; "required": false; }; "showJumpToPageDropdown": { "alias": "showJumpToPageDropdown"; "required": false; }; "showJumpToPageInput": { "alias": "showJumpToPageInput"; "required": false; }; "showPageLinks": { "alias": "showPageLinks"; "required": false; }; "dropdownItemTemplate": { "alias": "dropdownItemTemplate"; "required": false; }; "first": { "alias": "first"; "required": false; }; }, { "onPageChange": "onPageChange"; }, ["templates"], never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Paginator, "p-paginator", never, { "pageLinkSize": { "alias": "pageLinkSize"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "alwaysShow": { "alias": "alwaysShow"; "required": false; }; "dropdownAppendTo": { "alias": "dropdownAppendTo"; "required": false; }; "templateLeft": { "alias": "templateLeft"; "required": false; }; "templateRight": { "alias": "templateRight"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "dropdownScrollHeight": { "alias": "dropdownScrollHeight"; "required": false; }; "currentPageReportTemplate": { "alias": "currentPageReportTemplate"; "required": false; }; "showCurrentPageReport": { "alias": "showCurrentPageReport"; "required": false; }; "showFirstLastIcon": { "alias": "showFirstLastIcon"; "required": false; }; "totalRecords": { "alias": "totalRecords"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "rowsPerPageOptions": { "alias": "rowsPerPageOptions"; "required": false; }; "showJumpToPageDropdown": { "alias": "showJumpToPageDropdown"; "required": false; }; "showJumpToPageInput": { "alias": "showJumpToPageInput"; "required": false; }; "showPageLinks": { "alias": "showPageLinks"; "required": false; }; "dropdownItemTemplate": { "alias": "dropdownItemTemplate"; "required": false; }; "first": { "alias": "first"; "required": false; }; }, { "onPageChange": "onPageChange"; }, ["templates"], never, false, never>;
 }
 export declare class PaginatorModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<PaginatorModule, never>;

package/paginator/paginator.interface.d.ts

@@ -0,0 +1,33 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Paginator state.
+ * @group Interface
+ */
+export interface PaginatorState {
+    page?: number;
+    first?: number;
+    rows?: number;
+    pageCount?: number;
+}
+/**
+ * Defines valid templates in PaginatorTemplates.
+ * @group Templates
+ */
+export interface PaginatorTemplates {
+    /**
+     * Custom first page link icon template.
+     */
+    firstpagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom previous page link icon template.
+     */
+    previouspagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom last page link icon template.
+     */
+    lastpagelinkicon(): TemplateRef<any>;
+    /**
+     * Custom next page link icon template.
+     */
+    nextpagelinkicon(): TemplateRef<any>;
+}

package/paginator/public_api.d.ts

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

package/panel/panel.d.ts

@@ -1,44 +1,114 @@
 import { EventEmitter, ElementRef, QueryList, TemplateRef, AfterContentInit } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
 import { BlockableUI } from 'primeng/api';
+import { PanelAfterToggleEvent, PanelBeforeToggleEvent } from './panel.interface';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 import * as i3 from "primeng/ripple";
 import * as i4 from "primeng/icons/plus";
 import * as i5 from "primeng/icons/minus";
-type PanelIconPosition = 'start' | 'end' | 'center';
+/**
+ * Panel is a container with the optional content toggle feature.
+ * @group Components
+ */
 export declare class Panel implements AfterContentInit, BlockableUI {
     private el;
-    toggleable: boolean;
-    header: string;
-    collapsed: boolean;
-    style: any;
-    styleClass: string;
-    iconPos: PanelIconPosition;
-    expandIcon: string;
-    collapseIcon: string;
+    /**
+     * Defines if content of panel can be expanded and collapsed.
+     * @group Props
+     */
+    toggleable: boolean | undefined;
+    /**
+     * Header text of the panel.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Defines the initial state of panel content, supports one or two-way binding as well.
+     * @group Props
+     */
+    collapsed: 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;
+    /**
+     * Position of the icons.
+     * @group Props
+     */
+    iconPos: 'start' | 'end' | 'center';
+    /**
+     * Expand icon of the toggle button.
+     * @group Props
+     * @deprecated since v15.4.2, use `headericons` template instead.
+     */
+    expandIcon: string | undefined;
+    /**
+     * Collapse icon of the toggle button.
+     * @group Props
+     * @deprecated since v15.4.2, use `headericons` template instead.
+     */
+    collapseIcon: string | undefined;
+    /**
+     * Specifies if header of panel cannot be displayed.
+     * @group Props
+     * @deprecated since v15.4.2, use `headericons` template instead.
+     */
     showHeader: boolean;
-    toggler: string;
-    collapsedChange: EventEmitter<any>;
-    onBeforeToggle: EventEmitter<any>;
-    onAfterToggle: EventEmitter<any>;
+    /**
+     * Specifies the toggler element to toggle the panel content.
+     * @group Props
+     */
+    toggler: 'icon' | 'header';
+    /**
+     * Transition options of the animation.
+     * @group Props
+     */
     transitionOptions: string;
-    footerFacet: any;
-    templates: QueryList<any>;
-    iconTemplate: TemplateRef<any>;
-    animating: boolean;
-    headerTemplate: TemplateRef<any>;
-    contentTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    headerIconTemplate: TemplateRef<any>;
+    /**
+     * Emitted when the collapsed changes.
+     * @param {boolean} value - New Value.
+     * @group Emits
+     */
+    collapsedChange: EventEmitter<boolean>;
+    /**
+     * Callback to invoke before panel toggle.
+     * @param {PanelBeforeToggleEvent} event - Custom panel toggle event
+     * @group Emits
+     */
+    onBeforeToggle: EventEmitter<PanelBeforeToggleEvent>;
+    /**
+     * Callback to invoke after panel toggle.
+     * @param {PanelAfterToggleEvent} event - Custom panel toggle event
+     * @group Emits
+     */
+    onAfterToggle: EventEmitter<PanelAfterToggleEvent>;
+    footerFacet: Nullable<TemplateRef<any>>;
+    templates: Nullable<QueryList<PrimeTemplate>>;
+    iconTemplate: Nullable<TemplateRef<any>>;
+    animating: Nullable<boolean>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    headerIconTemplate: Nullable<TemplateRef<any>>;
     id: string;
     constructor(el: ElementRef);
     ngAfterContentInit(): void;
-    onHeaderClick(event: Event): void;
-    onIconClick(event: Event): void;
-    toggle(event: Event): boolean;
-    expand(event: any): void;
-    collapse(event: any): void;
+    onHeaderClick(event: MouseEvent): void;
+    onIconClick(event: MouseEvent): void;
+    toggle(event: MouseEvent): boolean;
+    expand(): void;
+    collapse(): void;
     getBlockableElement(): HTMLElement;
     onToggleDone(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<Panel, never>;
@@ -49,4 +119,3 @@ export declare class PanelModule {
     static ɵmod: i0.ɵɵNgModuleDeclaration<PanelModule, [typeof Panel], [typeof i1.CommonModule, typeof i2.SharedModule, typeof i3.RippleModule, typeof i4.PlusIcon, typeof i5.MinusIcon], [typeof Panel, typeof i2.SharedModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<PanelModule>;
 }
-export {};

package/panel/panel.interface.d.ts

@@ -0,0 +1,58 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom panel toggle event, emits before panel toggle.
+ * @see {@link Panel.onBeforeToggle}
+ * @group Events
+ */
+export interface PanelBeforeToggleEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Collapsed state of the panel.
+     */
+    collapsed: boolean | undefined;
+}
+/**
+ * Custom panel toggle event, emits after panel toggle.
+ * @see {@link Panel.onAfterToggle}
+ * @extends {PanelBeforeToggleEvent}
+ * @group Events
+ */
+export interface PanelAfterToggleEvent extends PanelBeforeToggleEvent {
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+export interface PanelTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom icons template of the panel toggler.
+     * @param {Object} context - header icon data.
+     */
+    headericons(context: {
+        /**
+         * Collapsed state as a boolean
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom icons template of the panel header.
+     */
+    icons(): TemplateRef<any>;
+}

package/panel/public_api.d.ts

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

package/panelmenu/panelmenu.d.ts

@@ -1,5 +1,5 @@
-import { ChangeDetectorRef, TemplateRef, AfterContentInit, QueryList } from '@angular/core';
-import { MenuItem } from 'primeng/api';
+import { AfterContentInit, ChangeDetectorRef, QueryList, TemplateRef } from '@angular/core';
+import { MenuItem, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -12,17 +12,17 @@ import * as i8 from "primeng/icons/chevronright";
 export declare class BasePanelMenuItem {
     private ref;
     constructor(ref: ChangeDetectorRef);
-    handleClick(event: any, item: any): void;
+    handleClick(event: Event, item: MenuItem): void;
 }
 export declare class PanelMenuSub extends BasePanelMenuItem {
     panelMenu: PanelMenu;
-    item: MenuItem;
-    expanded: boolean;
-    parentExpanded: boolean;
-    transitionOptions: string;
-    root: boolean;
+    item: MenuItem | undefined;
+    expanded: boolean | undefined;
+    parentExpanded: boolean | undefined;
+    transitionOptions: string | undefined;
+    root: boolean | undefined;
     constructor(ref: ChangeDetectorRef, panelMenu: PanelMenu);
-    onItemKeyDown(event: any): void;
+    onItemKeyDown(event: KeyboardEvent): void;
     getAnimation(): {
         value: string;
         params: {
@@ -33,23 +33,49 @@ export declare class PanelMenuSub extends BasePanelMenuItem {
     static ɵfac: i0.ɵɵFactoryDeclaration<PanelMenuSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<PanelMenuSub, "p-panelMenuSub", never, { "item": { "alias": "item"; "required": false; }; "expanded": { "alias": "expanded"; "required": false; }; "parentExpanded": { "alias": "parentExpanded"; "required": false; }; "transitionOptions": { "alias": "transitionOptions"; "required": false; }; "root": { "alias": "root"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * PanelMenu is a hybrid of Accordion and Tree components.
+ * @group Components
+ */
 export declare class PanelMenu extends BasePanelMenuItem implements AfterContentInit {
-    model: MenuItem[];
-    style: any;
-    styleClass: string;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Whether multiple tabs can be activated at the same time or not.
+     * @group Props
+     */
     multiple: boolean;
+    /**
+     * Transition options of the animation.
+     * @group Props
+     */
     transitionOptions: string;
-    templates: QueryList<any>;
-    submenuIconTemplate: TemplateRef<any>;
-    animating: boolean;
+    templates: QueryList<PrimeTemplate> | undefined;
+    submenuIconTemplate: TemplateRef<any> | undefined;
+    animating: boolean | undefined;
     constructor(ref: ChangeDetectorRef);
     ngAfterContentInit(): void;
     collapseAll(): void;
-    handleClick(event: any, item: any): void;
+    handleClick(event: MouseEvent, item: MenuItem): void;
     onToggleDone(): void;
-    onItemKeyDown(event: any): void;
-    visible(item: any): boolean;
-    getAnimation(item: any): {
+    onItemKeyDown(event: KeyboardEvent): void;
+    visible(item: MenuItem): boolean;
+    getAnimation(item: MenuItem): {
         value: string;
         params: {
             transitionParams: string;

package/panelmenu/panelmenu.interface.d.ts

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

package/panelmenu/public_api.d.ts

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