primeng 16.0.0-rc.1 → 16.0.0-rc.2

package/splitbutton/splitbutton.d.ts

@@ -1,5 +1,5 @@
-import { ElementRef, EventEmitter, TemplateRef, QueryList } from '@angular/core';
-import { MenuItem } from 'primeng/api';
+import { ElementRef, EventEmitter, QueryList, TemplateRef } from '@angular/core';
+import { MenuItem, PrimeTemplate } from 'primeng/api';
 import { TieredMenu } from 'primeng/tieredmenu';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
@@ -8,32 +8,106 @@ import * as i3 from "primeng/tieredmenu";
 import * as i4 from "primeng/icons/chevrondown";
 type SplitButtonIconPosition = 'left' | 'right';
 export declare class SplitButton {
-    model: MenuItem[];
-    icon: string;
+    /**
+     * MenuModel instance to define the overlay items.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Name of the icon.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Position of the icon.
+     * @group Props
+     */
     iconPos: SplitButtonIconPosition;
-    label: string;
-    onClick: EventEmitter<any>;
-    onDropdownClick: EventEmitter<any>;
-    style: any;
-    styleClass: string;
-    menuStyle: any;
-    menuStyleClass: string;
-    disabled: boolean;
-    tabindex: number;
-    appendTo: any;
-    dir: string;
-    expandAriaLabel: string;
+    /**
+     * Text of the button.
+     * @group Props
+     */
+    label: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the overlay menu.
+     * @group Props
+     */
+    menuStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the overlay menu.
+     * @group Props
+     */
+    menuStyleClass: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Prop
+     */
+    tabindex: number | undefined;
+    /**
+     *  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).
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Indicates the direction of the element.
+     * @group Props
+     */
+    dir: string | undefined;
+    /**
+     * Defines a string that labels the expand button for accessibility.
+     * @group Props
+     */
+    expandAriaLabel: string | undefined;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    containerViewChild: ElementRef;
-    buttonViewChild: ElementRef;
-    menu: TieredMenu;
-    templates: QueryList<any>;
-    contentTemplate: TemplateRef<any>;
-    dropdownIconTemplate: TemplateRef<any>;
+    /**
+     * Callback to invoke when default command button is clicked.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onClick: EventEmitter<MouseEvent>;
+    /**
+     * Callback to invoke when dropdown button is clicked.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onDropdownClick: EventEmitter<MouseEvent>;
+    containerViewChild: ElementRef | undefined;
+    buttonViewChild: ElementRef | undefined;
+    menu: TieredMenu | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    contentTemplate: TemplateRef<any> | undefined;
+    dropdownIconTemplate: TemplateRef<any> | undefined;
     ngAfterContentInit(): void;
-    onDefaultButtonClick(event: Event): void;
-    onDropdownButtonClick(event: Event): void;
+    onDefaultButtonClick(event: MouseEvent): void;
+    onDropdownButtonClick(event: MouseEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SplitButton, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SplitButton, "p-splitButton", never, { "model": { "alias": "model"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "iconPos": { "alias": "iconPos"; "required": false; }; "label": { "alias": "label"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "menuStyle": { "alias": "menuStyle"; "required": false; }; "menuStyleClass": { "alias": "menuStyleClass"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "appendTo": { "alias": "appendTo"; "required": false; }; "dir": { "alias": "dir"; "required": false; }; "expandAriaLabel": { "alias": "expandAriaLabel"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; }, { "onClick": "onClick"; "onDropdownClick": "onDropdownClick"; }, ["templates"], never, false, never>;
 }

package/splitbutton/splitbutton.interface.d.ts

@@ -0,0 +1,15 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in SplitButton.
+ * @group Templates
+ */
+export interface SplitButtonTemplates {
+    /**
+     * Custom template of content.
+     */
+    content: TemplateRef<any> | null;
+    /**
+     * Custom template of dropdownicon.
+     */
+    dropdownicon: TemplateRef<any> | null;
+}

package/splitter/public_api.d.ts

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

package/splitter/splitter.d.ts

@@ -1,4 +1,7 @@
 import { QueryList, ElementRef, ChangeDetectorRef, EventEmitter, Renderer2 } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
+import { SplitterResizeStartEvent, SplitterResizeEndEvent } from './splitter.interface';
+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";
@@ -8,49 +11,103 @@ export declare class Splitter {
     private renderer;
     cd: ChangeDetectorRef;
     private el;
-    styleClass: string;
-    panelStyleClass: string;
-    style: any;
-    panelStyle: any;
-    stateStorage: string;
-    stateKey: string;
-    layout: string;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Style class of the panel.
+     * @group Props
+     */
+    panelStyleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Inline style of the panel.
+     * @group Props
+     */
+    panelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Defines where a stateful splitter keeps its state, valid values are 'session' for sessionStorage and 'local' for localStorage.
+     * @group Props
+     */
+    stateStorage: 'local' | 'session' | undefined;
+    /**
+     * Storage identifier of a stateful Splitter.
+     * @group Props
+     */
+    stateKey: string | undefined | null;
+    /**
+     * Orientation of the panels.
+     * @group Props
+     */
+    layout: 'horizontal' | 'vertical' | undefined;
+    /**
+     * Size of the divider in pixels.
+     * @group Props
+     */
     gutterSize: number;
+    /**
+     * Minimum size of the elements relative to 100%.
+     * @group Props
+     */
     minSizes: number[];
-    onResizeEnd: EventEmitter<any>;
-    onResizeStart: EventEmitter<any>;
-    templates: QueryList<any>;
-    containerViewChild: ElementRef;
+    /**
+     * Size of the elements relative to 100%.
+     * @group Props
+     */
     get panelSizes(): number[];
     set panelSizes(val: number[]);
+    /**
+     * Callback to invoke when resize ends.
+     * @param {SplitterResizeEndEvent} event - Custom panel resize end event
+     * @group Emits
+     */
+    onResizeEnd: EventEmitter<SplitterResizeEndEvent>;
+    /**
+     * Callback to invoke when resize starts.
+     * @param {SplitterResizeStartEvent} event - Custom panel resize start event
+     * @group Emits
+     */
+    onResizeStart: EventEmitter<SplitterResizeStartEvent>;
+    templates: QueryList<PrimeTemplate>;
+    containerViewChild: Nullable<ElementRef>;
     nested: boolean;
     panels: any[];
     dragging: boolean;
-    mouseMoveListener: VoidFunction | null;
-    mouseUpListener: VoidFunction | null;
-    touchMoveListener: VoidFunction | null;
-    touchEndListener: VoidFunction | null;
-    size: any;
-    gutterElement: any;
-    startPos: any;
-    prevPanelElement: any;
-    nextPanelElement: any;
-    nextPanelSize: any;
-    prevPanelSize: any;
+    mouseMoveListener: VoidListener;
+    mouseUpListener: VoidListener;
+    touchMoveListener: VoidListener;
+    touchEndListener: VoidListener;
+    size: Nullable<number>;
+    gutterElement: Nullable<ElementRef | HTMLElement>;
+    startPos: Nullable<number>;
+    prevPanelElement: Nullable<ElementRef | HTMLElement>;
+    nextPanelElement: Nullable<ElementRef | HTMLElement>;
+    nextPanelSize: Nullable<number>;
+    prevPanelSize: Nullable<number>;
     _panelSizes: number[];
-    prevPanelIndex: any;
+    prevPanelIndex: Nullable<number>;
     private window;
     constructor(document: Document, platformId: any, renderer: Renderer2, cd: ChangeDetectorRef, el: ElementRef);
     ngOnInit(): void;
     ngAfterContentInit(): void;
     ngAfterViewInit(): void;
-    resizeStart(event: any, index: any): void;
-    onResize(event: any): void;
-    resizeEnd(event: any): void;
-    onGutterMouseDown(event: any, index: any): void;
-    onGutterTouchStart(event: any, index: any): void;
-    onGutterTouchEnd(event: any): void;
-    validateResize(newPrevPanelSize: any, newNextPanelSize: any): boolean;
+    resizeStart(event: TouchEvent | MouseEvent, index: number): void;
+    onResize(event: MouseEvent): void;
+    resizeEnd(event: MouseEvent | TouchEvent): void;
+    onGutterMouseDown(event: MouseEvent, index: number): void;
+    onGutterTouchStart(event: TouchEvent, index: number): void;
+    onGutterTouchEnd(event: TouchEvent): void;
+    validateResize(newPrevPanelSize: number, newNextPanelSize: number): boolean;
     bindMouseListeners(): void;
     bindTouchListeners(): void;
     unbindMouseListeners(): void;

package/splitter/splitter.interface.d.ts

@@ -0,0 +1,32 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom panel resize start event.
+ * @see {@link Splitter.onResizeStart}
+ */
+export interface SplitterResizeStartEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: TouchEvent | MouseEvent;
+    /**
+     * Collapsed state of the panel.
+     */
+    sizes: number[];
+}
+/**
+ * Custom panel resize end event.
+ * @see {@link Splitter.onResizeEnd}
+ * @extends {SplitterResizeStartEvent}
+ */
+export interface SplitterResizeEndEvent extends SplitterResizeStartEvent {
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+export interface SplitterTemplates {
+    /**
+     * Custom panel template.
+     */
+    panel: TemplateRef<any> | null;
+}

package/steps/steps.d.ts

@@ -1,6 +1,6 @@
-import { EventEmitter, OnInit, OnDestroy, ChangeDetectorRef } from '@angular/core';
+import { ChangeDetectorRef, EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { ActivatedRoute, Router } from '@angular/router';
 import { MenuItem } from 'primeng/api';
-import { Router, ActivatedRoute } from '@angular/router';
 import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
@@ -10,14 +10,41 @@ export declare class Steps implements OnInit, OnDestroy {
     private router;
     private route;
     private cd;
+    /**
+     * Index of the active item.
+     * @group Props
+     */
     activeIndex: number;
-    model: MenuItem[];
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Whether the items are clickable or not.
+     * @group Props
+     */
     readonly: boolean;
-    style: any;
-    styleClass: string;
-    activeIndexChange: EventEmitter<any>;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Callback to invoke when the new step is selected.
+     * @param {number} number - current index.
+     * @group Emits
+     */
+    activeIndexChange: EventEmitter<number>;
     constructor(router: Router, route: ActivatedRoute, cd: ChangeDetectorRef);
-    subscription: Subscription;
+    subscription: Subscription | undefined;
     ngOnInit(): void;
     itemClick(event: Event, item: MenuItem, i: number): void;
     isClickableRouterLink(item: MenuItem): boolean;

package/styleclass/styleclass.d.ts

@@ -1,4 +1,5 @@
 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";
 export declare class StyleClass implements OnDestroy {
@@ -6,23 +7,63 @@ export declare class StyleClass implements OnDestroy {
     renderer: Renderer2;
     private zone;
     constructor(el: ElementRef, renderer: Renderer2, zone: NgZone);
-    selector: string;
-    enterClass: string;
-    enterActiveClass: string;
-    enterToClass: string;
-    leaveClass: string;
-    leaveActiveClass: string;
-    leaveToClass: string;
-    hideOnOutsideClick: boolean;
-    toggleClass: string;
-    hideOnEscape: boolean;
-    eventListener: Function;
-    documentClickListener: Function;
-    documentKeydownListener: Function;
-    target: HTMLElement;
-    enterListener: Function;
-    leaveListener: Function;
-    animating: boolean;
+    /**
+     * Selector to define the target element. Available selectors are '@next', '@prev', '@parent' and '@grandparent'.
+     * @group Props
+     */
+    selector: '@next' | '@prev' | '@parent' | '@grandparent' | string | undefined;
+    /**
+     * Style class to add when item begins to get displayed.
+     * @group Props
+     */
+    enterClass: string | undefined;
+    /**
+     * Style class to add during enter animation.
+     * @group Props
+     */
+    enterActiveClass: string | undefined;
+    /**
+     * Style class to add when item begins to get displayed.
+     * @group Props
+     */
+    enterToClass: string | undefined;
+    /**
+     * Style class to add when item begins to get hidden.
+     * @group Props
+     */
+    leaveClass: string | undefined;
+    /**
+     * Style class to add during leave animation.
+     * @group Props
+     */
+    leaveActiveClass: string | undefined;
+    /**
+     * Style class to add when leave animation is completed.
+     * @group Props
+     */
+    leaveToClass: string | undefined;
+    /**
+     * Whether to trigger leave animation when outside of the element is clicked.
+     * @group Props
+     */
+    hideOnOutsideClick: boolean | undefined;
+    /**
+     * Adds or removes a class when no enter-leave animation is required.
+     * @group Props
+     */
+    toggleClass: string | undefined;
+    /**
+     * Whether to trigger leave animation when escape key pressed.
+     * @group Props
+     */
+    hideOnEscape: boolean | undefined;
+    eventListener: VoidListener;
+    documentClickListener: VoidListener;
+    documentKeydownListener: VoidListener;
+    target: HTMLElement | null | undefined;
+    enterListener: VoidListener;
+    leaveListener: VoidListener;
+    animating: boolean | undefined;
     clickListener(): void;
     toggle(): void;
     enter(): void;

package/table/public_api.d.ts

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