primeng 16.0.0-rc.1 → 16.0.0

package/dialog/dialog.d.ts

@@ -1,6 +1,7 @@
-import { ElementRef, OnDestroy, EventEmitter, Renderer2, QueryList, NgZone, ChangeDetectorRef, AfterContentInit, TemplateRef, OnInit } from '@angular/core';
 import { AnimationEvent } from '@angular/animations';
-import { Header, Footer, PrimeNGConfig } from 'primeng/api';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { Footer, Header, 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/focustrap";
@@ -9,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;
@@ -17,87 +22,277 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
     zone: NgZone;
     private cd;
     config: PrimeNGConfig;
-    header: string;
+    /**
+     * Title text of the dialog.
+     * @group Props
+     */
+    header: string | undefined;
+    /**
+     * Enables dragging to change the position using header.
+     * @group Props
+     */
     draggable: boolean;
+    /**
+     * Enables resizing of the content.
+     * @group Props
+     */
     resizable: boolean;
+    /**
+     * Defines the left offset of dialog.
+     * @group Props
+     * @deprecated positionLeft property is deprecated.
+     */
     get positionLeft(): number;
     set positionLeft(_positionLeft: number);
+    /**
+     * Defines the top offset of dialog.
+     * @group Props
+     * @deprecated positionTop property is deprecated.
+     */
     get positionTop(): number;
     set positionTop(_positionTop: number);
+    /**
+     * Style of the content section.
+     * @group Props
+     */
     contentStyle: any;
-    contentStyleClass: string;
+    /**
+     * Style class of the content.
+     * @group Props
+     */
+    contentStyleClass: string | undefined;
+    /**
+     * Defines if background should be blocked when dialog is displayed.
+     * @group Props
+     */
     modal: boolean;
+    /**
+     * Specifies if pressing escape key should hide the dialog.
+     * @group Props
+     */
     closeOnEscape: boolean;
+    /**
+     * Specifies if clicking the modal background should hide the dialog.
+     * @group Props
+     */
     dismissableMask: boolean;
+    /**
+     * When enabled dialog is displayed in RTL direction.
+     * @group Props
+     */
     rtl: boolean;
+    /**
+     * Adds a close icon to the header to hide the dialog.
+     * @group Props
+     */
     closable: boolean;
+    /**
+     * Defines if the component is responsive.
+     * @group Props
+     * @deprecated Responsive property is deprecated.
+     */
     get responsive(): boolean;
     set responsive(_responsive: boolean);
-    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;
+    /**
+     * Object literal to define widths per screen size.
+     * @group Props
+     */
     breakpoints: any;
-    styleClass: string;
-    maskStyleClass: string;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Style class of the mask.
+     * @group Props
+     */
+    maskStyleClass: string | undefined;
+    /**
+     * Whether to show the header or not.
+     * @group Props
+     */
     showHeader: boolean;
+    /**
+     * 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);
+    /**
+     * Whether background scroll should be blocked when dialog is visible.
+     * @group Props
+     */
     blockScroll: boolean;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
+    /**
+     * Minimum value for the left coordinate of dialog in dragging.
+     * @group Props
+     */
     minX: number;
+    /**
+     * Minimum value for the top coordinate of dialog in dragging.
+     * @group Props
+     */
     minY: number;
+    /**
+     * When enabled, first button receives focus on show.
+     * @group Props
+     */
     focusOnShow: boolean;
+    /**
+     * Whether the dialog can be displayed full screen.
+     * @group Props
+     */
     maximizable: boolean;
+    /**
+     * Keeps dialog in the viewport.
+     * @group Props
+     */
     keepInViewport: boolean;
+    /**
+     * When enabled, can only focus on elements inside the dialog.
+     * @group Props
+     */
     focusTrap: boolean;
+    /**
+     * Transition options of the animation.
+     * @group Props
+     */
     transitionOptions: string;
-    closeIcon: string;
-    closeAriaLabel: string;
+    /**
+     * Name of the close icon.
+     * @group Props
+     */
+    closeIcon: string | undefined;
+    /**
+     * Defines a string that labels the close button for accessibility.
+     * @group Props
+     */
+    closeAriaLabel: string | undefined;
+    /**
+     * Index of the close button in tabbing order.
+     * @group Props
+     */
     closeTabindex: string;
-    minimizeIcon: string;
-    maximizeIcon: string;
-    headerFacet: QueryList<Header>;
-    footerFacet: QueryList<Footer>;
-    templates: QueryList<any>;
-    headerViewChild: ElementRef;
-    contentViewChild: ElementRef;
-    footerViewChild: ElementRef;
+    /**
+     * Name of the minimize icon.
+     * @group Props
+     */
+    minimizeIcon: string | undefined;
+    /**
+     * Name of the maximize icon.
+     * @group Props
+     */
+    maximizeIcon: string | undefined;
+    /**
+     * Specifies the visibility of the dialog.
+     * @group Props
+     */
+    get visible(): boolean;
+    set visible(value: boolean);
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    get style(): any;
+    set style(value: any);
+    /**
+     * Position of the dialog.
+     * @group Props
+     */
+    get position(): 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright';
+    set position(value: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright');
+    /**
+     * 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>;
-    onResizeInit: EventEmitter<any>;
-    onResizeEnd: EventEmitter<any>;
-    onDragEnd: EventEmitter<any>;
+    /**
+     * This EventEmitter is used to notify changes in the visibility state of a component.
+     * @param {boolean} value - New value.
+     * @group Emits
+     */
+    visibleChange: EventEmitter<boolean>;
+    /**
+     * Callback to invoke when dialog resizing is initiated.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onResizeInit: EventEmitter<MouseEvent>;
+    /**
+     * Callback to invoke when dialog resizing is completed.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onResizeEnd: EventEmitter<MouseEvent>;
+    /**
+     * Callback to invoke when dialog dragging is completed.
+     * @param {DragEvent} event - Drag event.
+     * @group Emits
+     */
+    onDragEnd: EventEmitter<DragEvent>;
+    /**
+     * Callback to invoke when dialog maximized or unmaximized.
+     * @group Emits
+     */
     onMaximize: EventEmitter<any>;
-    headerTemplate: TemplateRef<any>;
-    contentTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    maximizeIconTemplate: TemplateRef<any>;
-    closeIconTemplate: TemplateRef<any>;
-    minimizeIconTemplate: TemplateRef<any>;
+    headerFacet: QueryList<Header> | undefined;
+    footerFacet: QueryList<Footer> | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    headerViewChild: Nullable<ElementRef>;
+    contentViewChild: Nullable<ElementRef>;
+    footerViewChild: Nullable<ElementRef>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    maximizeIconTemplate: Nullable<TemplateRef<any>>;
+    closeIconTemplate: Nullable<TemplateRef<any>>;
+    minimizeIconTemplate: Nullable<TemplateRef<any>>;
     _visible: boolean;
-    maskVisible: boolean;
-    container: HTMLDivElement;
-    wrapper: HTMLElement;
-    dragging: boolean;
-    documentDragListener: VoidFunction | null;
-    documentDragEndListener: VoidFunction | null;
-    resizing: boolean;
-    documentResizeListener: VoidFunction | null;
-    documentResizeEndListener: VoidFunction | null;
-    documentEscapeListener: VoidFunction | null;
-    maskClickListener: VoidFunction | null;
-    lastPageX: number;
-    lastPageY: number;
-    preventVisibleChangePropagation: boolean;
-    maximized: boolean;
-    preMaximizeContentHeight: number;
-    preMaximizeContainerWidth: number;
-    preMaximizeContainerHeight: number;
-    preMaximizePageX: number;
-    preMaximizePageY: number;
+    maskVisible: boolean | undefined;
+    container: Nullable<HTMLDivElement>;
+    wrapper: Nullable<HTMLElement>;
+    dragging: boolean | undefined;
+    documentDragListener: VoidListener;
+    documentDragEndListener: VoidListener;
+    resizing: boolean | undefined;
+    documentResizeListener: VoidListener;
+    documentResizeEndListener: VoidListener;
+    documentEscapeListener: VoidListener;
+    maskClickListener: VoidListener;
+    lastPageX: number | undefined;
+    lastPageY: number | undefined;
+    preventVisibleChangePropagation: boolean | undefined;
+    maximized: boolean | undefined;
+    preMaximizeContentHeight: number | undefined;
+    preMaximizeContainerWidth: number | undefined;
+    preMaximizeContainerHeight: number | undefined;
+    preMaximizePageX: number | undefined;
+    preMaximizePageY: number | undefined;
     id: string;
     _style: any;
-    _position: string;
+    _position: 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topleft' | 'topright' | 'bottomleft' | 'bottomright';
     originalStyle: any;
     transformOptions: any;
     styleElement: any;
@@ -105,12 +300,6 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
     constructor(document: Document, platformId: any, el: ElementRef, renderer: Renderer2, zone: NgZone, cd: ChangeDetectorRef, config: PrimeNGConfig);
     ngAfterContentInit(): void;
     ngOnInit(): void;
-    get visible(): any;
-    set visible(value: any);
-    get style(): any;
-    set style(value: any);
-    get position(): string;
-    set position(value: string);
     focus(): void;
     close(event: Event): void;
     enableModality(): void;
@@ -122,12 +311,12 @@ export declare class Dialog implements AfterContentInit, OnInit, OnDestroy {
     initDrag(event: MouseEvent): void;
     onKeydown(event: KeyboardEvent): void;
     onDrag(event: MouseEvent): void;
-    endDrag(event: MouseEvent): void;
+    endDrag(event: DragEvent): void;
     resetPosition(): void;
     center(): void;
     initResize(event: MouseEvent): void;
     onResize(event: MouseEvent): void;
-    resizeEnd(event: any): void;
+    resizeEnd(event: MouseEvent): void;
     bindGlobalListeners(): void;
     unbindGlobalListeners(): void;
     bindDocumentDragListener(): void;

package/dialog/dialog.interface.d.ts

@@ -0,0 +1,31 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Dialog.
+ * @group Templates
+ */
+export interface DialogTemplates {
+    /**
+     * 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>;
+    /**
+     * Custom template of maximizeicon.
+     */
+    maximizeicon(): TemplateRef<any>;
+    /**
+     * Custom template of minimizeicon.
+     */
+    minimizeicon(): TemplateRef<any>;
+}

package/dialog/public_api.d.ts

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

package/divider/divider.d.ts

@@ -1,11 +1,37 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Divider is used to separate contents.
+ * @group Components
+ */
 export declare class Divider {
-    styleClass: string;
-    style: any;
-    layout: string;
-    type: string;
-    align: string;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Specifies the orientation.
+     * @group Props
+     */
+    layout: 'horizontal' | 'vertical' | undefined;
+    /**
+     * Border style type.
+     * @group Props
+     */
+    type: 'solid' | 'dashed' | 'dotted' | undefined;
+    /**
+     * Alignment of the content.
+     * @group Props
+     */
+    align: 'left' | 'center' | 'right' | 'top' | 'center' | 'bottom' | undefined;
     containerClass(): {
         'p-divider p-component': boolean;
         'p-divider-horizontal': boolean;
@@ -20,7 +46,7 @@ export declare class Divider {
         'p-divider-bottom': boolean;
     };
     static ɵfac: i0.ɵɵFactoryDeclaration<Divider, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Divider, "p-divider", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; "type": { "alias": "type"; "required": false; }; "align": { "alias": "align"; "required": false; }; }, {}, never, ["*"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Divider, "p-divider", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; "type": { "alias": "type"; "required": false; }; "align": { "alias": "align"; "required": false; }; }, {}, never, ["*"], false, never>;
 }
 export declare class DividerModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<DividerModule, never>;

package/dock/dock.d.ts

@@ -1,31 +1,58 @@
-import { ElementRef, TemplateRef, AfterContentInit, QueryList, ChangeDetectorRef } from '@angular/core';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, QueryList, TemplateRef } from '@angular/core';
+import { MenuItem, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 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;
-    id: string;
-    style: any;
-    styleClass: string;
-    model: any[];
-    position: string;
-    templates: QueryList<any>;
-    itemTemplate: TemplateRef<any>;
+    /**
+     * Current id state as a string.
+     * @group Props
+     */
+    id: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * MenuModel instance to define the action items.
+     * @group Props
+     */
+    model: MenuItem[] | undefined | null;
+    /**
+     * Position of element.
+     * @group Props
+     */
+    position: 'bottom' | 'top' | 'left' | 'right';
+    templates: QueryList<PrimeTemplate> | undefined;
+    itemTemplate: TemplateRef<any> | undefined;
     currentIndex: number;
     constructor(el: ElementRef, cd: ChangeDetectorRef);
     ngAfterContentInit(): void;
     onListMouseLeave(): void;
-    onItemMouseEnter(index: any): void;
-    onItemClick(e: any, item: any): void;
+    onItemMouseEnter(index: number): void;
+    onItemClick(e: Event, item: MenuItem): void;
     get containerClass(): {
         [x: string]: boolean;
     };
     isClickableRouterLink(item: any): boolean;
-    itemClass(index: any): {
+    itemClass(index: number): {
         'p-dock-item': boolean;
         'p-dock-item-second-prev': boolean;
         'p-dock-item-prev': boolean;

package/dock/dock.interface.d.ts

@@ -0,0 +1,19 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Dock.
+ * @group Templates
+ */
+export interface DockTemplates {
+    /**
+     * Custom template of item.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}

package/dock/public_api.d.ts

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