primeng 16.0.0-rc.2 → 16.0.0

package/message/message.d.ts

@@ -4,6 +4,10 @@ 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 level of the message.

package/messages/messages.d.ts

@@ -9,6 +9,10 @@ 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;

package/messages/messages.interface.d.ts

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

package/multiselect/multiselect.d.ts

@@ -4,7 +4,7 @@ import { ControlValueAccessor } from '@angular/forms';
 import { FilterService, OverlayOptions, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { Overlay } from 'primeng/overlay';
 import { Scroller } from 'primeng/scroller';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { Nullable } from 'primeng/ts-helpers';
 import { MultiSelectRemoveEvent, MultiSelectFilterOptions, MultiSelectFilterEvent, MultiSelectBlurEvent, MultiSelectChangeEvent, MultiSelectFocusEvent, MultiSelectLazyLoadEvent } from './multiselect.interface';
 import * as i0 from "@angular/core";
@@ -35,6 +35,10 @@ export declare class MultiSelectItem {
     static ɵfac: i0.ɵɵFactoryDeclaration<MultiSelectItem, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<MultiSelectItem, "p-multiSelectItem", never, { "option": { "alias": "option"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "label": { "alias": "label"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "itemSize": { "alias": "itemSize"; "required": false; }; "template": { "alias": "template"; "required": false; }; "checkIconTemplate": { "alias": "checkIconTemplate"; "required": false; }; }, { "onClick": "onClick"; "onKeydown": "onKeydown"; }, never, never, false, never>;
 }
+/**
+ * MultiSelect is used to select multiple items from a collection.
+ * @group Components
+ */
 export declare class MultiSelect implements OnInit, AfterViewInit, AfterContentInit, AfterViewChecked, ControlValueAccessor {
     el: ElementRef;
     renderer: Renderer2;
@@ -310,31 +314,48 @@ export declare class MultiSelect implements OnInit, AfterViewInit, AfterContentI
     get baseZIndex(): number | undefined;
     set baseZIndex(val: 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);
     /**
-     * @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);
+    /**
+     * Label to display when there are no selections.
+     * @group Props
+     * @deprecated Use placeholder instead.
+     */
     set defaultLabel(val: string | undefined);
     get defaultLabel(): string | undefined;
+    /**
+     * Label to display when there are no selections.
+     * @group Props
+     */
     set placeholder(val: string | undefined);
     get placeholder(): string | undefined;
+    /**
+     * An array of objects to display as the available options.
+     * @group Props
+     */
     get options(): any[] | undefined;
     set options(val: any[] | undefined);
+    /**
+     * When specified, filter displays with this value.
+     * @group Props
+     */
     get filterValue(): string | undefined | null;
     set filterValue(val: string | undefined | null);
     /**
-     * @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);

package/multiselect/multiselect.interface.d.ts

@@ -1,8 +1,9 @@
 import { TemplateRef } from '@angular/core';
-import { ScrollerOptions } from 'primeng/scroller';
+import { ScrollerOptions } from 'primeng/api';
 import { MultiSelectItem } from './multiselect';
 /**
  * Callbacks to invoke on filter or reset.
+ * @group Interface
  */
 export interface MultiSelectFilterOptions {
     filter?: (value?: any) => void;
@@ -11,6 +12,7 @@ export interface MultiSelectFilterOptions {
 /**
  * Custom change event.
  * @see {@link MultiSelect.onChange}
+ * @group Events
  */
 export interface MultiSelectChangeEvent {
     /**
@@ -29,6 +31,7 @@ export interface MultiSelectChangeEvent {
 /**
  * Custom filter event.
  * @see {@link MultiSelect.onFilter}
+ * @group Events
  */
 export interface MultiSelectFilterEvent {
     /**
@@ -43,6 +46,7 @@ export interface MultiSelectFilterEvent {
 /**
  * Custom focus event.
  * @see {@link MultiSelect.onFocus}
+ * @group Events
  */
 export interface MultiSelectFocusEvent {
     /**
@@ -53,12 +57,15 @@ export interface MultiSelectFocusEvent {
 /**
  * Custom blur event.
  * @see {@link MultiSelect.onBlur}
+ * @extends {MultiSelectFocusEvent}
+ * @group Events
  */
 export interface MultiSelectBlurEvent extends MultiSelectFocusEvent {
 }
 /**
  * Custom lazy load event.
  * @see {@link MultiSelect.onLazyLoad}
+ * @group Events
  */
 export interface MultiSelectLazyLoadEvent {
     /**
@@ -73,6 +80,7 @@ export interface MultiSelectLazyLoadEvent {
 /**
  * Custom remove event.
  * @see {@link MultiSelect.onRemove}
+ * @group Events
  */
 export interface MultiSelectRemoveEvent {
     /**
@@ -121,7 +129,7 @@ export interface MultiSelectTemplates {
     /**
      * Custom header template.
      */
-    header: TemplateRef<any>;
+    header(): TemplateRef<any>;
     /**
      * Custom filter template.
      * @param {MultiSelectFilterOptions} options - filter options.
@@ -137,15 +145,15 @@ export interface MultiSelectTemplates {
     /**
      * 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.
      */
@@ -172,25 +180,25 @@ export interface MultiSelectTemplates {
     /**
      * 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>;
     /**
      * Custom check icon template.
      */
-    checkicon: TemplateRef<any>;
+    checkicon(): TemplateRef<any>;
     /**
      * Custom close icon template.
      */
-    closeicon: TemplateRef<any>;
+    closeicon(): TemplateRef<any>;
     /**
      * Custom remove token icon template.
      */
-    removetokenicon: TemplateRef<any>;
+    removetokenicon(): TemplateRef<any>;
 }

package/orderlist/orderlist.d.ts

@@ -14,6 +14,10 @@ import * as i7 from "primeng/icons/angledoubleup";
 import * as i8 from "primeng/icons/angleup";
 import * as i9 from "primeng/icons/angledown";
 import * as i10 from "primeng/icons/search";
+/**
+ * OrderList is used to managed the order of a collection.
+ * @group Components
+ */
 export declare class OrderList implements AfterViewChecked, AfterContentInit {
     private document;
     private platformId;
@@ -76,10 +80,10 @@ export declare class OrderList implements AfterViewChecked, AfterContentInit {
      */
     dragdrop: boolean;
     /**
-     * Defines the location of the buttons with respect to the list, valid values are "left" or "right".
+     * Defines the location of the buttons with respect to the list.
      * @group Props
      */
-    controlsPosition: string;
+    controlsPosition: 'left' | 'right';
     /**
      * Defines a string that labels the filter input.
      * @group Props
@@ -136,13 +140,13 @@ export declare class OrderList implements AfterViewChecked, AfterContentInit {
     onReorder: EventEmitter<any>;
     /**
      * Callback to invoke when selection changes.
-     * @param {OrderListSelectionChangeEvent} event - custom change event.
+     * @param {OrderListSelectionChangeEvent} event - Custom change event.
      * @group Emits
      */
     onSelectionChange: EventEmitter<OrderListSelectionChangeEvent>;
     /**
      * Callback to invoke when filtering occurs.
-     * @param {OrderListFilterEvent} event - custom filter event.
+     * @param {OrderListFilterEvent} event - Custom filter event.
      * @group Emits
      */
     onFilterEvent: EventEmitter<OrderListFilterEvent>;
@@ -178,7 +182,7 @@ export declare class OrderList implements AfterViewChecked, AfterContentInit {
     filter(): void;
     /**
      * Callback to invoke on filter reset.
-     * @group Methods
+     * @group Method
      */
     resetFilter(): void;
     isItemVisible(item: any): boolean | undefined;

package/orderlist/orderlist.interface.d.ts

@@ -1,6 +1,7 @@
 import { TemplateRef } from '@angular/core';
 /**
  * Callbacks to invoke on filter.
+ * @group Interface
  */
 export interface OrderListFilterOptions {
     filter?: (value?: any) => void;
@@ -9,6 +10,7 @@ export interface OrderListFilterOptions {
 /**
  * Custom change event.
  * @see {@link OrderList.selectionChange}
+ * @group Events
  */
 export interface OrderListSelectionChangeEvent {
     /**
@@ -23,6 +25,7 @@ export interface OrderListSelectionChangeEvent {
 /**
  * Custom change event.
  * @see {@link OrderList.selectionChange}
+ * @group Events
  */
 export interface OrderListFilterEvent {
     /**
@@ -59,7 +62,7 @@ export interface OrderListTemplates {
     /**
      * Custom header template.
      */
-    header: TemplateRef<any>;
+    header(): TemplateRef<any>;
     /**
      * Custom filter template.
      * @param {OrderListFilterOptions} options - filter options.
@@ -75,33 +78,33 @@ export interface OrderListTemplates {
     /**
      * Custom empty filter template.
      */
-    emptyfilter: TemplateRef<any>;
+    emptyfilter(): TemplateRef<any>;
     /**
      * Custom empty template.
      */
-    empty: TemplateRef<any>;
+    empty(): TemplateRef<any>;
     /**
      * Custom clear icon template.
      */
-    clearicon: TemplateRef<any>;
+    clearicon(): TemplateRef<any>;
     /**
      * Custom filter icon template.
      */
-    filtericon: TemplateRef<any>;
+    filtericon(): TemplateRef<any>;
     /**
      * Custom move up icon template.
      */
-    moveupicon: TemplateRef<any>;
+    moveupicon(): TemplateRef<any>;
     /**
      * Custom move top icon template.
      */
-    movetopicon: TemplateRef<any>;
+    movetopicon(): TemplateRef<any>;
     /**
      * Custom move down icon template.
      */
-    movedownicon: TemplateRef<any>;
+    movedownicon(): TemplateRef<any>;
     /**
      * Custom move bottom icon template.
      */
-    movebottomicon: TemplateRef<any>;
+    movebottomicon(): TemplateRef<any>;
 }

package/organizationchart/organizationchart.d.ts

@@ -27,6 +27,10 @@ export declare class OrganizationChartNode implements OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<OrganizationChartNode, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<OrganizationChartNode, "[pOrganizationChartNode]", never, { "node": { "alias": "node"; "required": false; }; "root": { "alias": "root"; "required": false; }; "first": { "alias": "first"; "required": false; }; "last": { "alias": "last"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * OrganizationChart visualizes hierarchical organization data.
+ * @group Components
+ */
 export declare class OrganizationChart implements AfterContentInit {
     el: ElementRef;
     cd: ChangeDetectorRef;

package/organizationchart/organizationchart.interface.d.ts

@@ -3,6 +3,7 @@ import { TreeNode } from 'primeng/api';
 /**
  * Custom node select event.
  * @see {@link OrganizationChart.onNodeSelect}
+ * @group Events
  */
 export interface OrganizationChartNodeSelectEvent {
     /**
@@ -17,6 +18,8 @@ export interface OrganizationChartNodeSelectEvent {
 /**
  * Custom node unselect event.
  * @see {@link OrganizationChart.onNodeUnSelect}
+ * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
  */
 export interface OrganizationChartNodeUnSelectEvent extends OrganizationChartNodeSelectEvent {
 }
@@ -24,6 +27,7 @@ export interface OrganizationChartNodeUnSelectEvent extends OrganizationChartNod
  * Custom node expand event.
  * @see {@link OrganizationChart.onNodeExpand}
  * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
  */
 export interface OrganizationChartNodeExpandEvent extends OrganizationChartNodeSelectEvent {
 }
@@ -31,6 +35,7 @@ export interface OrganizationChartNodeExpandEvent extends OrganizationChartNodeS
  * Custom node collapse event.
  * @see {@link OrganizationChart.onNodeCollapse}
  * @extends {OrganizationChartNodeSelectEvent}
+ * @group Events
  */
 export interface OrganizationChartNodeCollapseEvent extends OrganizationChartNodeSelectEvent {
 }

package/overlay/overlay.d.ts

@@ -5,6 +5,10 @@ import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 export declare const OVERLAY_VALUE_ACCESSOR: any;
+/**
+ * This API allows overlay components to be controlled from the PrimeNGConfig. In this way, all overlay components in the application can have the same behavior.
+ * @group Components
+ */
 export declare class Overlay implements AfterContentInit, OnDestroy {
     private document;
     private platformId;
@@ -15,90 +19,113 @@ export declare class Overlay implements AfterContentInit, OnDestroy {
     private zone;
     /**
      * The visible property is an input that determines the visibility of the component.
+     * @defaultValue false
      * @group Props
      */
     get visible(): boolean;
     set visible(value: boolean);
     /**
      * The mode property is an input that determines the overlay mode type or string.
+     * @defaultValue null
      * @group Props
      */
     get mode(): OverlayModeType | string;
     set mode(value: OverlayModeType | string);
     /**
      * The style property is an input that determines the style object for the component.
+     * @defaultValue null
      * @group Props
      */
-    get style(): any;
-    set style(value: any);
+    get style(): {
+        [klass: string]: any;
+    } | null | undefined;
+    set style(value: {
+        [klass: string]: any;
+    } | null | undefined);
     /**
      * The styleClass property is an input that determines the CSS class(es) for the component.
+     * @defaultValue null
      * @group Props
      */
     get styleClass(): string;
     set styleClass(value: string);
     /**
      * The contentStyle property is an input that determines the style object for the content of the component.
+     * @defaultValue null
      * @group Props
      */
-    get contentStyle(): any;
-    set contentStyle(value: any);
+    get contentStyle(): {
+        [klass: string]: any;
+    } | null | undefined;
+    set contentStyle(value: {
+        [klass: string]: any;
+    } | null | undefined);
     /**
      * The contentStyleClass property is an input that determines the CSS class(es) for the content of the component.
+     * @defaultValue null
      * @group Props
      */
     get contentStyleClass(): string;
     set contentStyleClass(value: string);
     /**
      * The target property is an input that specifies the target element or selector for the component.
+     * @defaultValue null
      * @group Props
      */
-    get target(): any;
-    set target(value: any);
+    get target(): string | null | undefined;
+    set target(value: string | null | undefined);
     /**
      * Overlay can be mounted into its location, body or DOM element instance using this option.
+     * @defaultValue null
      * @group Props
      */
-    get appendTo(): any;
-    set appendTo(value: any);
+    get appendTo(): 'body' | HTMLElement | undefined;
+    set appendTo(value: 'body' | HTMLElement | undefined);
     /**
      * The autoZIndex determines whether to automatically manage layering. Its default value is 'false'.
+     * @defaultValue false
      * @group Props
      */
     get autoZIndex(): boolean;
     set autoZIndex(value: boolean);
     /**
-     * The baseZIndex is base zIndex value to use in layering. Its default value is 0.
+     * The baseZIndex is base zIndex value to use in layering.
+     * @defaultValue null
      * @group Props
      */
     get baseZIndex(): number;
     set baseZIndex(value: number);
     /**
-     * Transition options of the show or hide animation. The default value of showTransitionOptions is '.12s cubic-bezier(0, 0, 0.2, 1)' and the default value of hideTransitionOptions is '.1s linear'.
+     * Transition options of the show or hide animation.
+     * @defaultValue .12s cubic-bezier(0, 0, 0.2, 1)
      * @group Props
      */
     get showTransitionOptions(): string;
     set showTransitionOptions(value: string);
     /**
      * The hideTransitionOptions property is an input that determines the CSS transition options for hiding the component.
+     * @defaultValue .1s linear
      * @group Props
      */
     get hideTransitionOptions(): string;
     set hideTransitionOptions(value: string);
     /**
      * The listener property is an input that specifies the listener object for the component.
+     * @defaultValue null
      * @group Props
      */
     get listener(): any;
     set listener(value: any);
     /**
      * It is the option used to determine in which mode it should appear according to the given media or breakpoint.
+     * @defaultValue null
      * @group Props
      */
     get responsive(): ResponsiveOverlayOptions | undefined;
     set responsive(val: ResponsiveOverlayOptions | undefined);
     /**
      * The options property is an input that specifies the overlay options for the component.
+     * @defaultValue null
      * @group Props
      */
     get options(): OverlayOptions | undefined;
@@ -151,9 +178,13 @@ export declare class Overlay implements AfterContentInit, OnDestroy {
     contentTemplate: TemplateRef<any> | undefined;
     _visible: boolean;
     _mode: OverlayModeType | string;
-    _style: any;
+    _style: {
+        [klass: string]: any;
+    } | null | undefined;
     _styleClass: string | undefined;
-    _contentStyle: any;
+    _contentStyle: {
+        [klass: string]: any;
+    } | null | undefined;
     _contentStyleClass: string | undefined;
     _target: any;
     _appendTo: 'body' | HTMLElement | undefined;

package/overlaypanel/overlaypanel.d.ts

@@ -9,6 +9,10 @@ import * as i1 from "@angular/common";
 import * as i2 from "primeng/ripple";
 import * as i3 from "primeng/api";
 import * as i4 from "primeng/icons/times";
+/**
+ * OverlayPanel is a container component positioned as connected to its target.
+ * @group Components
+ */
 export declare class OverlayPanel implements AfterContentInit, OnDestroy {
     private document;
     private platformId;
@@ -44,7 +48,7 @@ export declare class OverlayPanel implements AfterContentInit, OnDestroy {
      *  Target element to attach the panel, 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: any;
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
     /**
      * Whether to automatically manage layering.
      * @group Props
@@ -84,7 +88,7 @@ export declare class OverlayPanel implements AfterContentInit, OnDestroy {
      * Callback to invoke when an overlay gets hidden.
      * @group Emits
      */
-    onHide: EventEmitter<object>;
+    onHide: EventEmitter<any>;
     templates: QueryList<PrimeTemplate> | undefined;
     container: Nullable<HTMLDivElement>;
     overlayVisible: boolean;
@@ -107,16 +111,16 @@ export declare class OverlayPanel implements AfterContentInit, OnDestroy {
     unbindDocumentClickListener(): void;
     /**
      * Toggles the visibility of the panel.
-     * @param event - Browser event
-     * @param target - Target element.
-     * @group Methods
+     * @param {Event} event - Browser event
+     * @param {Target} target - Target element.
+     * @group Method
      */
     toggle(event: any, target?: any): void;
     /**
      * Displays the panel.
-     * @param event
-     * @param target
-     * @group Methods
+     * @param {Event} event - Browser event
+     * @param {Target} target - Target element.
+     * @group Method
      */
     show(event: any, target?: any): void;
     onOverlayClick(event: MouseEvent): void;
@@ -130,7 +134,7 @@ export declare class OverlayPanel implements AfterContentInit, OnDestroy {
     focus(): void;
     /**
      * Hides the panel.
-     * @group Methods
+     * @group Method
      */
     hide(): void;
     onCloseClick(event: MouseEvent): void;