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

package/tabview/tabview.d.ts

@@ -1,5 +1,6 @@
-import { ElementRef, OnDestroy, EventEmitter, AfterContentInit, QueryList, TemplateRef, EmbeddedViewRef, ViewContainerRef, ChangeDetectorRef, AfterViewChecked } from '@angular/core';
-import { BlockableUI } from 'primeng/api';
+import { AfterContentInit, AfterViewChecked, ChangeDetectorRef, ElementRef, EmbeddedViewRef, EventEmitter, OnDestroy, QueryList, TemplateRef, ViewContainerRef } from '@angular/core';
+import { BlockableUI, PrimeTemplate } from 'primeng/api';
+import { TabViewChangeEvent, TabViewCloseEvent } from './tabview.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -11,42 +12,100 @@ import * as i7 from "primeng/icons/chevronright";
 export declare class TabPanel implements AfterContentInit, OnDestroy {
     viewContainer: ViewContainerRef;
     cd: ChangeDetectorRef;
-    closable: boolean;
-    headerStyle: any;
-    headerStyleClass: string;
-    cache: boolean;
-    tooltip: any;
-    tooltipPosition: string;
-    tooltipPositionStyle: string;
-    tooltipStyleClass: string;
-    templates: QueryList<any>;
-    closed: boolean;
-    view: EmbeddedViewRef<any>;
-    _selected: boolean;
-    _disabled: boolean;
-    _header: string;
-    _leftIcon: string;
-    _rightIcon: string;
-    loaded: boolean;
-    id: string;
-    contentTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    leftIconTemplate: TemplateRef<any>;
-    rightIconTemplate: TemplateRef<any>;
-    closeIconTemplate: TemplateRef<any>;
-    tabView: TabView;
-    constructor(tabView: any, viewContainer: ViewContainerRef, cd: ChangeDetectorRef);
-    ngAfterContentInit(): void;
+    /**
+     * Defines if tab can be removed.
+     * @group Props
+     */
+    closable: boolean | undefined;
+    /**
+     * Inline style of the tab header.
+     * @group Props
+     */
+    headerStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the tab header.
+     * @group Props
+     */
+    headerStyleClass: string | undefined;
+    /**
+     * Whether a lazy loaded panel should avoid getting loaded again on reselection.
+     * @group Props
+     */
+    cache: boolean | undefined;
+    /**
+     * Advisory information to display in a tooltip on hover.
+     * @group Props
+     */
+    tooltip: string | undefined;
+    /**
+     * Position of the tooltip.
+     * @group Props
+     */
+    tooltipPosition: 'top' | 'bottom' | 'left' | 'right' | undefined;
+    /**
+     * Type of CSS position.
+     * @group Props
+     */
+    tooltipPositionStyle: string | undefined;
+    /**
+     * Style class of the tooltip.
+     * @group Props
+     */
+    tooltipStyleClass: string | undefined;
+    /**
+     * Defines if tab is active.
+     * @defaultValue false
+     * @group Props
+     */
     get selected(): boolean;
     set selected(val: boolean);
+    /**
+     * When true, tab cannot be activated.
+     * @defaultValue false
+     * @group Props
+     */
     get disabled(): boolean;
     set disabled(disabled: boolean);
+    /**
+     * Title of the tabPanel.
+     * @group Props
+     */
     get header(): string;
     set header(header: string);
+    /**
+     * Left icon of the tabPanel.
+     * @deprecated since v15.4.2, use `lefticon` template instead.
+     * @group Props
+     */
     get leftIcon(): string;
     set leftIcon(leftIcon: string);
-    get rightIcon(): string;
-    set rightIcon(rightIcon: string);
+    /**
+     * Left icon of the tabPanel.
+     * @deprecated since v15.4.2, use `righticon` template instead.
+     * @group Props
+     */
+    get rightIcon(): string | undefined;
+    set rightIcon(rightIcon: string | undefined);
+    templates: QueryList<PrimeTemplate> | undefined;
+    closed: boolean;
+    view: EmbeddedViewRef<any> | null;
+    _selected: boolean | undefined;
+    _disabled: boolean | undefined;
+    _header: string;
+    _leftIcon: string;
+    _rightIcon: string | undefined;
+    loaded: boolean;
+    id: string;
+    contentTemplate: TemplateRef<any> | undefined;
+    headerTemplate: TemplateRef<any> | undefined;
+    leftIconTemplate: TemplateRef<any> | undefined;
+    rightIconTemplate: TemplateRef<any> | undefined;
+    closeIconTemplate: TemplateRef<any> | undefined;
+    tabView: TabView;
+    constructor(tabView: TabView, viewContainer: ViewContainerRef, cd: ChangeDetectorRef);
+    ngAfterContentInit(): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabPanel, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<TabPanel, "p-tabPanel", never, { "closable": { "alias": "closable"; "required": false; }; "headerStyle": { "alias": "headerStyle"; "required": false; }; "headerStyleClass": { "alias": "headerStyleClass"; "required": false; }; "cache": { "alias": "cache"; "required": false; }; "tooltip": { "alias": "tooltip"; "required": false; }; "tooltipPosition": { "alias": "tooltipPosition"; "required": false; }; "tooltipPositionStyle": { "alias": "tooltipPositionStyle"; "required": false; }; "tooltipStyleClass": { "alias": "tooltipStyleClass"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "header": { "alias": "header"; "required": false; }; "leftIcon": { "alias": "leftIcon"; "required": false; }; "rightIcon": { "alias": "rightIcon"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
@@ -55,31 +114,71 @@ export declare class TabView implements AfterContentInit, AfterViewChecked, OnDe
     private platformId;
     el: ElementRef;
     cd: ChangeDetectorRef;
-    orientation: string;
-    style: any;
-    styleClass: string;
-    controlClose: boolean;
-    scrollable: boolean;
-    content: ElementRef;
-    navbar: ElementRef;
-    prevBtn: ElementRef;
-    nextBtn: ElementRef;
-    inkbar: ElementRef;
-    tabPanels: QueryList<TabPanel>;
-    onChange: EventEmitter<any>;
-    onClose: 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;
+    /**
+     * Whether tab close is controlled at onClose event or not.
+     * @defaultValue false
+     * @group Props
+     */
+    controlClose: boolean | undefined;
+    /**
+     * When enabled displays buttons at each side of the tab headers to scroll the tab list.
+     * @defaultValue false
+     * @group Props
+     */
+    scrollable: boolean | undefined;
+    /**
+     * Index of the active tab to change selected tab programmatically.
+     * @group Props
+     */
+    get activeIndex(): number;
+    set activeIndex(val: number);
+    /**
+     * Callback to invoke on tab change.
+     * @param {TabViewChangeEvent} event - Custom tab change event
+     * @group Emits
+     */
+    onChange: EventEmitter<TabViewChangeEvent>;
+    /**
+     * Callback to invoke on tab close.
+     * @param {TabViewCloseEvent} event - Custom tab close event
+     * @group Emits
+     */
+    onClose: EventEmitter<TabViewCloseEvent>;
+    /**
+     * Callback to invoke on the active tab change.
+     * @param {number} index - New active index
+     * @group Emits
+     */
     activeIndexChange: EventEmitter<number>;
-    templates: QueryList<any>;
-    initialized: boolean;
+    content?: ElementRef<HTMLDivElement>;
+    navbar?: ElementRef<HTMLUListElement>;
+    prevBtn?: ElementRef;
+    nextBtn?: ElementRef;
+    inkbar?: ElementRef;
+    tabPanels: QueryList<TabPanel> | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    initialized: boolean | undefined;
     tabs: TabPanel[];
     _activeIndex: number;
     preventActiveIndexPropagation: boolean;
-    tabChanged: boolean;
+    tabChanged: boolean | undefined;
     backwardIsDisabled: boolean;
     forwardIsDisabled: boolean;
     private tabChangesSubscription;
-    nextIconTemplate: TemplateRef<any>;
-    previousIconTemplate: TemplateRef<any>;
+    nextIconTemplate: TemplateRef<any> | undefined;
+    previousIconTemplate: TemplateRef<any> | undefined;
     constructor(platformId: any, el: ElementRef, cd: ChangeDetectorRef);
     ngAfterContentInit(): void;
     ngAfterViewChecked(): void;
@@ -88,20 +187,18 @@ export declare class TabView implements AfterContentInit, AfterViewChecked, OnDe
     open(event: Event, tab: TabPanel): void;
     close(event: Event, tab: TabPanel): void;
     closeTab(tab: TabPanel): void;
-    findSelectedTab(): TabPanel;
+    findSelectedTab(): TabPanel | null;
     findTabIndex(tab: TabPanel): number;
     getBlockableElement(): HTMLElement;
-    get activeIndex(): number;
-    set activeIndex(val: number);
     updateInkBar(): void;
-    updateScrollBar(index: any): void;
+    updateScrollBar(index: number): void;
     updateButtonState(): void;
-    onScroll(event: any): void;
+    onScroll(event: Event): void;
     getVisibleButtonWidths(): any;
     navBackward(): void;
     navForward(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<TabView, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TabView, "p-tabView", never, { "orientation": { "alias": "orientation"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "controlClose": { "alias": "controlClose"; "required": false; }; "scrollable": { "alias": "scrollable"; "required": false; }; "activeIndex": { "alias": "activeIndex"; "required": false; }; }, { "onChange": "onChange"; "onClose": "onClose"; "activeIndexChange": "activeIndexChange"; }, ["tabPanels", "templates"], ["*"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TabView, "p-tabView", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "controlClose": { "alias": "controlClose"; "required": false; }; "scrollable": { "alias": "scrollable"; "required": false; }; "activeIndex": { "alias": "activeIndex"; "required": false; }; }, { "onChange": "onChange"; "onClose": "onClose"; "activeIndexChange": "activeIndexChange"; }, ["tabPanels", "templates"], ["*"], false, never>;
 }
 export declare class TabViewModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TabViewModule, never>;

package/tabview/tabview.interface.d.ts

@@ -0,0 +1,75 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom tab change event.
+ * @see {@link TabView.onChange}
+ */
+export interface TabViewChangeEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Index of the selected tab
+     */
+    index: number;
+}
+/**
+ * Custom tab close event.
+ * @see {@link TabView.onClose}
+ */
+export interface TabViewCloseEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Index of the closed tab
+     */
+    index: number;
+    /**
+     * Used to close tab.
+     */
+    close?(): void;
+}
+/**
+ * Defines valid templates in TabView.
+ * @group Templates
+ */
+export interface TabViewTemplates {
+    /**
+     * Previous button icon template for the scrollable component.
+     */
+    previousicon: TemplateRef<any> | null;
+    /**
+     * Next button icon template for the scrollable component.
+     */
+    nexticon: TemplateRef<any> | null;
+}
+/**
+ * Defines valid templates in TabPanel.
+ * @group Templates
+ */
+export interface TabPanelTemplates {
+    /**
+     * Custom header template.
+     *
+     */
+    header: TemplateRef<any> | null;
+    /**
+     * Custom content template(Default).
+     * @default
+     */
+    content: TemplateRef<any> | null;
+    /**
+     * Custom right icon template.
+     */
+    righticon: TemplateRef<any> | null;
+    /**
+     * Custom left icon template.
+     */
+    lefticon: TemplateRef<any> | null;
+    /**
+     * Custom close icon template.
+     */
+    closeicon: TemplateRef<any> | null;
+}

package/tag/public_api.d.ts

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

package/tag/tag.d.ts

@@ -1,16 +1,44 @@
-import { TemplateRef, QueryList } from '@angular/core';
+import { QueryList, TemplateRef } from '@angular/core';
+import { PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
 export declare class Tag {
-    styleClass: string;
-    style: any;
-    severity: string;
-    value: string;
-    icon: string;
-    rounded: boolean;
-    templates: QueryList<any>;
-    iconTemplate: TemplateRef<any>;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Severity type of the tag.
+     * @group Props
+     */
+    severity: 'success' | 'info' | 'warning' | 'danger' | string | undefined;
+    /**
+     * Value to display inside the tag.
+     * @group Props
+     */
+    value: string | undefined;
+    /**
+     * Icon of the tag to display next to the value.
+     * @deprecated since 15.4.2. Use 'icon' template.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Whether the corners of the tag are rounded.
+     * @group Props
+     */
+    rounded: boolean | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    iconTemplate: TemplateRef<any> | undefined;
     ngAfterContentInit(): void;
     containerClass(): {
         'p-tag p-component': boolean;
@@ -21,7 +49,7 @@ export declare class Tag {
         'p-tag-rounded': boolean;
     };
     static ɵfac: i0.ɵɵFactoryDeclaration<Tag, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Tag, "p-tag", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; "value": { "alias": "value"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "rounded": { "alias": "rounded"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Tag, "p-tag", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; "value": { "alias": "value"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "rounded": { "alias": "rounded"; "required": false; }; }, {}, ["templates"], ["*"], false, never>;
 }
 export declare class TagModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TagModule, never>;

package/tag/tag.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Tag.
+ * @group Templates
+ */
+export interface TagTemplates {
+    /**
+     * Custom icon template
+     */
+    icon: TemplateRef<any> | undefined;
+}

package/terminal/terminal.d.ts

@@ -8,10 +8,28 @@ export declare class Terminal implements AfterViewInit, AfterViewChecked, OnDest
     el: ElementRef;
     terminalService: TerminalService;
     cd: ChangeDetectorRef;
-    welcomeMessage: string;
-    prompt: string;
-    style: any;
-    styleClass: string;
+    /**
+     * Initial text to display on terminal.
+     * @group Props
+     */
+    welcomeMessage: string | undefined;
+    /**
+     * Prompt text for each command.
+     * @group Props
+     */
+    prompt: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
     commands: any[];
     command: string;
     container: Element;

package/tieredmenu/public_api.d.ts

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

package/tieredmenu/tieredmenu.d.ts

@@ -1,7 +1,8 @@
-import { ElementRef, Renderer2, OnDestroy, ChangeDetectorRef, EventEmitter, QueryList, AfterContentInit, TemplateRef } from '@angular/core';
-import { ConnectedOverlayScrollHandler } from 'primeng/dom';
-import { MenuItem, OverlayService, PrimeNGConfig } from 'primeng/api';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { MenuItem, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { ConnectedOverlayScrollHandler } from 'primeng/dom';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -15,31 +16,31 @@ export declare class TieredMenuSub implements OnDestroy {
     renderer: Renderer2;
     private cd;
     tieredMenu: TieredMenu;
-    item: MenuItem;
-    root: boolean;
-    autoDisplay: boolean;
+    item: MenuItem | undefined;
+    root: boolean | undefined;
+    autoDisplay: boolean | undefined;
     autoZIndex: boolean;
     baseZIndex: number;
-    mobileActive: boolean;
-    popup: boolean;
+    mobileActive: boolean | undefined;
+    popup: boolean | undefined;
     get parentActive(): boolean;
     set parentActive(value: boolean);
-    sublistViewChild: ElementRef;
+    sublistViewChild: ElementRef | undefined;
     leafClick: EventEmitter<any>;
     keydownItem: EventEmitter<any>;
-    _parentActive: boolean;
-    documentClickListener: VoidFunction | null;
+    _parentActive: boolean | undefined;
+    documentClickListener: VoidListener;
     menuHoverActive: boolean;
     activeItem: any;
     constructor(document: Document, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, tieredMenu: TieredMenu);
-    onItemClick(event: any, item: any): void;
-    onItemMouseEnter(event: any, item: any): void;
+    onItemClick(event: Event, item: MenuItem): void;
+    onItemMouseEnter(event: MouseEvent, item: MenuItem): void;
     onLeafClick(): void;
-    onItemKeyDown(event: any, item: MenuItem): void;
+    onItemKeyDown(event: KeyboardEvent, item: MenuItem): void;
     positionSubmenu(): void;
-    findNextItem(item: any): any;
-    findPrevItem(item: any): any;
-    onChildItemKeyDown(event: any): void;
+    findNextItem(item: Element): any;
+    findPrevItem(item: Element): any;
+    onChildItemKeyDown(event: KeyboardEvent): void;
     bindDocumentClickListener(): void;
     unbindDocumentClickListener(): void;
     ngOnDestroy(): void;
@@ -53,41 +54,105 @@ export declare class TieredMenu implements AfterContentInit, OnDestroy {
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
     overlayService: OverlayService;
-    model: MenuItem[];
-    popup: boolean;
-    style: any;
-    styleClass: string;
-    appendTo: any;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Defines if menu would displayed as a popup.
+     * @group Props
+     */
+    popup: boolean | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element.
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    autoDisplay: boolean;
+    /**
+     * Whether to show a root submenu on mouse over.
+     * @group Props
+     */
+    autoDisplay: boolean | undefined;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
+    /**
+     * Callback to invoke when overlay menu is shown.
+     * @group Emits
+     */
     onShow: EventEmitter<any>;
+    /**
+     * Callback to invoke when overlay menu is hidden.
+     * @group Emits
+     */
     onHide: EventEmitter<any>;
-    templates: QueryList<any>;
-    submenuIconTemplate: TemplateRef<any>;
-    parentActive: boolean;
-    container: HTMLDivElement;
-    documentClickListener: VoidFunction | null;
-    documentResizeListener: VoidFunction | null;
-    preventDocumentDefault: boolean;
-    scrollHandler: ConnectedOverlayScrollHandler | null;
+    templates: QueryList<PrimeTemplate> | undefined;
+    submenuIconTemplate: Nullable<TemplateRef<any>>;
+    parentActive: boolean | undefined;
+    container: HTMLDivElement | undefined;
+    documentClickListener: VoidListener;
+    documentResizeListener: VoidListener;
+    preventDocumentDefault: boolean | undefined;
+    scrollHandler: Nullable<ConnectedOverlayScrollHandler>;
     target: any;
-    visible: boolean;
-    relativeAlign: boolean;
+    visible: boolean | undefined;
+    relativeAlign: boolean | undefined;
     private window;
     constructor(document: Document, el: ElementRef, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, overlayService: OverlayService);
     ngAfterContentInit(): void;
+    /**
+     * Toggles the visibility of the popup menu.
+     * @param event
+     * @group Methods
+     */
     toggle(event: any): void;
+    /**
+     * Displays the popup menu.
+     * @param event
+     * @group Methods
+     */
     show(event: any): void;
-    onOverlayClick(event: any): void;
+    onOverlayClick(event: MouseEvent): void;
     onOverlayAnimationStart(event: AnimationEvent): void;
     alignOverlay(): void;
     onOverlayAnimationEnd(event: AnimationEvent): void;
     appendOverlay(): void;
     restoreOverlayAppend(): void;
     moveOnTop(): void;
+    /**
+     * Hides the popup menu.
+     * @group Methods
+     */
     hide(): void;
     onWindowResize(): void;
     onLeafClick(): void;

package/tieredmenu/tieredmenu.interface.d.ts

@@ -0,0 +1,11 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in TieredMenu.
+ * @group Templates
+ */
+export interface TieredMenuTemplates {
+    /**
+     * Custom template of submenuicon.
+     */
+    submenuicon: TemplateRef<any> | null;
+}

package/timeline/public_api.d.ts

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