primeng 16.0.0-rc.1 → 16.0.0

package/autocomplete/public_api.d.ts

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

package/autofocus/autofocus.d.ts

@@ -1,10 +1,18 @@
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * AutoFocus manages focus on focusable element on load.
+ * @group Components
+ */
 export declare class AutoFocus {
     private host;
     constructor(host: ElementRef);
-    autofocus: boolean;
+    /**
+     * When present, it specifies that the component should automatically get focus on load.
+     * @group Props
+     */
+    autofocus: boolean | undefined;
     focused: boolean;
     ngAfterContentChecked(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<AutoFocus, never>;

package/avatar/avatar.d.ts

@@ -1,15 +1,54 @@
 import { EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Avatar represents people using icons, labels and images.
+ * @group Components
+ */
 export declare class Avatar {
-    label: string;
-    icon: string;
-    image: string;
-    size: string;
-    shape: string;
-    style: any;
-    styleClass: string;
-    onImageError: EventEmitter<any>;
+    /**
+     * Defines the text to display.
+     * @group Props
+     */
+    label: string | undefined;
+    /**
+     * Defines the icon to display.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Defines the image to display.
+     * @group Props
+     */
+    image: string | undefined;
+    /**
+     * Size of the element.
+     * @group Props
+     */
+    size: 'normal' | 'large' | 'xlarge' | undefined;
+    /**
+     * Shape of the element.
+     * @group Props
+     */
+    shape: 'square' | 'circle' | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * This event is triggered if an error occurs while loading an image file.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onImageError: EventEmitter<Event>;
     containerClass(): {
         'p-avatar p-component': boolean;
         'p-avatar-image': boolean;
@@ -17,7 +56,7 @@ export declare class Avatar {
         'p-avatar-lg': boolean;
         'p-avatar-xl': boolean;
     };
-    imageError(event: any): void;
+    imageError(event: Event): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<Avatar, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Avatar, "p-avatar", never, { "label": { "alias": "label"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "image": { "alias": "image"; "required": false; }; "size": { "alias": "size"; "required": false; }; "shape": { "alias": "shape"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; }, { "onImageError": "onImageError"; }, never, ["*"], false, never>;
 }

package/avatargroup/avatargroup.d.ts

@@ -1,8 +1,22 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * AvatarGroup is a helper component for Avatar.
+ * @group Components
+ */
 export declare class AvatarGroup {
-    styleClass: string;
-    style: any;
+    /**
+     * Style class of the component
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<AvatarGroup, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AvatarGroup, "p-avatarGroup", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; }, {}, never, ["*"], false, never>;
 }

package/badge/badge.d.ts

@@ -2,17 +2,42 @@ import { AfterViewInit, ElementRef, OnDestroy, Renderer2 } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
-type BadgeDirectiveIconPosition = 'left' | 'right' | 'top' | 'bottom';
-type BadgeSize = 'large' | 'xlarge';
+/**
+ * Badge Directive is directive usage of badge component.
+ * @group Components
+ */
 export declare class BadgeDirective implements AfterViewInit, OnDestroy {
     private document;
     el: ElementRef;
     private renderer;
-    iconPos: BadgeDirectiveIconPosition;
+    /**
+     * Icon position of the component.
+     * @group Props
+     */
+    iconPos: 'left' | 'right' | 'top' | 'bottom';
+    /**
+     * When specified, disables the component.
+     * @group Props
+     */
     get disabled(): boolean;
     set disabled(val: boolean);
-    get size(): BadgeSize;
-    set size(val: BadgeSize);
+    /**
+     * Size of the badge, valid options are "large" and "xlarge".
+     * @group Props
+     */
+    get size(): 'large' | 'xlarge';
+    set size(val: 'large' | 'xlarge');
+    /**
+     * Value to display inside the badge.
+     * @group Props
+     */
+    get value(): string;
+    set value(val: string);
+    /**
+     * Severity type of the badge.
+     * @group Props
+     */
+    severity: 'success' | 'info' | 'warning' | 'danger' | null | undefined;
     _value: string;
     initialized: boolean;
     private id;
@@ -20,20 +45,47 @@ export declare class BadgeDirective implements AfterViewInit, OnDestroy {
     private _size;
     constructor(document: Document, el: ElementRef, renderer: Renderer2);
     ngAfterViewInit(): any;
-    get value(): string;
-    set value(val: string);
-    severity: string;
     private setSizeClasses;
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<BadgeDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<BadgeDirective, "[pBadge]", never, { "iconPos": { "alias": "iconPos"; "required": false; }; "disabled": { "alias": "badgeDisabled"; "required": false; }; "size": { "alias": "size"; "required": false; }; "value": { "alias": "value"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Badge is a small status indicator for another element.
+ * @group Components
+ */
 export declare class Badge {
-    styleClass: string;
-    style: any;
-    size: BadgeSize;
-    severity: string;
-    value: string;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Size of the badge, valid options are "large" and "xlarge".
+     * @group Props
+     */
+    size: 'large' | 'xlarge' | undefined;
+    /**
+     * Severity type of the badge.
+     * @group Props
+     */
+    severity: 'success' | 'info' | 'warning' | 'danger' | null | undefined;
+    /**
+     * Value to display inside the badge.
+     * @group Props
+     */
+    value: string | null | undefined;
+    /**
+     * When specified, disables the component.
+     * @group Props
+     */
     badgeDisabled: boolean;
     containerClass(): {
         'p-badge p-component': boolean;
@@ -53,4 +105,3 @@ export declare class BadgeModule {
     static ɵmod: i0.ɵɵNgModuleDeclaration<BadgeModule, [typeof Badge, typeof BadgeDirective], [typeof i1.CommonModule], [typeof Badge, typeof BadgeDirective, typeof i2.SharedModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<BadgeModule>;
 }
-export {};

package/blockui/blockui.d.ts

@@ -1,25 +1,49 @@
-import { AfterViewInit, OnDestroy, ElementRef, ChangeDetectorRef, QueryList, TemplateRef, Renderer2 } from '@angular/core';
-import { PrimeNGConfig } from 'primeng/api';
+import { AfterViewInit, ChangeDetectorRef, ElementRef, OnDestroy, QueryList, Renderer2, TemplateRef } from '@angular/core';
+import { PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * BlockUI can either block other components or the whole page.
+ * @group Components
+ */
 export declare class BlockUI implements AfterViewInit, OnDestroy {
     private document;
     el: ElementRef;
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
     private renderer;
+    /**
+     * Name of the local ng-template variable referring to another component.
+     * @group Props
+     */
     target: any;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
     autoZIndex: boolean;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
     baseZIndex: number;
-    styleClass: string;
-    templates: QueryList<any>;
-    mask: ElementRef;
-    _blocked: boolean;
-    animationEndListener: VoidFunction | null;
-    contentTemplate: TemplateRef<any>;
-    constructor(document: Document, el: ElementRef, cd: ChangeDetectorRef, config: PrimeNGConfig, renderer: Renderer2);
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Current blocked state as a boolean.
+     * @group Props
+     */
     get blocked(): boolean;
     set blocked(val: boolean);
+    templates: QueryList<PrimeTemplate> | undefined;
+    mask: ElementRef | undefined;
+    _blocked: boolean;
+    animationEndListener: VoidFunction | null | undefined;
+    contentTemplate: TemplateRef<any> | undefined;
+    constructor(document: Document, el: ElementRef, cd: ChangeDetectorRef, config: PrimeNGConfig, renderer: Renderer2);
     ngAfterViewInit(): void;
     ngAfterContentInit(): void;
     block(): void;

package/blockui/blockui.interface.d.ts

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

package/blockui/public_api.d.ts

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

package/breadcrumb/breadcrumb.d.ts

@@ -1,5 +1,6 @@
-import { EventEmitter, QueryList, TemplateRef, AfterContentInit } from '@angular/core';
-import { MenuItem } from 'primeng/api';
+import { AfterContentInit, EventEmitter, QueryList, TemplateRef } from '@angular/core';
+import { MenuItem, PrimeTemplate } from 'primeng/api';
+import { BreadcrumbItemClickEvent } from './breadcrumb.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/router";
@@ -7,17 +8,48 @@ import * as i3 from "primeng/tooltip";
 import * as i4 from "primeng/icons/chevronright";
 import * as i5 from "primeng/icons/home";
 import * as i6 from "primeng/api";
+/**
+ * Breadcrumb provides contextual information about page hierarchy.
+ * @group Components
+ */
 export declare class Breadcrumb implements AfterContentInit {
-    model: MenuItem[];
-    style: any;
-    styleClass: string;
-    home: MenuItem;
-    homeAriaLabel: string;
-    onItemClick: EventEmitter<any>;
-    templates: QueryList<any>;
-    separatorTemplate: TemplateRef<any>;
-    itemClick(event: any, item: MenuItem): void;
-    onHomeClick(event: any): void;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    model: MenuItem[] | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * MenuItem configuration for the home icon.
+     * @group Props
+     */
+    home: MenuItem | undefined;
+    /**
+     * Defines a string that labels the home icon for accessibility.
+     * @group Props
+     */
+    homeAriaLabel: string | undefined;
+    /**
+     * Fired when an item is selected.
+     * @param {BreadcrumbItemClickEvent} event - custom click event.
+     * @group Emits
+     */
+    onItemClick: EventEmitter<BreadcrumbItemClickEvent>;
+    templates: QueryList<PrimeTemplate> | undefined;
+    separatorTemplate: TemplateRef<any> | undefined;
+    itemClick(event: MouseEvent, item: MenuItem): void;
+    onHomeClick(event: MouseEvent | any): void;
     ngAfterContentInit(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<Breadcrumb, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<Breadcrumb, "p-breadcrumb", never, { "model": { "alias": "model"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "home": { "alias": "home"; "required": false; }; "homeAriaLabel": { "alias": "homeAriaLabel"; "required": false; }; }, { "onItemClick": "onItemClick"; }, ["templates"], never, false, never>;

package/breadcrumb/breadcrumb.interface.d.ts

@@ -0,0 +1,27 @@
+import { TemplateRef } from '@angular/core';
+import { MenuItem } from 'primeng/api';
+/**
+ * Defines valid templates in Breadcumb.
+ * @group Templates
+ */
+export interface BreadcumbTemplates {
+    /**
+     * Custom template of seperator.
+     */
+    seperator(): TemplateRef<any>;
+}
+/**
+ * Custom select event.
+ * @see {@link Breadcrumb.onItemClick}
+ * @group Events
+ */
+export interface BreadcrumbItemClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected menu item .
+     */
+    item: MenuItem;
+}

package/breadcrumb/public_api.d.ts

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

package/button/button.d.ts

@@ -1,25 +1,50 @@
 import { AfterContentInit, AfterViewInit, ElementRef, EventEmitter, OnDestroy, 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/ripple";
 import * as i3 from "primeng/api";
 import * as i4 from "primeng/icons/spinner";
 type ButtonIconPosition = 'left' | 'right' | 'top' | 'bottom';
+/**
+ * Button directive is an extension to button component.
+ * @group Components
+ */
 export declare class ButtonDirective implements AfterViewInit, OnDestroy {
     el: ElementRef;
     private document;
+    /**
+     * Position of the icon.
+     * @group Props
+     */
     iconPos: ButtonIconPosition;
-    loadingIcon: string;
+    /**
+     * Uses to pass attributes to the loading icon's DOM element.
+     * @group Props
+     */
+    loadingIcon: string | undefined;
+    /**
+     * Text of the button.
+     * @group Props
+     */
     get label(): string;
     set label(val: string);
+    /**
+     * Name of the icon.
+     * @group Props
+     */
     get icon(): string;
     set icon(val: string);
+    /**
+     * Whether the button is in loading state.
+     * @group Props
+     */
     get loading(): boolean;
     set loading(val: boolean);
-    _label: string;
-    _icon: string;
+    _label: string | undefined;
+    _icon: string | undefined;
     _loading: boolean;
-    initialized: boolean;
+    initialized: boolean | undefined;
     private get htmlElement();
     private _internalClasses;
     spinnerIcon: string;
@@ -36,7 +61,95 @@ export declare class ButtonDirective implements AfterViewInit, OnDestroy {
     static ɵfac: i0.ɵɵFactoryDeclaration<ButtonDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<ButtonDirective, "[pButton]", never, { "iconPos": { "alias": "iconPos"; "required": false; }; "loadingIcon": { "alias": "loadingIcon"; "required": false; }; "label": { "alias": "label"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "loading": { "alias": "loading"; "required": false; }; }, {}, never, never, false, never>;
 }
+/**
+ * Button is an extension to standard button element with icons and theming.
+ * @group Components
+ */
 export declare class Button implements AfterContentInit {
+    /**
+     * Type of the button.
+     * @group Props
+     */
+    type: string;
+    /**
+     * Position of the icon.
+     * @group Props
+     */
+    iconPos: ButtonIconPosition;
+    /**
+     * Name of the icon.
+     * @group Props
+     */
+    icon: string | undefined;
+    /**
+     * Value of the badge.
+     * @group Props
+     */
+    badge: string | undefined;
+    /**
+     * Uses to pass attributes to the label's DOM element.
+     * @group Props
+     */
+    label: string | undefined;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Whether the button is in loading state.
+     * @group Props
+     */
+    loading: boolean;
+    /**
+     * Icon to display in loading state.
+     * @group Props
+     */
+    loadingIcon: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Style class of the badge.
+     * @group Props
+     */
+    badgeClass: string | undefined;
+    /**
+     * Used to define a string that autocomplete attribute the current element.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Callback to execute when button is clicked.
+     * @param {MouseEvent} event - Mouse event.
+     * @group Emits
+     */
+    onClick: EventEmitter<MouseEvent>;
+    /**
+     * Callback to execute when button is focused.
+     * @param {FocusEvent} event - Focus event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<FocusEvent>;
+    /**
+     * Callback to execute when button loses focus.
+     * @param {FocusEvent} event - Focus event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<FocusEvent>;
+    contentTemplate: TemplateRef<any> | undefined;
+    loadingIconTemplate: TemplateRef<any> | undefined;
+    iconTemplate: TemplateRef<any> | undefined;
+    templates: QueryList<PrimeTemplate> | undefined;
     iconClass(): {
         'p-button-icon': boolean;
         'p-button-icon-left': string;
@@ -52,25 +165,6 @@ export declare class Button implements AfterContentInit {
         'p-button-loading': boolean;
         'p-button-loading-label-only': string;
     };
-    type: string;
-    iconPos: ButtonIconPosition;
-    icon: string;
-    badge: string;
-    label: string;
-    disabled: boolean;
-    loading: boolean;
-    loadingIcon: string;
-    style: any;
-    styleClass: string;
-    badgeClass: string;
-    ariaLabel: string;
-    contentTemplate: TemplateRef<any>;
-    loadingIconTemplate: TemplateRef<any>;
-    iconTemplate: TemplateRef<any>;
-    templates: QueryList<any>;
-    onClick: EventEmitter<any>;
-    onFocus: EventEmitter<any>;
-    onBlur: EventEmitter<any>;
     ngAfterContentInit(): void;
     badgeStyleClass(): {
         'p-badge p-component': boolean;

package/button/button.interface.d.ts

@@ -0,0 +1,19 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Defines valid templates in Button.
+ * @group Templates
+ */
+export interface ButtonTemplates {
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of icon.
+     */
+    icon(): TemplateRef<any>;
+    /**
+     * Custom template of loadingicon.
+     */
+    loadingicon(): TemplateRef<any>;
+}

package/button/public_api.d.ts

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