primeng 16.0.0-rc.1 → 16.0.0

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>;
+}

package/timeline/public_api.d.ts

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

package/timeline/timeline.d.ts

@@ -1,19 +1,46 @@
 import { ElementRef, AfterContentInit, QueryList, TemplateRef } from '@angular/core';
 import { BlockableUI } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
+/**
+ * Timeline visualizes a series of chained events.
+ * @group Components
+ */
 export declare class Timeline implements AfterContentInit, BlockableUI {
     private el;
-    value: any[];
-    style: any;
-    styleClass: string;
+    /**
+     * An array of events to display.
+     * @group Props
+     */
+    value: any[] | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Position of the timeline bar relative to the content. Valid values are "left", "right" for vertical layout and "top", "bottom" for horizontal layout.
+     * @group Props
+     */
     align: string;
-    layout: string;
-    templates: QueryList<any>;
-    contentTemplate: TemplateRef<any>;
-    oppositeTemplate: TemplateRef<any>;
-    markerTemplate: TemplateRef<any>;
+    /**
+     * Orientation of the timeline.
+     * @group Props
+     */
+    layout: 'vertical' | 'horizontal';
+    templates: Nullable<QueryList<any>>;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    oppositeTemplate: Nullable<TemplateRef<any>>;
+    markerTemplate: Nullable<TemplateRef<any>>;
     constructor(el: ElementRef);
     getBlockableElement(): HTMLElement;
     ngAfterContentInit(): void;

package/timeline/timeline.interface.d.ts

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

package/toast/public_api.d.ts

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

package/toast/toast.d.ts

@@ -1,8 +1,8 @@
-import { OnInit, AfterViewInit, AfterContentInit, OnDestroy, ElementRef, EventEmitter, QueryList, TemplateRef, NgZone, ChangeDetectorRef, Renderer2 } from '@angular/core';
-import { Message, PrimeNGConfig } from 'primeng/api';
-import { MessageService } from 'primeng/api';
-import { Subscription } from 'rxjs';
 import { AnimationEvent } from '@angular/animations';
+import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { Message, MessageService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { Subscription } from 'rxjs';
+import { ToastCloseEvent, ToastItemCloseEvent } from './toast.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/ripple";
@@ -14,15 +14,15 @@ import * as i7 from "primeng/icons/times";
 import * as i8 from "primeng/api";
 export declare class ToastItem implements AfterViewInit, OnDestroy {
     private zone;
-    message: Message;
-    index: number;
-    template: TemplateRef<any>;
-    showTransformOptions: string;
-    hideTransformOptions: string;
-    showTransitionOptions: string;
-    hideTransitionOptions: string;
-    onClose: EventEmitter<any>;
-    containerViewChild: ElementRef;
+    message: Message | null | undefined;
+    index: number | null | undefined;
+    template: TemplateRef<any> | undefined;
+    showTransformOptions: string | undefined;
+    hideTransformOptions: string | undefined;
+    showTransitionOptions: string | undefined;
+    hideTransitionOptions: string | undefined;
+    onClose: EventEmitter<ToastItemCloseEvent>;
+    containerViewChild: ElementRef | undefined;
     timeout: any;
     constructor(zone: NgZone);
     ngAfterViewInit(): void;
@@ -30,38 +30,103 @@ export declare class ToastItem implements AfterViewInit, OnDestroy {
     clearTimeout(): void;
     onMouseEnter(): void;
     onMouseLeave(): void;
-    onCloseIconClick(event: any): void;
+    onCloseIconClick(event: Event): void;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ToastItem, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ToastItem, "p-toastItem", never, { "message": { "alias": "message"; "required": false; }; "index": { "alias": "index"; "required": false; }; "template": { "alias": "template"; "required": false; }; "showTransformOptions": { "alias": "showTransformOptions"; "required": false; }; "hideTransformOptions": { "alias": "hideTransformOptions"; "required": false; }; "showTransitionOptions": { "alias": "showTransitionOptions"; "required": false; }; "hideTransitionOptions": { "alias": "hideTransitionOptions"; "required": false; }; }, { "onClose": "onClose"; }, never, never, false, never>;
 }
+/**
+ * Toast is used to display messages in an overlay.
+ * @group Components
+ */
 export declare class Toast implements OnInit, AfterContentInit, OnDestroy {
     private document;
     private renderer;
     messageService: MessageService;
     private cd;
     config: PrimeNGConfig;
-    key: string;
+    /**
+     * Key of the message in case message is targeted to a specific toast component.
+     * @group Props
+     */
+    key: string | undefined;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    style: any;
-    styleClass: string;
-    position: string;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Inline class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Position of the toast in viewport.
+     * @group Props
+     */
+    position: 'top-left' | 'top-center' | 'top-right' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'center';
+    /**
+     * It does not add the new message if there is already a toast displayed with the same content
+     * @group Props
+     */
     preventOpenDuplicates: boolean;
+    /**
+     * Displays only once a message with the same content.
+     * @group Props
+     */
     preventDuplicates: boolean;
+    /**
+     * Transform options of the show animation.
+     * @group Props
+     */
     showTransformOptions: string;
+    /**
+     * Transform options of the hide animation.
+     * @group Props
+     */
     hideTransformOptions: string;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    breakpoints: any;
-    onClose: EventEmitter<any>;
-    containerViewChild: ElementRef;
-    templates: QueryList<any>;
-    messageSubscription: Subscription;
-    clearSubscription: Subscription;
-    messages: Message[];
-    messagesArchieve: Message[];
-    template: TemplateRef<any>;
+    /**
+     * Object literal to define styles per screen size.
+     * @group Props
+     */
+    breakpoints: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Callback to invoke when a message is closed.
+     * @param {ToastCloseEvent} event - custom close event.
+     * @group Emits
+     */
+    onClose: EventEmitter<ToastCloseEvent>;
+    containerViewChild: ElementRef | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
+    messageSubscription: Subscription | undefined;
+    clearSubscription: Subscription | undefined;
+    messages: Message[] | null | undefined;
+    messagesArchieve: Message[] | undefined;
+    template: TemplateRef<any> | undefined;
     constructor(document: Document, renderer: Renderer2, messageService: MessageService, cd: ChangeDetectorRef, config: PrimeNGConfig);
     styleElement: any;
     id: string;
@@ -71,7 +136,7 @@ export declare class Toast implements OnInit, AfterContentInit, OnDestroy {
     canAdd(message: Message): boolean;
     containsMessage(collection: Message[], message: Message): boolean;
     ngAfterContentInit(): void;
-    onMessageClose(event: any): void;
+    onMessageClose(event: ToastItemCloseEvent): void;
     onAnimationStart(event: AnimationEvent): void;
     onAnimationEnd(event: AnimationEvent): void;
     createStyle(): void;

package/toast/toast.interface.d.ts

@@ -0,0 +1,40 @@
+import { TemplateRef } from '@angular/core';
+import { Message } from 'primeng/api';
+/**
+ * Defines valid templates in Toast.
+ * @group Templates
+ */
+export interface ToastTemplates {
+    /**
+     * Custom template of message.
+     */
+    message(context: {
+        /**
+         * Data of the message.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}
+/**
+ * Custom close event.
+ * @see {@link Toast.onClose}
+ * @group Events
+ */
+export interface ToastCloseEvent {
+    /**
+     * Message of the closed element.
+     */
+    message: Message;
+}
+/**
+ * Custom close event.
+ * @see {@link ToastItem.onClose}
+ */
+export interface ToastItemCloseEvent extends ToastCloseEvent {
+    /**
+     * Index of the closed element.
+     */
+    index: number;
+}

package/togglebutton/public_api.d.ts

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

package/togglebutton/togglebutton.d.ts

@@ -1,23 +1,77 @@
 import { ChangeDetectorRef, EventEmitter } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { ToggleButtonChangeEvent } from './togglebutton.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/ripple";
 export declare const TOGGLEBUTTON_VALUE_ACCESSOR: any;
+/**
+ * ToggleButton is used to select a boolean value using a button.
+ * @group Components
+ */
 export declare class ToggleButton implements ControlValueAccessor {
     cd: ChangeDetectorRef;
-    onLabel: string;
-    offLabel: string;
-    onIcon: string;
-    offIcon: string;
-    ariaLabelledBy: string;
-    disabled: boolean;
+    /**
+     * Label for the on state.
+     * @group Props
+     */
+    onLabel: string | undefined;
+    /**
+     * Label for the off state.
+     * @group Props
+     */
+    offLabel: string | undefined;
+    /**
+     * Icon for the on state.
+     * @group Props
+     */
+    onIcon: string | undefined;
+    /**
+     * Icon for the off state.
+     * @group Props
+     */
+    offIcon: 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;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
     style: any;
-    styleClass: string;
-    inputId: string;
-    tabindex: number;
-    iconPos: string;
-    onChange: EventEmitter<any>;
+    /**
+     * Style class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Position of the icon.
+     * @group Props
+     */
+    iconPos: 'left' | 'right';
+    /**
+     * Callback to invoke on value change.
+     * @param {ToggleButtonChangeEvent} event - Custom change event.
+     * @group Emits
+     */
+    onChange: EventEmitter<ToggleButtonChangeEvent>;
     checked: boolean;
     onModelChange: Function;
     onModelTouched: Function;

package/togglebutton/togglebutton.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Custom change event.
+ * @see {@link ToggleButton.onChange}
+ * @group Events
+ */
+export interface ToggleButtonChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Boolean value to represent checked state.
+     */
+    checked: boolean | undefined;
+}

package/toolbar/public_api.d.ts

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

package/toolbar/toolbar.d.ts

@@ -1,15 +1,29 @@
 import { AfterContentInit, ElementRef, QueryList, TemplateRef } from '@angular/core';
-import { BlockableUI } from 'primeng/api';
+import { BlockableUI, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Toolbar is a grouping component for buttons and other content.
+ * @group Components
+ */
 export declare class Toolbar implements AfterContentInit, BlockableUI {
     private el;
-    style: any;
-    styleClass: string;
-    templates: QueryList<any>;
-    startTemplate: TemplateRef<any>;
-    endTemplate: TemplateRef<any>;
-    centerTemplate: 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;
+    templates: QueryList<PrimeTemplate> | undefined;
+    startTemplate: TemplateRef<any> | undefined;
+    endTemplate: TemplateRef<any> | undefined;
+    centerTemplate: TemplateRef<any> | undefined;
     constructor(el: ElementRef);
     getBlockableElement(): HTMLElement;
     ngAfterContentInit(): void;

package/toolbar/toolbar.interface.d.ts

@@ -0,0 +1,19 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Toolbar.
+ * @group Templates
+ */
+export interface ToolbarTemplates {
+    /**
+     * Custom start content.
+     */
+    start(): TemplateRef<any>;
+    /**
+     * Custom end content.
+     */
+    end(): TemplateRef<any>;
+    /**
+     * Custom center content.
+     */
+    center(): TemplateRef<any>;
+}