primeng 16.0.0-rc.2 → 16.0.0

package/table/table.d.ts

@@ -3,7 +3,7 @@ import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEm
 import { BlockableUI, FilterMetadata, FilterService, LazyLoadMeta, OverlayService, PrimeNGConfig, PrimeTemplate, SelectItem, SortMeta, TableState } from 'primeng/api';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
 import { Scroller } from 'primeng/scroller';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { Subscription } from 'rxjs';
 import { TableColResizeEvent, TableColumnReorderEvent, TableContextMenuSelectEvent, TableEditCancelEvent, TableEditCompleteEvent, TableEditInitEvent, TableFilterEvent, TableHeaderCheckboxToggleEvent, TableLazyLoadEvent, TablePageEvent, TableRowCollapseEvent, TableRowExpandEvent, TableRowReorderEvent, TableRowSelectEvent, TableRowUnSelectEvent, TableSelectAllChangeEvent } from './table.interface';
 import { Nullable, VoidListener } from 'primeng/ts-helpers';
@@ -50,6 +50,10 @@ export declare class TableService {
     static ɵfac: i0.ɵɵFactoryDeclaration<TableService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TableService>;
 }
+/**
+ * Table displays data in tabular format.
+ * @group Components
+ */
 export declare class Table implements OnInit, AfterViewInit, AfterContentInit, BlockableUI, OnChanges {
     private document;
     private platformId;
@@ -292,9 +296,9 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
      */
     scrollable: boolean | undefined;
     /**
-     * @deprecated Property is obselete since v14.2.0.
      * Orientation of the scrolling, options are "vertical", "horizontal" and "both".
      * @group Props
+     * @deprecated Property is obselete since v14.2.0.
      */
     scrollDirection: 'vertical' | 'horizontal' | 'both';
     /**
@@ -333,9 +337,9 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
      */
     frozenWidth: string | undefined;
     /**
-     * @deprecated table is always responsive with scrollable behavior.
      * Defines if the table is responsive.
      * @group Props
+     * @deprecated table is always responsive with scrollable behavior.
      */
     get responsive(): boolean | undefined | null;
     set responsive(val: boolean | undefined | null);
@@ -508,10 +512,10 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
     selectAllChange: EventEmitter<TableSelectAllChangeEvent>;
     /**
      * Callback to invoke on selection changed.
-     * @param {*} any - selected data.
+     * @param {any | null} value - selected data.
      * @group Emits
      */
-    selectionChange: EventEmitter<any>;
+    selectionChange: EventEmitter<any | null>;
     /**
      * Callback to invoke when a row is selected.
      * @param {TableRowSelectEvent} event - custom select event.
@@ -612,7 +616,7 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
     onHeaderCheckboxToggle: EventEmitter<TableHeaderCheckboxToggleEvent>;
     /**
      * A function to implement custom sorting, refer to sorting section for details.
-     * @param {*} any - sort meta.
+     * @param {any} any - sort meta.
      * @group Emits
      */
     sortFunction: EventEmitter<any>;
@@ -624,10 +628,10 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
     firstChange: EventEmitter<number>;
     /**
      * Callback to invoke on rows change.
-     * @param {*} array - rows data.
+     * @param {number} number - Row count.
      * @group Emits
      */
-    rowsChange: EventEmitter<any>;
+    rowsChange: EventEmitter<number>;
     /**
      * Callback to invoke table state is saved.
      * @param {TableState} object - table state.
@@ -651,9 +655,9 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
     scroller: Nullable<Scroller>;
     templates: Nullable<QueryList<PrimeTemplate>>;
     /**
-     * @deprecated use virtualScrollItemSize property instead.
      * Indicates the height of rows to be scrolled.
      * @group Props
+     * @deprecated use virtualScrollItemSize property instead.
      */
     get virtualRowHeight(): number;
     set virtualRowHeight(val: number);
@@ -776,26 +780,26 @@ export declare class Table implements OnInit, AfterViewInit, AfterContentInit, B
     getExportHeader(column: any): any;
     /**
      * Data export method.
-     * @param {Object} object - export options.
-     * @group Methods
+     * @param {Object} object - Export options.
+     * @group Method
      */
     exportCSV(options?: any): void;
     onLazyItemLoad(event: LazyLoadMeta): void;
     /**
      * Resets scroll to top.
-     * @group Methods
+     * @group Method
      */
     resetScrollTop(): void;
     /**
      * Scrolls to given index when using virtual scroll.
      * @param {number} index - index of the element.
-     * @group Methods
+     * @group Method
      */
     scrollToVirtualIndex(index: number): void;
     /**
      * Scrolls to given index.
      * @param {ScrollToOptions} options - scroll options.
-     * @group Methods
+     * @group Method
      */
     scrollTo(options: any): void;
     updateEditingCell(cell: any, data: any, field: string, index: number): void;

package/table/table.interface.d.ts

@@ -4,6 +4,7 @@ import { TemplateRef } from '@angular/core';
  * Custom select event.
  * @see {@link Table.onRowSelect}
  * @extends {LazyLoadMeta}
+ * @group Events
  */
 export interface TableRowSelectEvent {
     /**
@@ -27,6 +28,7 @@ export interface TableRowSelectEvent {
  * Custom unselect event.
  * @see {@link Table.onRowUnselect}
  * @extends {TableRowSelectEvent}
+ * @group Events
  */
 export interface TableRowUnSelectEvent extends TableRowSelectEvent {
 }
@@ -47,6 +49,7 @@ export interface TablePageEvent {
 /**
  * Custom filter event.
  * @see {@link Table.onFilter}
+ * @group Events
  */
 export interface TableFilterEvent {
     /**
@@ -64,6 +67,7 @@ export interface TableFilterEvent {
  * Custom lazy load event.
  * @see {@link Table.onLazyLoad}
  * @extends {LazyLoadMeta}
+ * @group Events
  */
 export interface TableLazyLoadEvent extends LazyLoadMeta {
     /**
@@ -78,6 +82,7 @@ export interface TableLazyLoadEvent extends LazyLoadMeta {
 /**
  * Custom row expand event.
  * @see {@link Table.onRowExpand}
+ * @group Events
  */
 export interface TableRowExpandEvent {
     /**
@@ -93,12 +98,14 @@ export interface TableRowExpandEvent {
  * Custom row collapse event.
  * @see {@link Table.onRowCollapse}
  * @extends {TableRowExpandEvent}
+ * @group Events
  */
 export interface TableRowCollapseEvent extends TableRowExpandEvent {
 }
 /**
  * Custom context menu select event.
  * @see {@link Table.onContextMenuSelect}
+ * @group Events
  */
 export interface TableContextMenuSelectEvent {
     /**
@@ -117,6 +124,7 @@ export interface TableContextMenuSelectEvent {
 /**
  * Custom context menu selection change event.
  * @see {@link Table.contextMenuSelectionChange}
+ * @group Events
  */
 export interface TableContextMenuSelectionChangeEvent {
     /**
@@ -127,6 +135,7 @@ export interface TableContextMenuSelectionChangeEvent {
 /**
  * Custom column resize event.
  * @see {@link Table.onColResize}
+ * @group Events
  */
 export interface TableColResizeEvent {
     /**
@@ -141,6 +150,7 @@ export interface TableColResizeEvent {
 /**
  * Custom column reorder event.
  * @see {@link Table.onColReorder}
+ * @group Events
  */
 export interface TableColumnReorderEvent {
     /**
@@ -159,6 +169,7 @@ export interface TableColumnReorderEvent {
 /**
  * Custom row reorder event.
  * @see {@link Table.onRowReorder}
+ * @group Events
  */
 export interface TableRowReorderEvent {
     /**
@@ -172,6 +183,7 @@ export interface TableRowReorderEvent {
 }
 /**
  * Custom edit event.
+ * @group Events
  */
 export interface TableEditEvent {
     /**
@@ -186,6 +198,7 @@ export interface TableEditEvent {
 /**
  * Custom edit init event.
  * @see {@link Table.onEditInit}
+ * @group Events
  */
 export interface TableEditInitEvent extends TableEditEvent {
     /**
@@ -196,6 +209,7 @@ export interface TableEditInitEvent extends TableEditEvent {
 /**
  * Custom edit cancel event.
  * @see {@link Table.onEditCancel}
+ * @group Events
  */
 export interface TableEditCancelEvent extends TableEditEvent {
     /**
@@ -210,12 +224,14 @@ export interface TableEditCancelEvent extends TableEditEvent {
 /**
  * Custom edit complete event.
  * @see {@link Table.onEditComplete}
+ * @group Events
  */
 export interface TableEditCompleteEvent extends TableEditCancelEvent {
 }
 /**
  * Custom checkbox toggle event.
  * @see {@link Table.onHeaderCheckboxToggle}
+ * @group Events
  */
 export interface TableHeaderCheckboxToggleEvent {
     /**
@@ -230,6 +246,7 @@ export interface TableHeaderCheckboxToggleEvent {
 /**
  * Custom all selection change event.
  * @see {@link Table.selectAllChange}
+ * @group Events
  */
 export interface TableSelectAllChangeEvent {
     /**
@@ -249,12 +266,33 @@ export interface TableTemplates {
     /**
      * Custom caption template.
      */
-    caption: TemplateRef<any>;
+    caption(): TemplateRef<any>;
     /**
      * Custom grouped header template.
-     * @param {TableRowContext} context - row data.
+     * @param {Object} context - row data.
      */
-    headergrouped: TemplateRef<TableRowContext>;
+    headergrouped(context: {
+        /**
+         * Row data.
+         */
+        $implicit?: any;
+        /**
+         * Row index.
+         */
+        rowIndex?: number;
+        /**
+         * Columns.
+         */
+        columns?: any[];
+        /**
+         * Editing state.
+         */
+        editing?: boolean;
+        /**
+         * Frozen state.
+         */
+        frozen?: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom grouped header template.
      * @param {Object} context - header data.
@@ -286,9 +324,18 @@ export interface TableTemplates {
     }>;
     /**
      * Custom loading body template.
-     * @param {TableLoadingBodyContext} context - loading body data.
+     * @param {Object} context - loading body data.
      */
-    loadingbody: TemplateRef<TableLoadingBodyContext>;
+    loadingbody(context: {
+        /**
+         * Row span.
+         */
+        rowspan?: number;
+        /**
+         * Row group.
+         */
+        rowgroup?: number;
+    }): TemplateRef<any>;
     /**
      * Custom footer template.
      * @param {Object} context - footer data.
@@ -324,53 +371,142 @@ export interface TableTemplates {
     /**
      * Custom summary template.
      */
-    summary: TemplateRef<any>;
+    summary(): TemplateRef<any>;
     /**
      * Custom expanded row template.
-     * @param {TableExpandedRowContext} context - expanded row data.
+     * @param {Object} context - expanded row data.
      */
-    rowexpansion: TemplateRef<TableExpandedRowContext>;
+    rowexpansion(context: {
+        /**
+         * Row span.
+         */
+        rowspan?: number;
+        /**
+         * Row group.
+         */
+        rowgroup?: number;
+        /**
+         * Expanded state.
+         */
+        expanded: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom group header template.
-     * @param {TableRowContext} context - row data.
+     * @param {Object} context - row data.
      */
-    groupheader: TemplateRef<TableRowContext>;
+    groupheader(context: {
+        /**
+         * Row data.
+         */
+        $implicit?: any;
+        /**
+         * Row index.
+         */
+        rowIndex?: number;
+        /**
+         * Columns.
+         */
+        columns?: any[];
+        /**
+         * Editing state.
+         */
+        editing?: boolean;
+        /**
+         * Frozen state.
+         */
+        frozen?: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom group footer template.
      * @param {TableRowContext} context - row data.
      */
-    groupfooter: TemplateRef<TableRowContext>;
+    groupfooter(context: {
+        /**
+         * Row data.
+         */
+        $implicit?: any;
+        /**
+         * Row index.
+         */
+        rowIndex?: number;
+        /**
+         * Columns.
+         */
+        columns?: any[];
+        /**
+         * Editing state.
+         */
+        editing?: boolean;
+        /**
+         * Frozen state.
+         */
+        frozen?: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom frozen header template.
      * @param {*} context - columns.
      */
-    frozenheader: TemplateRef<{
+    frozenheader(): TemplateRef<{
         $implicit: any[];
     }>;
     /**
      * Custom frozen body template.
-     * @param {TableRowContext} context - row data.
+     * @param {Object} context - row data.
      */
-    frozenbody: TemplateRef<TableRowContext>;
+    frozenbody(context: {
+        /**
+         * Row data.
+         */
+        $implicit?: any;
+        /**
+         * Row index.
+         */
+        rowIndex?: number;
+        /**
+         * Columns.
+         */
+        columns?: any[];
+        /**
+         * Editing state.
+         */
+        editing?: boolean;
+        /**
+         * Frozen state.
+         */
+        frozen?: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom frozen footer template.
      * @param {*} context - columns.
      */
-    frozenfooter: TemplateRef<{
+    frozenfooter(): TemplateRef<{
         $implicit: any[];
     }>;
     /**
      * Custom frozen column group template.
      * @param {*} context - columns.
      */
-    frozencolgroup: TemplateRef<{
+    frozencolgroup(): TemplateRef<{
         $implicit: any[];
     }>;
     /**
      * Custom frozen expanded row template.
-     * @param {*} context - row data.
+     * @param {Object} context - row data.
      */
-    frozenrowexpansion: TemplateRef<TableExpandedRowContext>;
+    frozenrowexpansion(context: {
+        /**
+         * Row span.
+         */
+        rowspan?: number;
+        /**
+         * Row group.
+         */
+        rowgroup?: number;
+        /**
+         * Expanded state.
+         */
+        expanded: boolean;
+    }): TemplateRef<any>;
     /**
      * Custom empty message template.
      */
@@ -390,43 +526,43 @@ export interface TableTemplates {
     /**
      * Custom paginator left template.
      */
-    paginatorleft: TemplateRef<any>;
+    paginatorleft(): TemplateRef<any>;
     /**
      * Custom paginator right template.
      */
-    paginatorright: TemplateRef<any>;
+    paginatorright(): TemplateRef<any>;
     /**
      * Custom paginator dropdown item template.
      */
-    paginatordropdownitem: TemplateRef<any>;
+    paginatordropdownitem(): TemplateRef<any>;
     /**
      * Custom paginator first page link icon template.
      */
-    paginatorfirstpagelinkicon: TemplateRef<any>;
+    paginatorfirstpagelinkicon(): TemplateRef<any>;
     /**
      * Custom paginator last page link icon template.
      */
-    paginatorlastpagelinkicon: TemplateRef<any>;
+    paginatorlastpagelinkicon(): TemplateRef<any>;
     /**
      * Custom paginator previous page link icon template.
      */
-    paginatorpreviouspagelinkicon: TemplateRef<any>;
+    paginatorpreviouspagelinkicon(): TemplateRef<any>;
     /**
      * Custom paginator next page link icon template.
      */
-    paginatornextpagelinkicon: TemplateRef<any>;
+    paginatornextpagelinkicon(): TemplateRef<any>;
     /**
      * Custom loading icon template.
      */
-    loadingicon: TemplateRef<any>;
+    loadingicon(): TemplateRef<any>;
     /**
      * Custom reorder indicator up icon template.
      */
-    reorderindicatorupicon: TemplateRef<any>;
+    reorderindicatorupicon(): TemplateRef<any>;
     /**
      * Custom reorder indicator down icon template.
      */
-    reorderindicatordownicon: TemplateRef<any>;
+    reorderindicatordownicon(): TemplateRef<any>;
     /**
      * Custom sort icon template.
      */
@@ -468,47 +604,3 @@ export interface TableTemplates {
         $implicit: boolean;
     }>;
 }
-/**
- * Data of the header template.
- */
-export interface TableRowContext {
-    /**
-     * Row data.
-     */
-    $implicit?: any;
-    /**
-     * Row index.
-     */
-    rowIndex?: number;
-    /**
-     * Columns.
-     */
-    columns?: any[];
-    /**
-     * Editing state.
-     */
-    editing?: boolean;
-    /**
-     * Frozen state.
-     */
-    frozen?: boolean;
-}
-/**
- * Data of the loading body template.
- */
-export interface TableLoadingBodyContext extends TableRowContext {
-    /**
-     * Row span.
-     */
-    rowspan?: number;
-    /**
-     * Row group.
-     */
-    rowgroup?: number;
-}
-export interface TableExpandedRowContext extends TableRowContext {
-    /**
-     * Expanded state.
-     */
-    expanded: boolean;
-}

package/tabmenu/tabmenu.d.ts

@@ -10,6 +10,10 @@ import * as i4 from "primeng/ripple";
 import * as i5 from "primeng/tooltip";
 import * as i6 from "primeng/icons/chevronleft";
 import * as i7 from "primeng/icons/chevronright";
+/**
+ * TabMenu is a navigation component that displays items as tab headers.
+ * @group Components
+ */
 export declare class TabMenu implements AfterContentInit, AfterViewInit, AfterViewChecked, OnDestroy {
     private platformId;
     private router;
@@ -48,7 +52,7 @@ export declare class TabMenu implements AfterContentInit, AfterViewInit, AfterVi
     styleClass: string | undefined;
     /**
      * Event fired when a tab is selected.
-     * @param {MenuItem} event - item instance.
+     * @param {MenuItem} item - Menu item.
      * @group Emits
      */
     activeItemChange: EventEmitter<MenuItem>;

package/tabmenu/tabmenu.interface.d.ts

@@ -24,9 +24,9 @@ export interface TabMenuTemplates {
     /**
      * Custom template of nexticon.
      */
-    nexticon: TemplateRef<any> | null;
+    nexticon(): TemplateRef<any>;
     /**
      * Custom template of previousicon.
      */
-    previousicon: TemplateRef<any> | null;
+    previousicon(): TemplateRef<any>;
 }

package/tabview/tabview.d.ts

@@ -9,6 +9,10 @@ import * as i4 from "primeng/ripple";
 import * as i5 from "primeng/icons/times";
 import * as i6 from "primeng/icons/chevronleft";
 import * as i7 from "primeng/icons/chevronright";
+/**
+ * TabPanel is a helper component for TabView component.
+ * @group Components
+ */
 export declare class TabPanel implements AfterContentInit, OnDestroy {
     viewContainer: ViewContainerRef;
     cd: ChangeDetectorRef;
@@ -76,15 +80,15 @@ export declare class TabPanel implements AfterContentInit, OnDestroy {
     set header(header: string);
     /**
      * Left icon of the tabPanel.
-     * @deprecated since v15.4.2, use `lefticon` template instead.
      * @group Props
+     * @deprecated since v15.4.2, use `lefticon` template instead.
      */
     get leftIcon(): string;
     set leftIcon(leftIcon: string);
     /**
      * Left icon of the tabPanel.
-     * @deprecated since v15.4.2, use `righticon` template instead.
      * @group Props
+     * @deprecated since v15.4.2, use `righticon` template instead.
      */
     get rightIcon(): string | undefined;
     set rightIcon(rightIcon: string | undefined);
@@ -110,6 +114,10 @@ export declare class TabPanel implements AfterContentInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<TabPanel, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TabPanel, "p-tabPanel", never, { "closable": { "alias": "closable"; "required": false; }; "headerStyle": { "alias": "headerStyle"; "required": false; }; "headerStyleClass": { "alias": "headerStyleClass"; "required": false; }; "cache": { "alias": "cache"; "required": false; }; "tooltip": { "alias": "tooltip"; "required": false; }; "tooltipPosition": { "alias": "tooltipPosition"; "required": false; }; "tooltipPositionStyle": { "alias": "tooltipPositionStyle"; "required": false; }; "tooltipStyleClass": { "alias": "tooltipStyleClass"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "header": { "alias": "header"; "required": false; }; "leftIcon": { "alias": "leftIcon"; "required": false; }; "rightIcon": { "alias": "rightIcon"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
 }
+/**
+ * TabView is a container component to group content with tabs.
+ * @group Components
+ */
 export declare class TabView implements AfterContentInit, AfterViewChecked, OnDestroy, BlockableUI {
     private platformId;
     el: ElementRef;

package/tabview/tabview.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom tab change event.
  * @see {@link TabView.onChange}
+ * @group Events
  */
 export interface TabViewChangeEvent {
     /**
@@ -16,6 +17,7 @@ export interface TabViewChangeEvent {
 /**
  * Custom tab close event.
  * @see {@link TabView.onClose}
+ * @group Events
  */
 export interface TabViewCloseEvent {
     /**
@@ -39,37 +41,9 @@ export interface TabViewTemplates {
     /**
      * Previous button icon template for the scrollable component.
      */
-    previousicon: TemplateRef<any> | null;
+    previousicon(): TemplateRef<any>;
     /**
      * Next button icon template for the scrollable component.
      */
-    nexticon: TemplateRef<any> | null;
-}
-/**
- * Defines valid templates in TabPanel.
- * @group Templates
- */
-export interface TabPanelTemplates {
-    /**
-     * Custom header template.
-     *
-     */
-    header: TemplateRef<any> | null;
-    /**
-     * Custom content template(Default).
-     * @default
-     */
-    content: TemplateRef<any> | null;
-    /**
-     * Custom right icon template.
-     */
-    righticon: TemplateRef<any> | null;
-    /**
-     * Custom left icon template.
-     */
-    lefticon: TemplateRef<any> | null;
-    /**
-     * Custom close icon template.
-     */
-    closeicon: TemplateRef<any> | null;
+    nexticon(): TemplateRef<any>;
 }