primeng 16.0.0-rc.1 → 16.0.0

package/scrollpanel/scrollpanel.d.ts

@@ -1,6 +1,11 @@
-import { AfterViewInit, OnDestroy, ElementRef, NgZone, ChangeDetectorRef, AfterContentInit, QueryList, TemplateRef, Renderer2 } from '@angular/core';
+import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, NgZone, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+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;
@@ -8,29 +13,39 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     cd: ChangeDetectorRef;
     private document;
     private renderer;
-    style: any;
-    styleClass: string;
-    containerViewChild: ElementRef;
-    contentViewChild: ElementRef;
-    xBarViewChild: ElementRef;
-    yBarViewChild: ElementRef;
-    templates: QueryList<any>;
-    scrollYRatio: number;
-    scrollXRatio: number;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    containerViewChild: ElementRef | undefined;
+    contentViewChild: ElementRef | undefined;
+    xBarViewChild: ElementRef | undefined;
+    yBarViewChild: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    scrollYRatio: number | undefined;
+    scrollXRatio: number | undefined;
     timeoutFrame: any;
     initialized: boolean;
-    lastPageY: number;
-    lastPageX: number;
+    lastPageY: number | undefined;
+    lastPageX: number | undefined;
     isXBarClicked: boolean;
     isYBarClicked: boolean;
-    contentTemplate: TemplateRef<any>;
-    windowResizeListener: VoidFunction | null;
-    contentScrollListener: VoidFunction | null;
-    mouseEnterListener: VoidFunction | null;
-    xBarMouseDownListener: VoidFunction | null;
-    yBarMouseDownListener: VoidFunction | null;
-    documentMouseMoveListener: VoidFunction | null;
-    documentMouseUpListener: VoidFunction | null;
+    contentTemplate: TemplateRef<any> | undefined;
+    windowResizeListener: VoidFunction | null | undefined;
+    contentScrollListener: VoidFunction | null | undefined;
+    mouseEnterListener: VoidFunction | null | undefined;
+    xBarMouseDownListener: VoidFunction | null | undefined;
+    yBarMouseDownListener: VoidFunction | null | undefined;
+    documentMouseMoveListener: VoidFunction | null | undefined;
+    documentMouseUpListener: VoidFunction | null | undefined;
     constructor(platformId: any, el: ElementRef, zone: NgZone, cd: ChangeDetectorRef, document: Document, renderer: Renderer2);
     ngAfterViewInit(): void;
     ngAfterContentInit(): void;
@@ -43,11 +58,20 @@ export declare class ScrollPanel implements AfterViewInit, AfterContentInit, OnD
     onDocumentMouseMove(e: MouseEvent): void;
     onMouseMoveForXBar(e: MouseEvent): void;
     onMouseMoveForYBar(e: MouseEvent): void;
+    /**
+     * Scrolls the top location to the given value.
+     * @param scrollTop
+     * @group Method
+     */
     scrollTop(scrollTop: number): void;
     onDocumentMouseUp(e: Event): void;
-    requestAnimationFrame(f: Function): void;
+    requestAnimationFrame(f: VoidFunction): void;
     unbindListeners(): void;
     ngOnDestroy(): void;
+    /**
+     * Refreshes the position and size of the scrollbar.
+     * @group Method
+     */
     refresh(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ScrollPanel, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ScrollPanel, "p-scrollPanel", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;

package/scrollpanel/scrollpanel.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in ScrollPanel.
+ * @group Templates
+ */
+export interface ScrollPanelTemplates {
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<any>;
+}

package/scrolltop/public_api.d.ts

@@ -1 +1,2 @@
 export * from './scrolltop';
+export * from './scrolltop.interface';

package/scrolltop/scrolltop.d.ts

@@ -1,10 +1,14 @@
-import { OnInit, OnDestroy, ElementRef, ChangeDetectorRef, Renderer2, QueryList, TemplateRef } from '@angular/core';
 import { AnimationEvent } from '@angular/animations';
-import { PrimeNGConfig } from 'primeng/api';
+import { ChangeDetectorRef, ElementRef, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 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;
@@ -12,18 +16,52 @@ export declare class ScrollTop implements OnInit, OnDestroy {
     el: ElementRef;
     private cd;
     config: PrimeNGConfig;
-    styleClass: string;
-    style: any;
-    target: string;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Target of the ScrollTop.
+     * @group Props
+     */
+    target: 'window' | 'parent' | undefined;
+    /**
+     * Defines the threshold value of the vertical scroll position of the target to toggle the visibility.
+     * @group Props
+     */
     threshold: number;
-    icon: string;
-    behavior: string;
+    /**
+     * Name of the icon or JSX.Element for icon.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Defines the scrolling behavior, "smooth" adds an animation and "auto" scrolls with a jump.
+     * @group Props
+     */
+    behavior: 'auto' | 'smooth' | undefined;
+    /**
+     * A string value used to determine the display transition options.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * A string value used to determine the hiding transition options.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    templates: QueryList<any>;
-    iconTemplate: TemplateRef<any>;
-    documentScrollListener: VoidFunction | null;
-    parentScrollListener: VoidFunction | null;
+    templates: QueryList<PrimeTemplate> | undefined;
+    iconTemplate: TemplateRef<any> | undefined;
+    documentScrollListener: VoidFunction | null | undefined;
+    parentScrollListener: VoidFunction | null | undefined;
     visible: boolean;
     overlay: any;
     private window;
@@ -33,7 +71,7 @@ export declare class ScrollTop implements OnInit, OnDestroy {
     onClick(): void;
     onEnter(event: AnimationEvent): void;
     onLeave(event: AnimationEvent): void;
-    checkVisibility(scrollY: any): void;
+    checkVisibility(scrollY: number): void;
     bindParentScrollListener(): void;
     bindDocumentScrollListener(): void;
     unbindParentScrollListener(): void;

package/scrolltop/scrolltop.interface.d.ts

@@ -0,0 +1,18 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in ScrollTop.
+ * @group Templates
+ */
+export interface ScrollTopTemplates {
+    /**
+     * Icon of the component.
+     */
+    icon(context: {
+        /**
+         * Style class of the icon.
+         */
+        styleClass: 'p-scrolltop-icon';
+    }): TemplateRef<{
+        styleClass: string;
+    }>;
+}

package/selectbutton/public_api.d.ts

@@ -1 +1,2 @@
 export * from './selectbutton';
+export * from './selectbutton.interface';

package/selectbutton/selectbutton.d.ts

@@ -1,25 +1,84 @@
-import { EventEmitter, ChangeDetectorRef } from '@angular/core';
+import { EventEmitter, ChangeDetectorRef, TemplateRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { SelectButtonChangeEvent, SelectButtonOptionClickEvent } from './selectbutton.interface';
 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;
-    options: any[];
-    optionLabel: string;
-    optionValue: string;
-    optionDisabled: string;
+    /**
+     * An array of selectitems to display as the available options.
+     * @group Props
+     */
+    options: any[] | undefined;
+    /**
+     * Name of the label field of an option.
+     * @group Props
+     */
+    optionLabel: string | undefined;
+    /**
+     * Name of the value field of an option.
+     * @group Props
+     */
+    optionValue: string | undefined;
+    /**
+     * Name of the disabled field of an option.
+     * @group Props
+     */
+    optionDisabled: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
     tabindex: number;
-    multiple: boolean;
+    /**
+     * When specified, allows selecting multiple values.
+     * @group Props
+     */
+    multiple: boolean | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
     style: any;
-    styleClass: string;
-    ariaLabelledBy: string;
-    disabled: boolean;
-    dataKey: string;
-    onOptionClick: EventEmitter<any>;
-    onChange: EventEmitter<any>;
-    itemTemplate: any;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Establishes relationships between the component and label(s) where its value should be one or more element IDs.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * A property to uniquely identify a value in options.
+     * @group Props
+     */
+    dataKey: string | undefined;
+    /**
+     * Callback to invoke on input click.
+     * @param {SelectButtonOptionClickEvent} event - Custom click event.
+     * @group Emits
+     */
+    onOptionClick: EventEmitter<SelectButtonOptionClickEvent>;
+    /**
+     * Callback to invoke on selection change.
+     * @param {SelectButtonChangeEvent} event - Custom change event.
+     * @group Emits
+     */
+    onChange: EventEmitter<SelectButtonChangeEvent>;
+    itemTemplate: TemplateRef<any>;
     value: any;
     onModelChange: Function;
     onModelTouched: Function;
@@ -31,7 +90,7 @@ export declare class SelectButton implements ControlValueAccessor {
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
     setDisabledState(val: boolean): void;
-    onItemClick(event: any, option: any, index: number): void;
+    onItemClick(event: Event, option: any, index: number): void;
     onBlur(): void;
     removeOption(option: any): void;
     isSelected(option: any): boolean;

package/selectbutton/selectbutton.interface.d.ts

@@ -0,0 +1,45 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom click event.
+ * @see {@link SelectButton.onOptionClick}
+ * @group Events
+ */
+export interface SelectButtonOptionClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    option?: any;
+    /**
+     * Index of the selected option.
+     */
+    index?: number;
+}
+/**
+ * Custom change event.
+ * @see {@link SelectButton.onChange}
+ * @group Events
+ */
+export interface SelectButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+    /**
+     * Selected option.
+     */
+    value?: any;
+}
+/**
+ * Defines valid templates in SelectButton.
+ * @group Templates
+ */
+export interface SelectButtonTemplates {
+    /**
+     * Custom item template.
+     */
+    item(): TemplateRef<any>;
+}

package/sidebar/public_api.d.ts

@@ -1 +1,2 @@
 export * from './sidebar';
+export * from './sidebar.interface';

package/sidebar/sidebar.d.ts

@@ -1,55 +1,135 @@
 import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
-import { PrimeNGConfig } from 'primeng/api';
+import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 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;
     renderer: Renderer2;
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
-    appendTo: any;
+    /**
+     *  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;
+    /**
+     * Whether to block scrolling of the document when sidebar is active.
+     * @group Props
+     */
     blockScroll: boolean;
-    style: any;
-    styleClass: string;
-    ariaCloseLabel: string;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Aria label of the close icon.
+     * @group Props
+     */
+    ariaCloseLabel: string | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
+    /**
+     * Whether an overlay mask is displayed behind the sidebar.
+     * @group Props
+     */
     modal: boolean;
+    /**
+     * Whether to dismiss sidebar on click of the mask.
+     * @group Props
+     */
     dismissible: boolean;
+    /**
+     * Whether to display the close icon.
+     * @group Props
+     */
     showCloseIcon: boolean;
+    /**
+     * Specifies if pressing escape key should hide the sidebar.
+     * @group Props
+     */
     closeOnEscape: boolean;
+    /**
+     * Transition options of the animation.
+     * @group Props
+     */
     transitionOptions: string;
-    templates: QueryList<any>;
+    /**
+     * Specifies the visibility of the dialog.
+     * @group Props
+     */
+    get visible(): boolean;
+    set visible(val: boolean);
+    /**
+     * Specifies the position of the sidebar, valid values are "left", "right", "bottom" and "top".
+     * @group Props
+     */
+    get position(): string;
+    set position(value: string);
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     * @group Props
+     */
+    get fullScreen(): boolean;
+    set fullScreen(value: boolean);
+    templates: QueryList<PrimeTemplate> | undefined;
+    /**
+     * Callback to invoke when dialog is shown.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Callback to invoke when dialog is hidden.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    visibleChange: EventEmitter<any>;
-    initialized: boolean;
-    _visible: boolean;
+    /**
+     * Callback to invoke when dialog visibility is changed.
+     * @param {boolean} value - Visible value.
+     * @group Emits
+     */
+    visibleChange: EventEmitter<boolean>;
+    initialized: boolean | undefined;
+    _visible: boolean | undefined;
     _position: string;
     _fullScreen: boolean;
-    container: HTMLDivElement;
+    container: Nullable<HTMLDivElement>;
     transformOptions: any;
-    mask: HTMLDivElement;
-    maskClickListener: VoidFunction | null;
-    documentEscapeListener: VoidFunction | null;
-    animationEndListener: VoidFunction | null;
-    contentTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    closeIconTemplate: TemplateRef<any>;
+    mask: Nullable<HTMLDivElement>;
+    maskClickListener: VoidListener;
+    documentEscapeListener: VoidListener;
+    animationEndListener: VoidListener;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    closeIconTemplate: Nullable<TemplateRef<any>>;
     constructor(document: Document, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig);
     ngAfterViewInit(): void;
     ngAfterContentInit(): void;
-    get visible(): boolean;
-    set visible(val: boolean);
-    get position(): string;
-    set position(value: string);
-    get fullScreen(): boolean;
-    set fullScreen(value: boolean);
     show(): void;
     hide(emit?: boolean): void;
     close(event: Event): void;

package/sidebar/sidebar.interface.d.ts

@@ -0,0 +1,23 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Sidebar.
+ * @group Templates
+ */
+export interface SidebarTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon(): TemplateRef<any>;
+}

package/skeleton/skeleton.d.ts

@@ -1,20 +1,62 @@
 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 {
-    styleClass: string;
-    style: any;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Shape of the element.
+     * @group Props
+     */
     shape: string;
+    /**
+     * Type of the animation.
+     * @gruop Props
+     */
     animation: string;
-    borderRadius: string;
-    size: string;
+    /**
+     * Border radius of the element, defaults to value from theme.
+     * @group Props
+     */
+    borderRadius: string | undefined;
+    /**
+     * Size of the Circle or Square.
+     * @group Props
+     */
+    size: string | undefined;
+    /**
+     * Width of the element.
+     * @group Props
+     */
     width: string;
+    /**
+     * Height of the element.
+     * @group Props
+     */
     height: string;
     containerClass(): {
         'p-skeleton p-component': boolean;
         'p-skeleton-circle': boolean;
         'p-skeleton-none': boolean;
     };
-    containerStyle(): any;
+    containerStyle(): {
+        width: string;
+        height: string;
+        borderRadius: string;
+    };
     static ɵfac: i0.ɵɵFactoryDeclaration<Skeleton, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Skeleton, "p-skeleton", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "shape": { "alias": "shape"; "required": false; }; "animation": { "alias": "animation"; "required": false; }; "borderRadius": { "alias": "borderRadius"; "required": false; }; "size": { "alias": "size"; "required": false; }; "width": { "alias": "width"; "required": false; }; "height": { "alias": "height"; "required": false; }; }, {}, never, never, false, never>;
 }

package/slidemenu/public_api.d.ts

@@ -1 +1,2 @@
 export * from './slidemenu';
+export * from './slidemenu.interface';