primeng 16.0.0-rc.2 → 16.0.0

package/accordion/accordion.d.ts

@@ -7,6 +7,10 @@ import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/chevronright";
 import * as i3 from "primeng/icons/chevrondown";
 import * as i4 from "primeng/api";
+/**
+ * AccordionTab is a helper component for Accordion.
+ * @group Components
+ */
 export declare class AccordionTab implements AfterContentInit, OnDestroy {
     changeDetector: ChangeDetectorRef;
     /**
@@ -66,12 +70,13 @@ export declare class AccordionTab implements AfterContentInit, OnDestroy {
      */
     transitionOptions: string;
     /**
-     * Position of the icon, valid values are "end", "start".
+     * Position of the icon.
      * @group Props
      */
-    iconPos: string;
+    iconPos: 'end' | 'start';
     /**
-     * Event triggered by changing the choice
+     * Event triggered by changing the choice.
+     * @param {boolean} value - Boolean value indicates that the option is changed.
      * @group Emits
      */
     selectedChange: EventEmitter<boolean>;
@@ -101,6 +106,10 @@ export declare class AccordionTab implements AfterContentInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<AccordionTab, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AccordionTab, "p-accordionTab", never, { "header": { "alias": "header"; "required": false; }; "headerStyle": { "alias": "headerStyle"; "required": false; }; "tabStyle": { "alias": "tabStyle"; "required": false; }; "contentStyle": { "alias": "contentStyle"; "required": false; }; "tabStyleClass": { "alias": "tabStyleClass"; "required": false; }; "headerStyleClass": { "alias": "headerStyleClass"; "required": false; }; "contentStyleClass": { "alias": "contentStyleClass"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "cache": { "alias": "cache"; "required": false; }; "transitionOptions": { "alias": "transitionOptions"; "required": false; }; "iconPos": { "alias": "iconPos"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; }, { "selectedChange": "selectedChange"; }, ["headerFacet", "templates"], ["p-header", "*"], false, never>;
 }
+/**
+ * Accordion groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class Accordion implements BlockableUI, AfterContentInit, OnDestroy {
     el: ElementRef;
     changeDetector: ChangeDetectorRef;
@@ -139,19 +148,22 @@ export declare class Accordion implements BlockableUI, AfterContentInit, OnDestr
     set activeIndex(val: number | number[] | null | undefined);
     /**
      * Callback to invoke when an active tab is collapsed by clicking on the header.
+     * @param {AccordionTabCloseEvent} event - Custom tab close event.
      * @group Emits
      */
     onClose: EventEmitter<AccordionTabCloseEvent>;
     /**
      * Callback to invoke when a tab gets expanded.
+     * @param {AccordionTabOpenEvent} event - Custom tab open event.
      * @group Emits
      */
     onOpen: EventEmitter<AccordionTabOpenEvent>;
     /**
      * Returns the active index.
+     * @param {number | number[]} value - New index.
      * @group Emits
      */
-    activeIndexChange: EventEmitter<number | number[] | null>;
+    activeIndexChange: EventEmitter<number | number[]>;
     tabList: QueryList<AccordionTab> | undefined;
     tabListSubscription: Subscription | null;
     private _activeIndex;

package/accordion/accordion.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom tab open event.
  * @see {@link Accordion.onOpen}
+ * @group Events
  */
 export interface AccordionTabOpenEvent {
     /**
@@ -17,6 +18,7 @@ export interface AccordionTabOpenEvent {
  * Custom tab close event.
  * @see {@link Accordion.onClose}
  * @extends {AccordionTabOpenEvent}
+ * @group Events
  */
 export interface AccordionTabCloseEvent extends AccordionTabOpenEvent {
 }
@@ -28,11 +30,11 @@ export interface AccordionTemplates {
     /**
      * Custom template of content.
      */
-    content: TemplateRef<any> | null;
+    content(): TemplateRef<any>;
     /**
      * Custom template of header.
      */
-    header: TemplateRef<any> | null;
+    header(): TemplateRef<any>;
     /**
      * Custom template of icon.
      */

package/animate/animate.d.ts

@@ -1,16 +1,22 @@
 import { AfterViewInit, ElementRef, Renderer2 } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Animate manages PrimeFlex CSS classes declaratively to during enter/leave animations on scroll or on page load.
+ * @group Components
+ */
 export declare class Animate implements AfterViewInit {
     private host;
     el: ElementRef;
     renderer: Renderer2;
     /**
      * Selector to define the CSS class for enter animation.
+     * @group Props
      */
     enterClass: string | undefined;
     /**
      * Selector to define the CSS class for leave animation.
+     * @group Props
      */
     leaveClass: string | undefined;
     observer: IntersectionObserver | undefined;

package/api/confirmaeventtype.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Type of the confirm event.
+ */
 export declare enum ConfirmEventType {
     ACCEPT = 0,
     REJECT = 1,

package/api/confirmation.d.ts

@@ -1,6 +1,7 @@
 import { EventEmitter } from '@angular/core';
 /**
  * Represents a confirmation dialog configuration.
+ * @group Interface
  */
 export interface Confirmation {
     /**

package/api/confirmationservice.d.ts

@@ -1,12 +1,29 @@
 import { Confirmation } from './confirmation';
 import * as i0 from "@angular/core";
+/**
+ * Methods used in confirmation service.
+ * @group Service
+ */
 export declare class ConfirmationService {
     private requireConfirmationSource;
     private acceptConfirmationSource;
     requireConfirmation$: import("rxjs").Observable<Confirmation>;
     accept: import("rxjs").Observable<Confirmation>;
+    /**
+     * Callback to invoke on confirm.
+     * @param {Confirmation} confirmation - Represents a confirmation dialog configuration.
+     * @group Method
+     */
     confirm(confirmation: Confirmation): this;
+    /**
+     * Closes the dialog.
+     * @group Method
+     */
     close(): this;
+    /**
+     * Accepts the dialog.
+     * @group Method
+     */
     onAccept(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ConfirmationService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ConfirmationService>;

package/api/filtermetadata.d.ts

@@ -1,5 +1,6 @@
 /**
  * Represents metadata for filtering a data set.
+ * @group Interface
  */
 export interface FilterMetadata {
     /**

package/api/lazyloadevent.d.ts

@@ -2,6 +2,7 @@ import { FilterMetadata } from './filtermetadata';
 import { SortMeta } from './sortmeta';
 /**
  * Represents an event object for lazy loading data.
+ * @group Interface
  */
 export interface LazyLoadEvent {
     /**

package/api/lazyloadmeta.d.ts

@@ -2,6 +2,7 @@ import { FilterMetadata } from './filtermetadata';
 import { SortMeta } from './sortmeta';
 /**
  * Meta data for lazy load event.
+ * @group Interface
  */
 export interface LazyLoadMeta {
     first?: number | undefined | null;

package/api/megamenuitem.d.ts

@@ -2,6 +2,7 @@ import { QueryParamsHandling } from '@angular/router';
 import { MenuItem } from './menuitem';
 /**
  * MegaMenuItem API provides the following properties.
+ * @group Interface
  */
 export interface MegaMenuItem {
     /**

package/api/menuitem.d.ts

@@ -1,6 +1,9 @@
 import { QueryParamsHandling } from '@angular/router';
+import { TooltipOptions } from './tooltipoptions';
+import { MegaMenuItem } from './megamenuitem';
 /**
  * MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.
+ * @group Interface
  */
 export interface MenuItem {
     /**
@@ -14,7 +17,7 @@ export interface MenuItem {
     /**
      * Callback to execute when item is clicked.
      */
-    command?: (event?: any) => void;
+    command?(event: MenuItemCommandEvent): void;
     /**
      * External link to navigate when item is clicked.
      */
@@ -70,7 +73,9 @@ export interface MenuItem {
     /**
      * Inline style of the menuitem.
      */
-    style?: any;
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Style class of the menuitem.
      */
@@ -126,34 +131,42 @@ export interface MenuItem {
     /**
      * Inline style of the item's icon.
      */
-    iconStyle?: any;
+    iconStyle?: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Class of the item's icon.
      */
     iconClass?: string;
     /**
      * Developer-defined state that can be passed to any navigation.
+     * @see {MenuItemState}
      */
     state?: {
         [k: string]: any;
     };
     /**
      * Options of the item's tooltip.
+     * @see {TooltipOptions}
      */
-    tooltipOptions?: {
-        tooltipLabel?: string;
-        tooltipPosition?: string;
-        tooltipEvent?: string;
-        appendTo?: any;
-        positionStyle?: string;
-        tooltipStyleClass?: string;
-        tooltipZIndex?: string;
-        escape?: boolean;
-        disabled?: boolean;
-        positionTop?: number;
-        positionLeft?: number;
-        showDelay?: number;
-        hideDelay?: number;
-        life?: number;
-    };
+    tooltipOptions?: TooltipOptions;
+}
+/**
+ * Custom command event
+ * @see {@link MenuItem.command}
+ * @group Events
+ */
+export interface MenuItemCommandEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected menu item.
+     */
+    item?: MenuItem | MegaMenuItem;
+    /**
+     * Index of the selected item.
+     */
+    index?: number;
 }

package/api/message.d.ts

@@ -1,5 +1,6 @@
 /**
  * Deines valid options for the message.
+ * @group Interface
  */
 export interface Message {
     severity?: string;

package/api/messageservice.d.ts

@@ -1,12 +1,31 @@
 import { Message } from './message';
 import * as i0 from "@angular/core";
+/**
+ * Message service used in messages and toast components.
+ * @group Service
+ */
 export declare class MessageService {
     private messageSource;
     private clearSource;
     messageObserver: import("rxjs").Observable<Message | Message[]>;
     clearObserver: import("rxjs").Observable<string>;
+    /**
+     * Inserts single message.
+     * @param {Message} message - Message to be added.
+     * @group Method
+     */
     add(message: Message): void;
+    /**
+     * Insterts new messages.
+     * @param {Message[]} messages - Messages to be added.
+     * @group Method
+     */
     addAll(messages: Message[]): void;
+    /**
+     * Clears the message with the given key.
+     * @param {string} key - Key of the message to be cleared.
+     * @group Method
+     */
     clear(key?: string): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<MessageService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MessageService>;

package/api/overlayoptions.d.ts

@@ -1,14 +1,17 @@
 import { AnimationEvent } from '@angular/animations';
 /**
  * Represents the type of overlay mode, which can be 'modal', 'overlay', or undefined.
+ * @group Types
  */
 export type OverlayModeType = 'modal' | 'overlay' | undefined;
 /**
  * Represents the type of direction for a responsive overlay, which can be one of the specified values or undefined.
+ * @group Types
  */
 export type ResponsiveOverlayDirectionType = 'center' | 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end' | undefined;
 /**
  * Represents the options for an overlay listener.
+ * @group Interface
  */
 export interface OverlayListenerOptions {
     /**
@@ -26,6 +29,7 @@ export interface OverlayListenerOptions {
 }
 /**
  * Represents the options for a responsive overlay.
+ * @group Events
  */
 export interface ResponsiveOverlayOptions {
     /**
@@ -59,6 +63,7 @@ export interface ResponsiveOverlayOptions {
 }
 /**
  * Represents an event that occurs when an overlay is shown.
+ * @group Events
  */
 export interface OverlayOnShowEvent {
     /**
@@ -76,21 +81,28 @@ export interface OverlayOnShowEvent {
 }
 /**
  * Represents an event that occurs before an overlay is shown.
+ * @extends {OverlayOnShowEvent}
+ * @group Events
  */
 export interface OverlayOnBeforeShowEvent extends OverlayOnShowEvent {
 }
 /**
  * Represents an event that occurs before an overlay is hidden.
+ * @extends {OverlayOnBeforeShowEvent}
+ * @group Events
  */
 export interface OverlayOnBeforeHideEvent extends OverlayOnBeforeShowEvent {
 }
 /**
  * Represents an event that occurs when an overlay is hidden.
+ * @extends {OverlayOnShowEvent}
+ * @group Events
  */
 export interface OverlayOnHideEvent extends OverlayOnShowEvent {
 }
 /**
  * Represents the options for an overlay.
+ * @group Interface
  */
 export interface OverlayOptions {
     /**

package/api/public_api.d.ts

@@ -28,3 +28,6 @@ export * from './treedragdropservice';
 export * from './treenode';
 export * from './treenodedragevent';
 export * from './lazyloadmeta';
+export * from './tooltipoptions';
+export * from './scrolleroptions';
+export * from './treetablenode';

package/api/scrolleroptions.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Options for the scroller.
+ * @group Interface
+ */
+export interface ScrollerOptions {
+    /**
+     * Unique identifier of the element.
+     */
+    id?: string | undefined;
+    /**
+     * Inline style of the component.
+     */
+    style?: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the element.
+     */
+    styleClass?: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     */
+    tabindex?: number | undefined;
+    /**
+     * An array of objects to display.
+     */
+    items?: any[];
+    /**
+     * The height/width of item according to orientation.
+     */
+    itemSize?: any;
+    /**
+     * Height of the scroll viewport.
+     */
+    scrollHeight?: string | undefined;
+    /**
+     * Width of the scroll viewport.
+     */
+    scrollWidth?: string | undefined;
+    /**
+     * The orientation of scrollbar.
+     */
+    orientation?: 'vertical' | 'horizontal' | 'both';
+    /**
+     * Used to specify how many items to load in each load method in lazy mode.
+     */
+    step?: number | undefined;
+    /**
+     * Delay in scroll before new data is loaded.
+     */
+    delay?: number | undefined;
+    /**
+     * Delay after window's resize finishes.
+     */
+    resizeDelay?: number | undefined;
+    /**
+     * Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash.
+     */
+    appendOnly?: boolean;
+    /**
+     * Specifies whether the scroller should be displayed inline or not.
+     */
+    inline?: boolean;
+    /**
+     * Defines if data is loaded and interacted with in lazy manner.
+     */
+    lazy?: boolean;
+    /**
+     * If disabled, the scroller feature is eliminated and the content is displayed directly.
+     */
+    disabled?: boolean;
+    /**
+     * Used to implement a custom loader instead of using the loader feature in the scroller.
+     */
+    loaderDisabled?: boolean;
+    /**
+     * Columns to display.
+     */
+    columns?: any[] | undefined;
+    /**
+     * Used to implement a custom spacer instead of using the spacer feature in the scroller.
+     */
+    showSpacer?: boolean;
+    /**
+     * Defines whether to show loader.
+     */
+    showLoader?: boolean;
+    /**
+     * Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view.
+     */
+    numToleratedItems?: any;
+    /**
+     * Defines whether the data is loaded.
+     */
+    loading?: boolean;
+    /**
+     * Defines whether to dynamically change the height or width of scrollable container.
+     */
+    autoSize?: boolean;
+    /**
+     * Function to optimize the dom operations by delegating to ngForTrackBy, default algoritm checks for object identity.
+     */
+    trackBy?: Function;
+    /**
+     * Callback to invoke in lazy mode to load new data.
+     */
+    onLazyLoad?: Function | undefined;
+    /**
+     * Callback to invoke when scroll position changes.
+     */
+    onScroll?: Function | undefined;
+    /**
+     * Callback to invoke when scroll position and item's range in view changes.
+     */
+    onScrollIndexChange?: Function | undefined;
+}

package/api/selectitem.d.ts

@@ -1,5 +1,6 @@
 /**
  * Represents an option item.
+ * @group Interface
  */
 export interface SelectItem<T = any> {
     label?: string;

package/api/selectitemgroup.d.ts

@@ -1,6 +1,7 @@
 import { SelectItem } from './selectitem';
 /**
  * Represents a group of select items.
+ * @group Interface
  */
 export interface SelectItemGroup {
     label: string;

package/api/sortevent.d.ts

@@ -1,6 +1,7 @@
 import { SortMeta } from './sortmeta';
 /**
  * Represents an event triggered when sorting is applied.
+ * @group Interface
  */
 export interface SortEvent {
     data?: any[];

package/api/sortmeta.d.ts

@@ -1,5 +1,6 @@
 /**
  * Represents metadata for sorting.
+ * @group Interface
  */
 export interface SortMeta {
     field: string;

package/api/tablestate.d.ts

@@ -2,6 +2,7 @@ import { FilterMetadata } from './filtermetadata';
 import { SortMeta } from './sortmeta';
 /**
  * Represents the state of a table component.
+ * @group Interface
  */
 export interface TableState {
     /**

package/api/tooltipoptions.d.ts

@@ -0,0 +1,63 @@
+import { ElementRef, TemplateRef } from '@angular/core';
+/**
+ * Defines options of Tooltip.
+ * @group Interface
+ */
+export interface TooltipOptions {
+    /**
+     * Label of tooltip.
+     */
+    tooltipLabel?: string;
+    /**
+     * Position of tooltip.
+     */
+    tooltipPosition?: 'right' | 'left' | 'top' | 'bottom';
+    /**
+     * Position of tooltip.
+     */
+    tooltipEvent?: 'hover' | 'focus';
+    /**
+     * Target element to attach the 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).
+     */
+    appendTo?: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Type of CSS position.
+     */
+    positionStyle?: string;
+    /**
+     * Style class of the tooltip.
+     */
+    tooltipStyleClass?: string;
+    /**
+     * Whether the z-index should be managed automatically to always go on top or have a fixed value.
+     */
+    tooltipZIndex?: string;
+    /**
+     * By default the tooltip contents are rendered as text. Set to false to support html tags in the content.
+     */
+    escape?: boolean;
+    /**
+     * When present, it specifies that the component should be disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Specifies the additional vertical offset of the tooltip from its default position.
+     */
+    positionTop?: number;
+    /**
+     * Specifies the additional horizontal offset of the tooltip from its default position.
+     */
+    positionLeft?: number;
+    /**
+     * Delay to show the tooltip in milliseconds.
+     */
+    showDelay?: number;
+    /**
+     * Delay to hide the tooltip in milliseconds.
+     */
+    hideDelay?: number;
+    /**
+     * Time to wait in milliseconds to hide the tooltip even it is active.
+     */
+    life?: number;
+}

package/api/translation.d.ts

@@ -1,5 +1,6 @@
 /**
  * Represents a set of translated strings used in a component or application.
+ * @group Interface
  */
 export interface Translation {
     startsWith?: string;