primeng 16.0.0-rc.2 → 16.0.0

package/scroller/scroller.interface.d.ts

@@ -1,46 +1,24 @@
 import { TemplateRef } from '@angular/core';
+/**
+ * Options of the scroll direction.
+ * @group Types
+ */
 export type ScrollerToType = 'to-start' | 'to-end' | undefined;
-export type ScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
 /**
- * Options for the virtual scroller.
+ * Options of the scroller orientation.
+ * @group Types
  */
-export interface ScrollerOptions {
-    id?: string | undefined;
-    style?: any;
-    styleClass?: string | undefined;
-    tabindex?: number | undefined;
-    items?: any[];
-    itemSize?: any;
-    scrollHeight?: string | undefined;
-    scrollWidth?: string | undefined;
-    orientation?: ScrollerOrientationType;
-    step?: number | undefined;
-    delay?: number | undefined;
-    resizeDelay?: number | undefined;
-    appendOnly?: boolean;
-    inline?: boolean;
-    lazy?: boolean;
-    disabled?: boolean;
-    loaderDisabled?: boolean;
-    columns?: any[] | undefined;
-    showSpacer?: boolean;
-    showLoader?: boolean;
-    numToleratedItems?: any;
-    loading?: boolean;
-    autoSize?: boolean;
-    trackBy?: any;
-    onLazyLoad?: Function | undefined;
-    onScroll?: Function | undefined;
-    onScrollIndexChange?: Function | undefined;
-}
+export type ScrollerOrientationType = 'vertical' | 'horizontal' | 'both';
 /**
  * Loader icon options.
+ * @group Types
  */
 export interface ScrollerLoaderIconOptions {
     [klass: string]: any;
 }
 /**
  * Scroller content options.
+ * @group Interface
  */
 export interface ScrollerContentOptions {
     contentStyleClass?: string;
@@ -63,18 +41,38 @@ export interface ScrollerContentOptions {
 }
 /**
  * Scroller item options.
+ * @group Interface
  */
 export interface ScrollerItemOptions {
+    /**
+     * Index of the item.
+     */
     index?: number;
+    /**
+     * Item count.
+     */
     count?: number;
+    /**
+     * Index of the first element in viewport.
+     */
     first?: boolean;
+    /**
+     * Index of the last element in viewport.
+     */
     last?: boolean;
+    /**
+     * Defines if index is even number.
+     */
     even?: boolean;
+    /**
+     * Defines if index is odd number.
+     */
     odd?: boolean;
 }
 /**
  * Loader settings.
  * @extends {ScrollerItemOptions}
+ * @group Interface
  */
 export interface ScrollerLoaderOptions extends ScrollerItemOptions {
     [klass: string]: any;
@@ -82,6 +80,7 @@ export interface ScrollerLoaderOptions extends ScrollerItemOptions {
 /**
  * Custom lazy load event.
  * @see {@link Scroller.onLazyLoad}
+ * @group Events
  */
 export interface ScrollerLazyLoadEvent {
     /**
@@ -97,12 +96,14 @@ export interface ScrollerLazyLoadEvent {
  * Custom scroll index change event.
  * @see {@link Scroller.onScrollIndexChange}
  * @extends {ScrollerLazyLoadEvent}
+ * @group Events
  */
 export interface ScrollerScrollIndexChangeEvent extends ScrollerLazyLoadEvent {
 }
 /**
  * Custom scroll event.
  * @see {@link Scroller.onScroll}
+ * @group Events
  */
 export interface ScrollerScrollEvent {
     /**
@@ -117,6 +118,7 @@ export interface ScrollerScrollEvent {
 export interface ScrollerTemplates {
     /**
      * Custom content template.
+     * @param {Object} context - Content data.
      */
     content(context: {
         /**
@@ -133,6 +135,7 @@ export interface ScrollerTemplates {
     }>;
     /**
      * Custom item template.
+     * @param {Object} context - Item data.
      */
     item(context: {
         /**
@@ -149,16 +152,24 @@ export interface ScrollerTemplates {
     }>;
     /**
      * Custom loader template.
+     * @param {Object} context - Options instance.
      */
     loader(context: {
+        /**
+         * Options.
+         */
         options: ScrollerLoaderOptions;
     }): TemplateRef<{
         options: ScrollerLoaderOptions;
     }>;
     /**
      * Custom loader icon template.
+     * @param {Object} context - Icon options.
      */
     loadericon(context: {
+        /**
+         * Options.
+         */
         options: ScrollerLoaderIconOptions;
     }): TemplateRef<{
         options: ScrollerLoaderIconOptions;

package/scrollpanel/scrollpanel.d.ts

@@ -2,6 +2,10 @@ import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, NgZone,
 import { PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * ScrollPanel is a cross browser, lightweight and themable alternative to native browser scrollbar.
+ * @group Components
+ */
 export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnDestroy {
     private platformId;
     el: ElementRef;
@@ -57,7 +61,7 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     /**
      * Scrolls the top location to the given value.
      * @param scrollTop
-     * @group Methods
+     * @group Method
      */
     scrollTop(scrollTop: number): void;
     onDocumentMouseUp(e: Event): void;
@@ -66,7 +70,7 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     ngOnDestroy(): void;
     /**
      * Refreshes the position and size of the scrollbar.
-     * @group Methods
+     * @group Method
      */
     refresh(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ScrollPanel, never>;

package/scrollpanel/scrollpanel.interface.d.ts

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

package/scrolltop/scrolltop.d.ts

@@ -5,6 +5,10 @@ import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/chevronup";
 import * as i3 from "primeng/api";
+/**
+ * ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.
+ * @group Components
+ */
 export declare class ScrollTop implements OnInit, OnDestroy {
     private document;
     private platformId;
@@ -25,7 +29,7 @@ export declare class ScrollTop implements OnInit, OnDestroy {
         [klass: string]: any;
     } | null | undefined;
     /**
-     * Target of the ScrollTop, valid values are "window" and "parent".
+     * Target of the ScrollTop.
      * @group Props
      */
     target: 'window' | 'parent' | undefined;

package/selectbutton/selectbutton.d.ts

@@ -5,6 +5,10 @@ import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/ripple";
 export declare const SELECTBUTTON_VALUE_ACCESSOR: any;
+/**
+ * SelectButton is used to choose single or multiple items from a list using buttons.
+ * @group Components
+ */
 export declare class SelectButton implements ControlValueAccessor {
     cd: ChangeDetectorRef;
     /**

package/selectbutton/selectbutton.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom click event.
  * @see {@link SelectButton.onOptionClick}
+ * @group Events
  */
 export interface SelectButtonOptionClickEvent {
     /**
@@ -20,6 +21,7 @@ export interface SelectButtonOptionClickEvent {
 /**
  * Custom change event.
  * @see {@link SelectButton.onChange}
+ * @group Events
  */
 export interface SelectButtonChangeEvent {
     /**
@@ -39,5 +41,5 @@ export interface SelectButtonTemplates {
     /**
      * Custom item template.
      */
-    item: TemplateRef<any> | null;
+    item(): TemplateRef<any>;
 }

package/sidebar/sidebar.d.ts

@@ -6,6 +6,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";
+/**
+ * Sidebar is a panel component displayed as an overlay at the edges of the screen.
+ * @group Components
+ */
 export declare class Sidebar implements AfterViewInit, AfterContentInit, OnDestroy {
     private document;
     el: ElementRef;
@@ -26,7 +30,9 @@ export declare class Sidebar implements AfterViewInit, AfterContentInit, OnDestr
      * Inline style of the component.
      * @group Props
      */
-    style: any;
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Style class of the component.
      * @group Props
@@ -103,7 +109,7 @@ export declare class Sidebar implements AfterViewInit, AfterContentInit, OnDestr
     onHide: EventEmitter<any>;
     /**
      * Callback to invoke when dialog visibility is changed.
-     * @param {boolean} value - New value.
+     * @param {boolean} value - Visible value.
      * @group Emits
      */
     visibleChange: EventEmitter<boolean>;

package/sidebar/sidebar.interface.d.ts

@@ -7,17 +7,17 @@ export interface SidebarTemplates {
     /**
      * 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>;
 }

package/skeleton/skeleton.d.ts

@@ -1,5 +1,9 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Skeleton is a placeholder to display instead of the actual content.
+ * @group Components
+ */
 export declare class Skeleton {
     /**
      * Class of the element.

package/slidemenu/slidemenu.d.ts

@@ -36,6 +36,10 @@ export declare class SlideMenuSub implements OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<SlideMenuSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SlideMenuSub, "p-slideMenuSub", never, { "item": { "alias": "item"; "required": false; }; "root": { "alias": "root"; "required": false; }; "backLabel": { "alias": "backLabel"; "required": false; }; "menuWidth": { "alias": "menuWidth"; "required": false; }; "effectDuration": { "alias": "effectDuration"; "required": false; }; "easing": { "alias": "easing"; "required": false; }; "index": { "alias": "index"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * SlideMenu displays submenus with slide animation.
+ * @group Components
+ */
 export declare class SlideMenu implements AfterViewChecked, AfterContentInit, OnDestroy {
     private document;
     private platformId;
@@ -151,14 +155,14 @@ export declare class SlideMenu implements AfterViewChecked, AfterContentInit, On
     updateViewPort(): void;
     /**
      * Toggles the visibility of the popup menu.
-     * @group Methods
-     * @param event
+     * @param {Event} event - Browser event.
+     * @group Method
      */
     toggle(event: Event): void;
     /**
      * Displays the popup menu.
-     * @group Methods
-     * @param event
+     * @param {Event} event - Browser event.
+     * @group Method
      */
     show(event: Event): void;
     onOverlayClick(event: MouseEvent): void;
@@ -169,7 +173,7 @@ export declare class SlideMenu implements AfterViewChecked, AfterContentInit, On
     moveOnTop(): void;
     /**
      * Hides the popup menu.
-     * @group Methods
+     * @group Method
      */
     hide(): void;
     onWindowResize(): void;

package/slidemenu/slidemenu.interface.d.ts

@@ -7,9 +7,9 @@ export interface SlideMenuTemplates {
     /**
      * Custom template of backicon.
      */
-    backicon: TemplateRef<any> | null;
+    backicon(): TemplateRef<any>;
     /**
      * Custom template of submenuicon.
      */
-    submenuicon: TemplateRef<any> | null;
+    submenuicon(): TemplateRef<any>;
 }

package/slider/slider.d.ts

@@ -5,6 +5,10 @@ import { SliderChangeEvent, SliderSlideEndEvent } from './slider.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const SLIDER_VALUE_ACCESSOR: any;
+/**
+ * Slider is a component to provide input with a drag handle.
+ * @group Components
+ */
 export declare class Slider implements OnDestroy, ControlValueAccessor {
     private document;
     private platformId;

package/slider/slider.interface.d.ts

@@ -1,6 +1,7 @@
 /**
  * Custom change event.
  * @see {@link Slider.onChange}
+ * @group Events
  */
 export interface SliderChangeEvent {
     /**
@@ -19,6 +20,7 @@ export interface SliderChangeEvent {
 /**
  * Custom slide end event.
  * @see {@link Slider.onSlideEnd}
+ * @group Events
  */
 export interface SliderSlideEndEvent {
     /**

package/speeddial/speeddial.d.ts

@@ -8,6 +8,10 @@ import * as i4 from "primeng/tooltip";
 import * as i5 from "@angular/router";
 import * as i6 from "primeng/icons/plus";
 import * as i7 from "primeng/api";
+/**
+ * When pressed, a floating action button can display multiple primary actions that can be performed on a page.
+ * @group Components
+ */
 export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDestroy {
     private platformId;
     private el;
@@ -26,10 +30,11 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
     model: MenuItem[] | null;
     /**
      * Specifies the visibility of the overlay.
+     * @defaultValue false
      * @group Props
      */
-    get visible(): any;
-    set visible(value: any);
+    get visible(): boolean;
+    set visible(value: boolean);
     /**
      * Inline style of the element.
      * @group Props
@@ -93,7 +98,9 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
      * Inline style of the mask element.
      * @group Props
      */
-    maskStyle: any;
+    maskStyle: {
+        [klass: string]: any;
+    } | null | undefined;
     /**
      * Style class of the mask element.
      * @group Props
@@ -116,13 +123,13 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
     rotateAnimation: boolean;
     /**
      * Fired when the visibility of element changed.
-     * @param {Boolean} boolean - Visibility value.
+     * @param {boolean} boolean - Visibility value.
      * @group Emits
      */
     onVisibleChange: EventEmitter<boolean>;
     /**
      * Fired when the visibility of element changed.
-     * @param {Boolean} boolean - Visibility value.
+     * @param {boolean} boolean - Visibility value.
      * @group Emits
      */
     visibleChange: EventEmitter<boolean>;
@@ -186,8 +193,8 @@ export declare class SpeedDial implements AfterViewInit, AfterContentInit, OnDes
     };
     calculateTransitionDelay(index: number): number;
     containerClass(): {
-        [x: string]: any;
-        'p-speeddial-opened': any;
+        [x: string]: boolean;
+        'p-speeddial-opened': boolean;
         'p-disabled': boolean;
     };
     buttonClass(): {

package/speeddial/speeddial.interface.d.ts

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

package/splitbutton/splitbutton.d.ts

@@ -7,6 +7,10 @@ import * as i2 from "primeng/button";
 import * as i3 from "primeng/tieredmenu";
 import * as i4 from "primeng/icons/chevrondown";
 type SplitButtonIconPosition = 'left' | 'right';
+/**
+ * SplitButton groups a set of commands in an overlay with a default command.
+ * @group Components
+ */
 export declare class SplitButton {
     /**
      * MenuModel instance to define the overlay items.

package/splitbutton/splitbutton.interface.d.ts

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

package/splitter/splitter.d.ts

@@ -5,6 +5,10 @@ import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
+/**
+ * Splitter is utilized to separate and resize panels.
+ * @group Components
+ */
 export declare class Splitter {
     private document;
     private platformId;
@@ -39,17 +43,17 @@ export declare class Splitter {
      * Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage.
      * @group Props
      */
-    stateStorage: 'local' | 'session' | undefined;
+    stateStorage: string | undefined;
     /**
      * Storage identifier of a stateful Splitter.
      * @group Props
      */
     stateKey: string | undefined | null;
     /**
-     * Orientation of the panels.
+     * Orientation of the panels. Valid values are 'horizontal' and 'vertical'.
      * @group Props
      */
-    layout: 'horizontal' | 'vertical' | undefined;
+    layout: string | undefined;
     /**
      * Size of the divider in pixels.
      * @group Props

package/splitter/splitter.interface.d.ts

@@ -2,6 +2,7 @@ import { TemplateRef } from '@angular/core';
 /**
  * Custom panel resize start event.
  * @see {@link Splitter.onResizeStart}
+ * @group Events
  */
 export interface SplitterResizeStartEvent {
     /**
@@ -17,6 +18,7 @@ export interface SplitterResizeStartEvent {
  * Custom panel resize end event.
  * @see {@link Splitter.onResizeEnd}
  * @extends {SplitterResizeStartEvent}
+ * @group Events
  */
 export interface SplitterResizeEndEvent extends SplitterResizeStartEvent {
 }
@@ -28,5 +30,5 @@ export interface SplitterTemplates {
     /**
      * Custom panel template.
      */
-    panel: TemplateRef<any> | null;
+    panel(): TemplateRef<any>;
 }

package/steps/steps.d.ts

@@ -6,6 +6,10 @@ import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
 import * as i3 from "primeng/tooltip";
+/**
+ * Steps components is an indicator for the steps in a wizard workflow.
+ * @group Components
+ */
 export declare class Steps implements OnInit, OnDestroy {
     private router;
     private route;
@@ -16,7 +20,7 @@ export declare class Steps implements OnInit, OnDestroy {
      */
     activeIndex: number;
     /**
-     * An array of menuitems.
+     * An array of menu items.
      * @group Props
      */
     model: MenuItem[] | undefined;

package/styleclass/styleclass.d.ts

@@ -2,6 +2,10 @@ import { ElementRef, NgZone, OnDestroy, Renderer2 } from '@angular/core';
 import { VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * StyleClass manages css classes declaratively to during enter/leave animations or just to toggle classes on an element.
+ * @group Components
+ */
 export declare class StyleClass implements OnDestroy {
     el: ElementRef;
     renderer: Renderer2;
@@ -11,7 +15,7 @@ export declare class StyleClass implements OnDestroy {
      * Selector to define the target element. Available selectors are '@next', '@prev', '@parent' and '@grandparent'.
      * @group Props
      */
-    selector: '@next' | '@prev' | '@parent' | '@grandparent' | string | undefined;
+    selector: string | undefined;
     /**
      * Style class to add when item begins to get displayed.
      * @group Props