primeng 16.0.0-rc.2 → 16.0.0

package/dataview/dataview.interface.d.ts

@@ -1,6 +1,7 @@
 import { TemplateRef } from '@angular/core';
 /**
  * State of the paginator.
+ * @group Interface
  */
 export interface DataViewPaginatorState {
     /**
@@ -23,6 +24,7 @@ export interface DataViewPaginatorState {
 /**
  * Custom lazy load event.
  * @see {@link DataView.onLazyLoad}
+ * @group Events
  */
 export interface DataViewLazyLoadEvent {
     /**
@@ -45,6 +47,7 @@ export interface DataViewLazyLoadEvent {
 /**
  * Custom page event.
  * @see {@link DataView.onPage}
+ * @group Events
  */
 export interface DataViewPageEvent {
     /**
@@ -59,6 +62,7 @@ export interface DataViewPageEvent {
 /**
  * Custom sort event.
  * @see {@link DataView.onSort}
+ * @group Events
  */
 export interface DataViewSortEvent {
     /**
@@ -73,6 +77,7 @@ export interface DataViewSortEvent {
 /**
  * Custom layout change.
  * @see {@link DataView.onChangeLayout}
+ * @group Events
  */
 export interface DataViewLayoutChangeEvent {
     /**
@@ -154,25 +159,25 @@ export interface DataViewTemplates {
     /**
      * Custom empty message template.
      */
-    empty: TemplateRef<any>;
+    empty(): TemplateRef<any>;
     /**
      * Custom header template.
      */
-    header: TemplateRef<any>;
+    header(): TemplateRef<any>;
     /**
      * Custom footer template.
      */
-    footer: TemplateRef<any>;
+    footer(): TemplateRef<any>;
     /**
      * Custom loading icon template.
      */
-    loadingicon: TemplateRef<any>;
+    loadingicon(): TemplateRef<any>;
     /**
      * Custom list icon template.
      */
-    listicon: TemplateRef<any>;
+    listicon(): TemplateRef<any>;
     /**
      * Custom grid icon template.
      */
-    gridicon: TemplateRef<any>;
+    gridicon(): TemplateRef<any>;
 }

package/defer/defer.d.ts

@@ -2,6 +2,10 @@ import { AfterViewInit, ChangeDetectorRef, ElementRef, EmbeddedViewRef, EventEmi
 import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Defer postpones the loading the content that is initially not in the viewport until it becomes visible on scroll.
+ * @group Components
+ */
 export declare class DeferredLoader implements AfterViewInit, OnDestroy {
     private document;
     private platformId;
@@ -11,7 +15,7 @@ export declare class DeferredLoader implements AfterViewInit, OnDestroy {
     private cd;
     /**
      * Callback to invoke when deferred content is loaded.
-     * @param {Event} event - browser event.
+     * @param {Event} event - Browser event.
      * @group Emits
      */
     onLoad: EventEmitter<Event>;

package/dialog/dialog.d.ts

@@ -10,6 +10,10 @@ import * as i4 from "primeng/icons/times";
 import * as i5 from "primeng/icons/windowmaximize";
 import * as i6 from "primeng/icons/windowminimize";
 import * as i7 from "primeng/api";
+/**
+ * Dialog is a container to display content in an overlay window.
+ * @group Components
+ */
 export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
     private document;
     private platformId;
@@ -34,16 +38,16 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
      */
     resizable: boolean;
     /**
-     * @deprecated
      * Defines the left offset of dialog.
      * @group Props
+     * @deprecated positionLeft property is deprecated.
      */
     get positionLeft(): number;
     set positionLeft(_positionLeft: number);
     /**
-     * @deprecated
      * Defines the top offset of dialog.
      * @group Props
+     * @deprecated positionTop property is deprecated.
      */
     get positionTop(): number;
     set positionTop(_positionTop: number);
@@ -83,14 +87,14 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
      */
     closable: boolean;
     /**
-     * @deprecated
      * Defines if the component is responsive.
      * @group Props
+     * @deprecated Responsive property is deprecated.
      */
     get responsive(): boolean;
     set responsive(_responsive: boolean);
     /**
-     *  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).
+     * 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;
@@ -115,9 +119,9 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
      */
     showHeader: boolean;
     /**
-     * @deprecated
      * Defines the breakpoint of the component responsive.
      * @group Props
+     * @deprecated Breakpoint property is not utilized and deprecated. Use breakpoints or CSS media queries instead.
      */
     get breakpoint(): number;
     set breakpoint(_breakpoint: number);
@@ -200,8 +204,8 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
      * Specifies the visibility of the dialog.
      * @group Props
      */
-    get visible(): any;
-    set visible(value: any);
+    get visible(): boolean;
+    set visible(value: boolean);
     /**
      * Inline style of the component.
      * @group Props
@@ -265,7 +269,7 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
     maximizeIconTemplate: Nullable<TemplateRef<any>>;
     closeIconTemplate: Nullable<TemplateRef<any>>;
     minimizeIconTemplate: Nullable<TemplateRef<any>>;
-    _visible: boolean | undefined;
+    _visible: boolean;
     maskVisible: boolean | undefined;
     container: Nullable<HTMLDivElement>;
     wrapper: Nullable<HTMLElement>;

package/dialog/dialog.interface.d.ts

@@ -7,25 +7,25 @@ export interface DialogTemplates {
     /**
      * Custom template of header.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
     /**
      * Custom template of footer.
      */
-    footer: TemplateRef<any> | null;
+    footer(): TemplateRef<any>;
     /**
      * Custom template of closeicon.
      */
-    closeicon: TemplateRef<any> | null;
+    closeicon(): TemplateRef<any>;
     /**
      * Custom template of maximizeicon.
      */
-    maximizeicon: TemplateRef<any> | null;
+    maximizeicon(): TemplateRef<any>;
     /**
      * Custom template of minimizeicon.
      */
-    minimizeicon: TemplateRef<any> | null;
+    minimizeicon(): TemplateRef<any>;
 }

package/divider/divider.d.ts

@@ -1,5 +1,9 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Divider is used to separate contents.
+ * @group Components
+ */
 export declare class Divider {
     /**
      * Inline style of the component.

package/dock/dock.d.ts

@@ -6,6 +6,10 @@ import * as i2 from "@angular/router";
 import * as i3 from "primeng/ripple";
 import * as i4 from "primeng/tooltip";
 import * as i5 from "primeng/api";
+/**
+ * Dock is a navigation component consisting of menuitems.
+ * @group Components
+ */
 export declare class Dock implements AfterContentInit {
     private el;
     cd: ChangeDetectorRef;
@@ -32,7 +36,7 @@ export declare class Dock implements AfterContentInit {
      */
     model: MenuItem[] | undefined | null;
     /**
-     * Position of element. Valid values are 'bottom', 'top', 'left' and 'right'.
+     * Position of element.
      * @group Props
      */
     position: 'bottom' | 'top' | 'left' | 'right';

package/dragdrop/dragdrop.d.ts

@@ -2,6 +2,10 @@ import { AfterViewInit, ElementRef, EventEmitter, NgZone, OnDestroy, Renderer2 }
 import { VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * pDraggable directive apply draggable behavior to any element.
+ * @group Components
+ */
 export declare class Draggable implements AfterViewInit, OnDestroy {
     el: ElementRef;
     zone: NgZone;
@@ -58,6 +62,10 @@ export declare class Draggable implements AfterViewInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<Draggable, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<Draggable, "[pDraggable]", never, { "scope": { "alias": "pDraggable"; "required": false; }; "dragEffect": { "alias": "dragEffect"; "required": false; }; "dragHandle": { "alias": "dragHandle"; "required": false; }; "pDraggableDisabled": { "alias": "pDraggableDisabled"; "required": false; }; }, { "onDragStart": "onDragStart"; "onDragEnd": "onDragEnd"; "onDrag": "onDrag"; }, never, never, false, never>;
 }
+/**
+ * pDroppable directive apply droppable behavior to any element.
+ * @group Components
+ */
 export declare class Droppable implements AfterViewInit, OnDestroy {
     el: ElementRef;
     zone: NgZone;
@@ -65,6 +73,7 @@ export declare class Droppable implements AfterViewInit, OnDestroy {
     scope: string | string[] | undefined;
     /**
      * Whether the element is droppable, useful for conditional cases.
+     * @group Props
      */
     pDroppableDisabled: boolean;
     /**

package/dropdown/dropdown.d.ts

@@ -4,7 +4,7 @@ import { ControlValueAccessor } from '@angular/forms';
 import { FilterService, OverlayOptions, PrimeNGConfig, PrimeTemplate, SelectItem } from 'primeng/api';
 import { Overlay } from 'primeng/overlay';
 import { Scroller } from 'primeng/scroller';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { DropdownChangeEvent, DropdownFilterEvent, DropdownFilterOptions, DropdownLazyLoadEvent } from './dropdown.interface';
 import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
@@ -32,6 +32,10 @@ export declare class DropdownItem {
     static ɵfac: i0.ɵɵFactoryDeclaration<DropdownItem, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<DropdownItem, "p-dropdownItem", never, { "option": { "alias": "option"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "label": { "alias": "label"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "itemSize": { "alias": "itemSize"; "required": false; }; "template": { "alias": "template"; "required": false; }; }, { "onClick": "onClick"; }, never, never, false, never>;
 }
+/**
+ * Dropdown also known as Select, is used to choose an item from a collection of options.
+ * @group Components
+ */
 export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit, AfterViewChecked, ControlValueAccessor {
     el: ElementRef;
     renderer: Renderer2;
@@ -65,7 +69,9 @@ export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit
      * Inline style of the overlay panel element.
      * @group Props
      */
-    panelStyle: any;
+    panelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Style class of the element.
      * @group Props
@@ -288,41 +294,41 @@ export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit
     get disabled(): boolean | undefined;
     set disabled(_disabled: boolean | undefined);
     /**
-     * @deprecated use virtualScrollItemSize property instead.
      * Item size of item to be virtual scrolled.
      * @group Props
+     * @deprecated use virtualScrollItemSize property instead.
      */
     get itemSize(): number | undefined;
     set itemSize(val: number | undefined);
     _itemSize: number | undefined;
     /**
-     * @deprecated since v14.2.0, use overlayOptions property instead.
      * Whether to automatically manage layering.
      * @group Props
+     * @deprecated since v14.2.0, use overlayOptions property instead.
      */
     get autoZIndex(): boolean | undefined;
     set autoZIndex(val: boolean | undefined);
     _autoZIndex: boolean | undefined;
     /**
-     * @deprecated since v14.2.0, use overlayOptions property instead.
      * Base zIndex value to use in layering.
      * @group Props
+     * @deprecated since v14.2.0, use overlayOptions property instead.
      */
     get baseZIndex(): number | undefined;
     set baseZIndex(val: number | undefined);
     _baseZIndex: number | undefined;
     /**
-     * @deprecated since v14.2.0, use overlayOptions property instead.
      * Transition options of the show animation.
      * @group Props
+     * @deprecated since v14.2.0, use overlayOptions property instead.
      */
     get showTransitionOptions(): string | undefined;
     set showTransitionOptions(val: string | undefined);
     _showTransitionOptions: string | undefined;
     /**
-     * @deprecated since v14.2.0, use overlayOptions property instead.
      * Transition options of the hide animation.
      * @group Props
+     * @deprecated since v14.2.0, use overlayOptions property instead.
      */
     get hideTransitionOptions(): string | undefined;
     set hideTransitionOptions(val: string | undefined);
@@ -464,7 +470,7 @@ export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit
     writeValue(value: any): void;
     /**
      * Callback to invoke on filter reset.
-     * @group Methods
+     * @group Method
      */
     resetFilter(): void;
     updateSelectedOption(val: any): void;
@@ -478,13 +484,13 @@ export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit
     onEditableInputChange(event: Event): void;
     /**
      * Displays the panel.
-     * @group Methods
+     * @group Method
      */
     show(): void;
     onOverlayAnimationStart(event: AnimationEvent): void;
     /**
      * Hides the panel.
-     * @group Methods
+     * @group Method
      */
     hide(): void;
     onInputFocus(event: Event): void;
@@ -504,7 +510,7 @@ export declare class Dropdown implements OnInit, AfterViewInit, AfterContentInit
     applyFocus(): void;
     /**
      * Applies focus.
-     * @group Methods
+     * @group Method
      */
     focus(): void;
     clear(event: Event): void;

package/dropdown/dropdown.interface.d.ts

@@ -1,15 +1,23 @@
 import { TemplateRef } from '@angular/core';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 /**
  * Filter callbacks of the dropdown.
+ * @group Interface
  */
 export interface DropdownFilterOptions {
+    /**
+     * Filter function.
+     */
     filter?: (value?: any) => void;
+    /**
+     * Reset function.
+     */
     reset?: () => void;
 }
 /**
  * Custom change event.
  * @see {@link Dropdown.onChange}
+ * @group Events
  */
 export interface DropdownChangeEvent {
     /**
@@ -24,6 +32,7 @@ export interface DropdownChangeEvent {
 /**
  * Custom filter event.
  * @see {@link Dropdown.onFilter}
+ * @group Events
  */
 export interface DropdownFilterEvent {
     /**
@@ -38,6 +47,7 @@ export interface DropdownFilterEvent {
 /**
  * Custom lazy load event.
  * @see {@link Dropdown.onLazyLoad}
+ * @group Events
  */
 export interface DropdownLazyLoadEvent {
     /**
@@ -81,7 +91,7 @@ export interface DropdownTemplates {
     /**
      * Custom header template.
      */
-    header: TemplateRef<any>;
+    header(): TemplateRef<any>;
     /**
      * Custom filter template.
      * @param {DropdownFilterOptions} options - filter options.
@@ -97,15 +107,15 @@ export interface DropdownTemplates {
     /**
      * Custom footer template.
      */
-    footer: TemplateRef<any>;
+    footer(): TemplateRef<any>;
     /**
      * Custom empty filter template.
      */
-    emptyfilter: TemplateRef<any>;
+    emptyfilter(): TemplateRef<any>;
     /**
      * Custom empty template.
      */
-    empty: TemplateRef<any>;
+    empty(): TemplateRef<any>;
     /**
      * Custom group template.
      */
@@ -132,13 +142,13 @@ export interface DropdownTemplates {
     /**
      * Custom dropdown trigger icon template.
      */
-    dropdownicon: TemplateRef<any>;
+    dropdownicon(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any>;
+    clearicon(): TemplateRef<any>;
     /**
      * Custom filter icon template.
      */
-    filtericon: TemplateRef<any>;
+    filtericon(): TemplateRef<any>;
 }

package/dynamicdialog/dialogservice.d.ts

@@ -3,6 +3,10 @@ import { DynamicDialogComponent } from './dynamicdialog';
 import { DynamicDialogConfig } from './dynamicdialog-config';
 import { DynamicDialogRef } from './dynamicdialog-ref';
 import * as i0 from "@angular/core";
+/**
+ * Dynamic Dialog component methods.
+ * @group Service
+ */
 export declare class DialogService {
     private componentFactoryResolver;
     private appRef;
@@ -10,6 +14,13 @@ export declare class DialogService {
     private document;
     dialogComponentRefMap: Map<DynamicDialogRef, ComponentRef<DynamicDialogComponent>>;
     constructor(componentFactoryResolver: ComponentFactoryResolver, appRef: ApplicationRef, injector: Injector, document: Document);
+    /**
+     * Displays the dialog using the dynamic dialog object options.
+     * @param {*} componentType - Dynamic component for content template.
+     * @param {DynamicDialogConfig} config - DynamicDialog object.
+     * @returns {DynamicDialogRef} DynamicDialog instance.
+     * @group Method
+     */
     open(componentType: Type<any>, config: DynamicDialogConfig): DynamicDialogRef;
     private appendDialogComponentToBody;
     private removeDialogComponentFromBody;

package/dynamicdialog/dynamicdialog-config.d.ts

@@ -1,29 +1,118 @@
+/**
+ * Dialogs can be created dynamically with any component as the content using a DialogService.
+ * @group Interface
+ */
 export declare class DynamicDialogConfig<T = any> {
+    /**
+     * An object to pass to the component loaded inside the Dialog.
+     */
     data?: T;
+    /**
+     * Header text of the dialog.
+     */
     header?: string;
+    /**
+     * Footer text of the dialog.
+     */
     footer?: string;
+    /**
+     * Width of the dialog.
+     */
     width?: string;
+    /**
+     * Height of the dialog.
+     */
     height?: string;
+    /**
+     * Specifies if pressing escape key should hide the dialog.
+     */
     closeOnEscape?: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     */
     baseZIndex?: number;
+    /**
+     * Whether to automatically manage layering.
+     */
     autoZIndex?: boolean;
+    /**
+     * Specifies if clicking the modal background should hide the dialog.
+     */
     dismissableMask?: boolean;
+    /**
+     * Inline style of the component.
+     */
     rtl?: boolean;
-    style?: any;
-    contentStyle?: any;
+    /**
+     * Inline style of the comopnent.
+     */
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Inline style of the content.
+     */
+    contentStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     */
     styleClass?: string;
+    /**
+     * Transition options of the animation.
+     */
     transitionOptions?: string;
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     */
     closable?: boolean;
+    /**
+     * Whether to show the header or not.
+     */
     showHeader?: boolean;
+    /**
+     * Defines if background should be blocked when dialog is displayed.
+     */
     modal?: boolean;
+    /**
+     * Style class of the mask.
+     */
     maskStyleClass?: string;
+    /**
+     * Enables resizing of the content.
+     */
     resizable?: boolean;
+    /**
+     * Enables dragging to change the position using header.
+     */
     draggable?: boolean;
+    /**
+     * Keeps dialog in the viewport.
+     */
     keepInViewport?: boolean;
+    /**
+     * Minimum value for the left coordinate of dialog in dragging.
+     */
     minX?: number;
+    /**
+     * Minimum value for the top coordinate of dialog in dragging.
+     */
     minY?: number;
+    /**
+     * Whether the dialog can be displayed full screen.
+     */
     maximizable?: boolean;
+    /**
+     * Name of the maximize icon.
+     */
     maximizeIcon?: string;
+    /**
+     * Name of the minimize icon.
+     */
     minimizeIcon?: string;
+    /**
+     * Position of the dialog, options are "center", "top", "bottom", "left", "right", "top-left", "top-right", "bottom-left" or "bottom-right".
+     */
     position?: string;
 }