primeng 16.0.0-rc.2 → 16.0.0

package/api/treenode.d.ts

@@ -1,22 +1,77 @@
 /**
  * Represents a node in a tree data structure.
+ * @group Interface
  */
-export interface TreeNode<T = any> {
+export interface TreeNode {
+    /**
+     * Label of the node.
+     */
     label?: string;
-    data?: T;
+    /**
+     * Data represented by the node.
+     */
+    data?: any;
+    /**
+     * Icon of the node to display next to content.
+     */
     icon?: string;
-    expandedIcon?: any;
-    collapsedIcon?: any;
-    children?: TreeNode<T>[];
+    /**
+     * Icon to use in expanded state.
+     */
+    expandedIcon?: string;
+    /**
+     * Icon to use in collapsed state.
+     */
+    collapsedIcon?: string;
+    /**
+     * An array of treenodes as children.
+     */
+    children?: TreeNode[];
+    /**
+     * Specifies if the node has children. Used in lazy loading.
+     * @defaultValue false
+     */
     leaf?: boolean;
+    /**
+     * Expanded state of the node.
+     * @defaultValue false
+     */
     expanded?: boolean;
+    /**
+     * Type of the node to match a template.
+     */
     type?: string;
-    parent?: TreeNode<T>;
+    /**
+     * Parent of the node.
+     */
+    parent?: TreeNode;
+    /**
+     * Defines if value is partially selected.
+     */
     partialSelected?: boolean;
-    style?: string;
+    /**
+     * Inline style of the node.
+     */
+    style?: any;
+    /**
+     * Style class of the node.
+     */
     styleClass?: string;
+    /**
+     * Defines if the node is draggable.
+     */
     draggable?: boolean;
+    /**
+     * Defines if the node is droppable.
+     */
     droppable?: boolean;
+    /**
+     * Whether the node is selectable when selection mode is enabled.
+     * @defaultValue false
+     */
     selectable?: boolean;
+    /**
+     * Mandatory unique key of the node.
+     */
     key?: string;
 }

package/api/treenodedragevent.d.ts

@@ -1,11 +1,27 @@
 import { TreeNode } from './treenode';
 /**
  * Represents the event data for a tree node drag operation.
+ * @group Interface
  */
 export interface TreeNodeDragEvent {
+    /**
+     * Tree instance.
+     */
     tree?: any;
+    /**
+     * Node to be dragged.
+     */
     node?: TreeNode;
+    /**
+     * Child nodes of dragged node.
+     */
     subNodes?: TreeNode[];
+    /**
+     * Index of dragged node.
+     */
     index?: number;
+    /**
+     * Scope of dragged node.
+     */
     scope?: any;
 }

package/api/treetablenode.d.ts

@@ -0,0 +1,36 @@
+import { TreeNode } from './treenode';
+/**
+ * Tree table node element.
+ * @extends {TreeNode}
+ * @group Interface
+ */
+export interface TreeTableNode extends TreeNode {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Row of the node.
+     */
+    rowNode?: any;
+    /**
+     * Node instance.
+     */
+    node?: TreeNode;
+    /**
+     * Selection type.
+     */
+    type?: string;
+    /**
+     * Node index.
+     */
+    index?: number;
+    /**
+     * Node level.
+     */
+    level?: number;
+    /**
+     * Boolean value indicates if node is in viewport.
+     */
+    visible?: boolean;
+}

package/autocomplete/autocomplete.d.ts

@@ -5,7 +5,7 @@ import { OverlayOptions, OverlayService, PrimeNGConfig, PrimeTemplate } from 'pr
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
 import { Overlay } from 'primeng/overlay';
 import { Scroller } from 'primeng/scroller';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import { AutoCompleteCompleteEvent, AutoCompleteDropdownClickEvent, AutoCompleteLazyLoadEvent } from './autocomplete.interface';
 import * as i0 from "@angular/core";
@@ -22,6 +22,10 @@ import * as i10 from "primeng/icons/spinner";
 import * as i11 from "primeng/icons/times";
 import * as i12 from "primeng/icons/chevrondown";
 export declare const AUTOCOMPLETE_VALUE_ACCESSOR: any;
+/**
+ * AutoComplete is an input component that provides real-time suggestions when being typed.
+ * @group Components
+ */
 export declare class AutoComplete implements AfterViewChecked, AfterContentInit, OnDestroy, ControlValueAccessor {
     private document;
     el: ElementRef;
@@ -294,9 +298,9 @@ export declare class AutoComplete implements AfterViewChecked, AfterContentInit,
     get suggestions(): any[];
     set suggestions(value: any[]);
     /**
-     * @deprecated use virtualScrollItemSize property instead.
      * Element dimensions of option for virtual scrolling.
      * @group Props
+     * @deprecated use virtualScrollItemSize property instead.
      */
     get itemSize(): number;
     set itemSize(val: number);

package/autocomplete/autocomplete.interface.d.ts

@@ -1,8 +1,9 @@
 import { TemplateRef } from '@angular/core';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 /**
  * Custom complete event.
  * @see {@link AutoComplete.completeMethod}
+ * @group Events
  */
 export interface AutoCompleteCompleteEvent {
     /**
@@ -17,6 +18,7 @@ export interface AutoCompleteCompleteEvent {
 /**
  * Custom click event.
  * @see {@link AutoComplete.onDropdownClick}
+ * @group Events
  */
 export interface AutoCompleteDropdownClickEvent {
     /**
@@ -31,6 +33,7 @@ export interface AutoCompleteDropdownClickEvent {
 /**
  * Custom lazy load event.
  * @see {@link AutoComplete.onLazyLoad}
+ * @group Events
  */
 export interface AutoCompleteLazyLoadEvent {
     /**
@@ -91,15 +94,15 @@ export interface AutoCompleteTemplates {
     /**
      * Custom header template.
      */
-    header: TemplateRef<any>;
+    header(): TemplateRef<any>;
     /**
      * Custom empty template.
      */
-    empty: TemplateRef<any>;
+    empty(): TemplateRef<any>;
     /**
      * Custom footer template.
      */
-    footer: TemplateRef<any>;
+    footer(): TemplateRef<any>;
     /**
      * Custom loader template.
      * @param {Object} context - scroller options.
@@ -115,17 +118,17 @@ export interface AutoCompleteTemplates {
     /**
      * Custom remove token icon template.
      */
-    removetokenicon: TemplateRef<any>;
+    removetokenicon(): TemplateRef<any>;
     /**
      * Custom loading icon template.
      */
-    loadingicon: TemplateRef<any>;
+    loadingicon(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any>;
+    clearicon(): TemplateRef<any>;
     /**
      * Custom dropdown icon template.
      */
-    dropdownicon: TemplateRef<any>;
+    dropdownicon(): TemplateRef<any>;
 }

package/autofocus/autofocus.d.ts

@@ -1,6 +1,10 @@
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * AutoFocus manages focus on focusable element on load.
+ * @group Components
+ */
 export declare class AutoFocus {
     private host;
     constructor(host: ElementRef);

package/avatar/avatar.d.ts

@@ -1,6 +1,10 @@
 import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Avatar represents people using icons, labels and images.
+ * @group Components
+ */
 export declare class Avatar {
     /**
      * Defines the text to display.

package/avatargroup/avatargroup.d.ts

@@ -1,8 +1,13 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * AvatarGroup is a helper component for Avatar.
+ * @group Components
+ */
 export declare class AvatarGroup {
     /**
      * Style class of the component
+     * @group Props
      */
     styleClass: string | undefined;
     /**

package/badge/badge.d.ts

@@ -2,6 +2,10 @@ import { AfterViewInit, ElementRef, OnDestroy, Renderer2 } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
+/**
+ * Badge Directive is directive usage of badge component.
+ * @group Components
+ */
 export declare class BadgeDirective implements AfterViewInit, OnDestroy {
     private document;
     el: ElementRef;
@@ -46,6 +50,10 @@ export declare class BadgeDirective implements AfterViewInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<BadgeDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<BadgeDirective, "[pBadge]", never, { "iconPos": { "alias": "iconPos"; "required": false; }; "disabled": { "alias": "badgeDisabled"; "required": false; }; "size": { "alias": "size"; "required": false; }; "value": { "alias": "value"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Badge is a small status indicator for another element.
+ * @group Components
+ */
 export declare class Badge {
     /**
      * Class of the element.

package/blockui/blockui.d.ts

@@ -2,6 +2,10 @@ import { AfterViewInit, ChangeDetectorRef, ElementRef, OnDestroy, QueryList, Ren
 import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * BlockUI can either block other components or the whole page.
+ * @group Components
+ */
 export declare class BlockUI implements AfterViewInit, OnDestroy {
     private document;
     el: ElementRef;
@@ -10,7 +14,6 @@ export declare class BlockUI implements AfterViewInit, OnDestroy {
     private renderer;
     /**
      * Name of the local ng-template variable referring to another component.
-     * Default - document
      * @group Props
      */
     target: any;

package/blockui/blockui.interface.d.ts

@@ -7,5 +7,5 @@ export interface BlockUITemplates {
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
 }

package/breadcrumb/breadcrumb.d.ts

@@ -8,6 +8,10 @@ import * as i3 from "primeng/tooltip";
 import * as i4 from "primeng/icons/chevronright";
 import * as i5 from "primeng/icons/home";
 import * as i6 from "primeng/api";
+/**
+ * Breadcrumb provides contextual information about page hierarchy.
+ * @group Components
+ */
 export declare class Breadcrumb implements AfterContentInit {
     /**
      * An array of menuitems.

package/breadcrumb/breadcrumb.interface.d.ts

@@ -8,11 +8,12 @@ export interface BreadcumbTemplates {
     /**
      * Custom template of seperator.
      */
-    seperator: TemplateRef<any> | null;
+    seperator(): TemplateRef<any>;
 }
 /**
  * Custom select event.
  * @see {@link Breadcrumb.onItemClick}
+ * @group Events
  */
 export interface BreadcrumbItemClickEvent {
     /**

package/button/button.d.ts

@@ -6,6 +6,10 @@ import * as i2 from "primeng/ripple";
 import * as i3 from "primeng/api";
 import * as i4 from "primeng/icons/spinner";
 type ButtonIconPosition = 'left' | 'right' | 'top' | 'bottom';
+/**
+ * Button directive is an extension to button component.
+ * @group Components
+ */
 export declare class ButtonDirective implements AfterViewInit, OnDestroy {
     el: ElementRef;
     private document;
@@ -57,6 +61,10 @@ export declare class ButtonDirective implements AfterViewInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<ButtonDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<ButtonDirective, "[pButton]", never, { "iconPos": { "alias": "iconPos"; "required": false; }; "loadingIcon": { "alias": "loadingIcon"; "required": false; }; "label": { "alias": "label"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Button is an extension to standard button element with icons and theming.
+ * @group Components
+ */
 export declare class Button implements AfterContentInit {
     /**
      * Type of the button.

package/button/button.interface.d.ts

@@ -7,13 +7,13 @@ export interface ButtonTemplates {
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
     /**
      * Custom template of icon.
      */
-    icon: TemplateRef<any> | null;
+    icon(): TemplateRef<any>;
     /**
      * Custom template of loadingicon.
      */
-    loadingicon: TemplateRef<any> | null;
+    loadingicon(): TemplateRef<any>;
 }

package/calendar/calendar.d.ts

@@ -18,6 +18,10 @@ import * as i8 from "primeng/icons/chevrondown";
 import * as i9 from "primeng/icons/times";
 import * as i10 from "primeng/icons/calendar";
 export declare const CALENDAR_VALUE_ACCESSOR: any;
+/**
+ * Calendar also known as DatePicker, is a form component to work with dates.
+ * @group Components
+ */
 export declare class Calendar implements OnInit, OnDestroy, ControlValueAccessor {
     private document;
     el: ElementRef;
@@ -137,14 +141,14 @@ export declare class Calendar implements OnInit, OnDestroy, ControlValueAccessor
     shortYearCutoff: any;
     /**
      * Whether the month should be rendered as a dropdown instead of text.
-     * @deprecated Navigator is always on
      * @group Props
+     * @deprecated Navigator is always on.
      */
     monthNavigator: boolean | undefined;
     /**
      * Whether the year should be rendered as a dropdown instead of text.
-     * @deprecated  Navigator is always on.
      * @group Props
+     * @deprecated  Navigator is always on.
      */
     yearNavigator: boolean | undefined;
     /**
@@ -312,9 +316,9 @@ export declare class Calendar implements OnInit, OnDestroy, ControlValueAccessor
     get disabledDays(): number[];
     set disabledDays(disabledDays: number[]);
     /**
-     * @deprecated Years are based on decades by default.
      * The range of years displayed in the year drop-down in (nnnn:nnnn) format such as (2000:2020).
      * @group Props
+     * @deprecated Years are based on decades by default.
      */
     get yearRange(): string;
     set yearRange(yearRange: string);
@@ -343,8 +347,9 @@ export declare class Calendar implements OnInit, OnDestroy, ControlValueAccessor
     get firstDayOfWeek(): number;
     set firstDayOfWeek(firstDayOfWeek: number);
     /**
-     * No description available.
+     * Option to set calendar locale.
      * @group Props
+     * @deprecated Locale property has no effect, use new i18n API instead.
      */
     set locale(newLocale: LocaleSettings);
     /**
@@ -399,7 +404,7 @@ export declare class Calendar implements OnInit, OnDestroy, ControlValueAccessor
      * @param {Date} date - today as a date instance.
      * @group Emits
      */
-    onTodayClick: EventEmitter<any>;
+    onTodayClick: EventEmitter<Date>;
     /**
      * Callback to invoke when clear button is clicked.
      * @param {Event} event - browser event.

package/calendar/calendar.interface.d.ts

@@ -15,7 +15,7 @@ export interface CalendarTemplates {
         $implicit: Date;
     }): TemplateRef<{
         $implicit: Date;
-    }> | null;
+    }>;
     /**
      * Custom decade template
      * @param {Object} context - date value instance.
@@ -27,67 +27,115 @@ export interface CalendarTemplates {
         $implicit: Date;
     }): TemplateRef<{
         $implicit: Date;
-    }> | null;
+    }>;
     /**
      * Custom disabled date template.
      */
-    disabledDate: TemplateRef<any> | null;
+    disabledDate(): TemplateRef<any>;
     /**
      * Custom header template.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom previous icon template.
      */
-    previousicon: TemplateRef<any> | null;
+    previousicon(): TemplateRef<any>;
     /**
      * Custom next icon template.
      */
-    nexticon: TemplateRef<any> | null;
+    nexticon(): TemplateRef<any>;
     /**
      * Custom dropdown trigger icon template.
      */
-    triggericon: TemplateRef<any> | null;
+    triggericon(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any> | null;
+    clearicon(): TemplateRef<any>;
     /**
      * Custom decrement icon template.
      */
-    decrementicon: TemplateRef<any> | null;
+    decrementicon(): TemplateRef<any>;
     /**
      * Custom increment icon template.
      */
-    incrementicon: TemplateRef<any> | null;
+    incrementicon(): TemplateRef<any>;
     /**
      * Custom footer template.
      */
-    footer: TemplateRef<any> | null;
+    footer(): TemplateRef<any>;
 }
 /**
  * Locale settings options.
+ * @group Interface
  */
 export interface LocaleSettings {
+    /**
+     * Day value.
+     */
     firstDayOfWeek?: number;
+    /**
+     * Day names.
+     */
     dayNames?: string[];
+    /**
+     * Shortened day names.
+     */
     dayNamesShort?: string[];
+    /**
+     * Minimum days names.
+     */
     dayNamesMin?: string[];
+    /**
+     * Month names.
+     */
     monthNames?: string[];
+    /**
+     * Shortened month names.
+     */
     monthNamesShort?: string[];
+    /**
+     * Value of today date string.
+     */
     today?: string;
+    /**
+     * Clear.
+     */
     clear?: string;
+    /**
+     * Date format.
+     */
     dateFormat?: string;
+    /**
+     * Week header.
+     */
     weekHeader?: string;
 }
+/**
+ * Month interface.
+ * @group Interface
+ */
 export interface Month {
+    /**
+     * Mont value.
+     */
     month?: number;
+    /**
+     * Year value.
+     */
     year?: number;
-    dates?: Array<Date>;
+    /**
+     * Array of dates.
+     */
+    dates?: Date[];
+    /**
+     * Array of week numbers.
+     */
     weekNumbers?: number[];
 }
 /**
  * Custom Calendar responsive options metadata.
+ * @group Interface
  */
 export interface CalendarResponsiveOptions {
     /**
@@ -99,7 +147,15 @@ export interface CalendarResponsiveOptions {
      */
     numMonths?: number;
 }
+/**
+ * Custom type for the calendar views.
+ * @group Types
+ */
 export type CalendarTypeView = 'date' | 'month' | 'year';
+/**
+ * Custom type for the calendar navigation state.
+ * @group Types
+ */
 export type NavigationState = {
     backward?: boolean;
     button?: boolean;
@@ -107,6 +163,7 @@ export type NavigationState = {
 /**
  * Custom Calendar year change event.
  * @see {@link Calendar.onYearChange}
+ * @group Events
  */
 export interface CalendarYearChangeEvent {
     /**
@@ -121,6 +178,7 @@ export interface CalendarYearChangeEvent {
 /**
  * Custom Calendar month change event.
  * @see {@link Calendar.onMonthChange}
+ * @group Events
  */
 export interface CalendarMonthChangeEvent {
     /**

package/card/card.d.ts

@@ -3,6 +3,10 @@ import { BlockableUI, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
+/**
+ * Card is a flexible container component.
+ * @group Components
+ */
 export declare class Card implements AfterContentInit, BlockableUI {
     private el;
     /**

package/card/card.interface.d.ts

@@ -7,21 +7,21 @@ export interface CardTemplates {
     /**
      * Custom template of header.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom template of title.
      */
-    title: TemplateRef<any> | null;
+    title(): TemplateRef<any>;
     /**
      * Custom template of subtitle.
      */
-    subtitle: TemplateRef<any> | null;
+    subtitle(): TemplateRef<any>;
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
     /**
      * Custom template of footer.
      */
-    footer: TemplateRef<any> | null;
+    footer(): TemplateRef<any>;
 }