primeng 16.0.0-rc.1 → 16.0.0

package/picklist/picklist.interface.d.ts

@@ -0,0 +1,242 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Callbacks to invoke on filter.
+ * @group Interface
+ */
+export interface PickListFilterOptions {
+    filter?: (value?: any) => void;
+    reset?: () => void;
+}
+/**
+ * Custom move to source event.
+ * @see {@link PickList.onMoveToSource}
+ * @group Events
+ */
+export interface PickListMoveToSourceEvent {
+    /**
+     * Moved items.
+     */
+    items: any[];
+}
+/**
+ * Custom move all to source event.
+ * @see {@link PickList.onMoveAllToSource}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+export interface PickListMoveAllToSourceEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move all to target event.
+ * @see {@link PickList.onMoveAllToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+export interface PickListMoveAllToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move to target event.
+ * @see {@link PickList.onMoveToTarget}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+export interface PickListMoveToTargetEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move source reorder event.
+ * @see {@link PickList.onSourceReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+export interface PickListSourceReorderEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom move target reorder event.
+ * @see {@link PickList.onTargetReorder}
+ * @extends {PickListMoveToSourceEvent}
+ * @group Events
+ */
+export interface PickListTargetReorderEvent extends PickListMoveToSourceEvent {
+}
+/**
+ * Custom source select event.
+ * @see {@link PickList.onSourceSelect}
+ * @group Events
+ */
+export interface PickListSourceSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected items.
+     */
+    items: any[];
+}
+/**
+ * Custom target select event.
+ * @see {@link PickList.onTargetSelect}
+ * @extends {PickListSourceSelectEvent}
+ * @group Events
+ */
+export interface PickListTargetSelectEvent extends PickListSourceSelectEvent {
+}
+/**
+ * Custom source filter event.
+ * @see {@link PickList.onSourceFilter}
+ * @group Events
+ */
+export interface PickListSourceFilterEvent {
+    /**
+     * Filter value.
+     */
+    query: string | null | undefined;
+    /**
+     * Filtered items.
+     */
+    value: any[] | null | undefined;
+}
+/**
+ * Custom target filter event.
+ * @see {@link PickList.onTargetFilter}
+ * @extends {PickListSourceFilterEvent}
+ * @group Events
+ */
+export interface PickListTargetFilterEvent extends PickListSourceFilterEvent {
+}
+/**
+ * Defines valid templates in PickList.
+ * @group Templates
+ */
+export interface PickListTemplates {
+    /**
+     * Custom item template.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+        /**
+         * Item index.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom source header template.
+     */
+    sourceHeader(): TemplateRef<any>;
+    /**
+     * Custom target header template.
+     */
+    targetHeader(): TemplateRef<any>;
+    /**
+     * Custom source filter template.
+     */
+    sourceFilter(context: {
+        /**
+         * Source filter options.
+         */
+        options: PickListFilterOptions;
+    }): TemplateRef<{
+        options: PickListFilterOptions;
+    }>;
+    /**
+     * Custom target filter template.
+     */
+    targetFilter(context: {
+        /**
+         * Target filter options.
+         */
+        options: PickListFilterOptions;
+    }): TemplateRef<{
+        options: PickListFilterOptions;
+    }>;
+    /**
+     * Custom source list empty message template.
+     */
+    emptymessagesource(): TemplateRef<any>;
+    /**
+     * Custom source list empty filter message template.
+     */
+    emptyfiltermessagesource(): TemplateRef<any>;
+    /**
+     * Custom target list empty message template.
+     */
+    emptymessagetarget(): TemplateRef<any>;
+    /**
+     * Custom target list empty filter message template.
+     */
+    emptyfiltermessagetarget(): TemplateRef<any>;
+    /**
+     * Custom move up icon template.
+     */
+    moveupicon(): TemplateRef<any>;
+    /**
+     * Custom move top icon template.
+     */
+    movetopicon(): TemplateRef<any>;
+    /**
+     * Custom move down icon template.
+     */
+    movedownicon(): TemplateRef<any>;
+    /**
+     * Custom move bottom icon template.
+     */
+    movebottomicon(): TemplateRef<any>;
+    /**
+     * Custom move to target icon template.
+     */
+    movetotargeticon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move all to target icon template.
+     */
+    movealltotargeticon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move to source icon template.
+     */
+    movetosourceicon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom move all to source icon template.
+     */
+    movealltosourceicon(context: {
+        /**
+         * Boolean value indicates if the view is changed according to breakpoints.
+         */
+        $implicit: boolean;
+    }): TemplateRef<{
+        $implicit: boolean;
+    }>;
+    /**
+     * Custom target filter icon template.
+     */
+    targetfiltericon(): TemplateRef<any>;
+    /**
+     * Custom source filter icon template.
+     */
+    sourcefiltericon(): TemplateRef<any>;
+}

package/picklist/public_api.d.ts

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

package/progressbar/progressbar.d.ts

@@ -1,15 +1,49 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * ProgressBar is a process status indicator.
+ * @group Components
+ */
 export declare class ProgressBar {
-    value: any;
+    /**
+     * Current value of the progress.
+     * @group Props
+     */
+    value: number | undefined;
+    /**
+     * Whether to display the progress bar value.
+     * @group Props
+     */
     showValue: boolean;
-    style: any;
-    styleClass: string;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Unit sign appended to the value.
+     * @group Props
+     */
     unit: string;
+    /**
+     * Defines the mode of the progress
+     * @group Props
+     */
     mode: string;
-    color: string;
+    /**
+     * Color for the background of the progress.
+     * @group Props
+     */
+    color: string | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressBar, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ProgressBar, "p-progressBar", never, { "value": { "alias": "value"; "required": false; }; "showValue": { "alias": "showValue"; "required": false; }; "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "unit": { "alias": "unit"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "color": { "alias": "color"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ProgressBar, "p-progressBar", never, { "value": { "alias": "value"; "required": false; }; "showValue": { "alias": "showValue"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "unit": { "alias": "unit"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; "color": { "alias": "color"; "required": false; }; }, {}, never, never, false, never>;
 }
 export declare class ProgressBarModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressBarModule, never>;

package/progressspinner/progressspinner.d.ts

@@ -1,13 +1,39 @@
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * ProgressSpinner is a process status indicator.
+ * @group Components
+ */
 export declare class ProgressSpinner {
-    style: any;
-    styleClass: string;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Width of the circle stroke.
+     * @group Props
+     */
     strokeWidth: string;
+    /**
+     * Color for the background of the circle.
+     * @group Props
+     */
     fill: string;
+    /**
+     * Duration of the rotate animation.
+     * @group Props
+     */
     animationDuration: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressSpinner, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ProgressSpinner, "p-progressSpinner", never, { "style": { "alias": "style"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "strokeWidth": { "alias": "strokeWidth"; "required": false; }; "fill": { "alias": "fill"; "required": false; }; "animationDuration": { "alias": "animationDuration"; "required": false; }; }, {}, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ProgressSpinner, "p-progressSpinner", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "strokeWidth": { "alias": "strokeWidth"; "required": false; }; "fill": { "alias": "fill"; "required": false; }; "animationDuration": { "alias": "animationDuration"; "required": false; }; }, {}, never, never, false, never>;
 }
 export declare class ProgressSpinnerModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<ProgressSpinnerModule, never>;

package/radiobutton/public_api.d.ts

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

package/radiobutton/radiobutton.d.ts

@@ -1,5 +1,7 @@
 import { ElementRef, EventEmitter, ChangeDetectorRef, Injector, OnInit, OnDestroy } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
+import { Nullable } from 'primeng/ts-helpers';
+import { RadioButtonClickEvent } from './radiobutton.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const RADIO_VALUE_ACCESSOR: any;
@@ -12,42 +14,115 @@ export declare class RadioControlRegistry {
     static ɵfac: i0.ɵɵFactoryDeclaration<RadioControlRegistry, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<RadioControlRegistry>;
 }
+/**
+ * RadioButton is an extension to standard radio button element with theming.
+ * @group Components
+ */
 export declare class RadioButton implements ControlValueAccessor, OnInit, OnDestroy {
     cd: ChangeDetectorRef;
     private injector;
     private registry;
+    /**
+     * Value of the radiobutton.
+     * @group Props
+     */
     value: any;
-    formControlName: string;
-    name: string;
-    disabled: boolean;
-    label: string;
-    tabindex: number;
-    inputId: string;
-    ariaLabelledBy: string;
-    ariaLabel: string;
-    style: any;
-    styleClass: string;
-    labelStyleClass: string;
-    onClick: EventEmitter<any>;
-    onFocus: EventEmitter<any>;
-    onBlur: EventEmitter<any>;
+    /**
+     * No description available.
+     * @group Props
+     */
+    formControlName: string | undefined;
+    /**
+     * Name of the radiobutton group.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Label of the radiobutton.
+     * @group Props
+     */
+    label: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: 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;
+    /**
+     * Used to define a string that labels the input element.
+     * @group Props
+     */
+    ariaLabel: 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;
+    /**
+     * Style class of the label.
+     * @group Props
+     */
+    labelStyleClass: string | undefined;
+    /**
+     * Callback to invoke on radio button click.
+     * @param {RadioButtonClickEvent} event - Custom click event.
+     * @group Emits
+     */
+    onClick: EventEmitter<RadioButtonClickEvent>;
+    /**
+     * Callback to invoke when the receives focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the loses focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
     inputViewChild: ElementRef;
     onModelChange: Function;
     onModelTouched: Function;
-    checked: boolean;
-    focused: boolean;
-    control: NgControl;
+    checked: Nullable<boolean>;
+    focused: Nullable<boolean>;
+    control: Nullable<NgControl>;
     constructor(cd: ChangeDetectorRef, injector: Injector, registry: RadioControlRegistry);
     ngOnInit(): void;
-    handleClick(event: any, radioButton: any, focus: any): void;
-    select(event: any): void;
+    handleClick(event: Event, radioButton: HTMLElement, focus: boolean): void;
+    select(event: Event): void;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
     setDisabledState(val: boolean): void;
-    onInputFocus(event: any): void;
-    onInputBlur(event: any): void;
-    onChange(event: any): void;
+    onInputFocus(event: Event): void;
+    onInputBlur(event: Event): void;
+    onChange(event: Event): void;
+    /**
+     * Applies focus to input field.
+     * @group Method
+     */
     focus(): void;
     ngOnDestroy(): void;
     private checkName;

package/radiobutton/radiobutton.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Custom click event.
+ * @see {@link RadioButton.onClick}
+ * @group Events
+ */
+export interface RadioButtonClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Browser event.
+     */
+    value: any;
+}

package/rating/public_api.d.ts

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

package/rating/rating.d.ts

@@ -1,5 +1,8 @@
 import { ChangeDetectorRef, EventEmitter, OnInit, QueryList, TemplateRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { PrimeTemplate } from 'primeng/api';
+import { RatingRateEvent } from './rating.interface';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/starfill";
@@ -7,43 +10,101 @@ import * as i3 from "primeng/icons/star";
 import * as i4 from "primeng/icons/ban";
 import * as i5 from "primeng/api";
 export declare const RATING_VALUE_ACCESSOR: any;
+/**
+ * RadioButton is an extension to standard radio button element with theming.
+ * @group Components
+ */
 export declare class Rating implements OnInit, ControlValueAccessor {
     private cd;
-    templates: QueryList<any>;
-    onIconTemplate: TemplateRef<any>;
-    offIconTemplate: TemplateRef<any>;
-    cancelIconTemplate: TemplateRef<any>;
-    isCustomCancelIcon: boolean;
-    index: number;
-    disabled: boolean;
-    readonly: boolean;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * When present, changing the value is not possible.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * Number of stars.
+     * @group Props
+     */
     stars: number;
+    /**
+     * When specified a cancel icon is displayed to allow removing the value.
+     * @group Props
+     */
     cancel: boolean;
-    iconOnClass: string;
-    iconOnStyle: any;
-    iconOffClass: string;
-    iconOffStyle: any;
-    iconCancelClass: string;
-    iconCancelStyle: any;
-    onRate: EventEmitter<any>;
-    onCancel: EventEmitter<any>;
+    /**
+     * Style class of the on icon.
+     * @group Props
+     */
+    iconOnClass: string | undefined;
+    /**
+     * Inline style of the on icon.
+     * @group Props
+     */
+    iconOnStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the off icon.
+     * @group Props
+     */
+    iconOffClass: string | undefined;
+    /**
+     * Inline style of the off icon.
+     * @group Props
+     */
+    iconOffStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the cancel icon.
+     * @group Props
+     */
+    iconCancelClass: string | undefined;
+    /**
+     * Inline style of the cancel icon.
+     * @group Props
+     */
+    iconCancelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Emitted on value change.
+     * @param {RatingRateEvent} value - Custom rate event.
+     * @group Emits
+     */
+    onRate: EventEmitter<RatingRateEvent>;
+    /**
+     * Emitted when the rating is cancelled.
+     * @param {Event} value - Browser event.
+     * @group Emits
+     */
+    onCancel: EventEmitter<Event>;
+    templates: QueryList<PrimeTemplate>;
+    onIconTemplate: Nullable<TemplateRef<any>>;
+    offIconTemplate: Nullable<TemplateRef<any>>;
+    cancelIconTemplate: Nullable<TemplateRef<any>>;
     constructor(cd: ChangeDetectorRef);
-    value: number;
+    value: Nullable<number>;
     onModelChange: Function;
     onModelTouched: Function;
-    starsArray: number[];
+    starsArray: Nullable<number[]>;
     ngOnInit(): void;
     ngAfterContentInit(): void;
-    getIconTemplate(i: number): TemplateRef<any>;
-    rate(event: any, i: number): void;
-    clear(event: any): void;
+    getIconTemplate(i: number): Nullable<TemplateRef<any>>;
+    rate(event: Event, i: number): void;
+    clear(event: Event): void;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
     setDisabledState(val: boolean): void;
     get isCustomIcon(): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<Rating, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Rating, "p-rating", never, { "isCustomCancelIcon": { "alias": "isCustomCancelIcon"; "required": false; }; "index": { "alias": "index"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "stars": { "alias": "stars"; "required": false; }; "cancel": { "alias": "cancel"; "required": false; }; "iconOnClass": { "alias": "iconOnClass"; "required": false; }; "iconOnStyle": { "alias": "iconOnStyle"; "required": false; }; "iconOffClass": { "alias": "iconOffClass"; "required": false; }; "iconOffStyle": { "alias": "iconOffStyle"; "required": false; }; "iconCancelClass": { "alias": "iconCancelClass"; "required": false; }; "iconCancelStyle": { "alias": "iconCancelStyle"; "required": false; }; }, { "onRate": "onRate"; "onCancel": "onCancel"; }, ["templates"], never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Rating, "p-rating", never, { "disabled": { "alias": "disabled"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "stars": { "alias": "stars"; "required": false; }; "cancel": { "alias": "cancel"; "required": false; }; "iconOnClass": { "alias": "iconOnClass"; "required": false; }; "iconOnStyle": { "alias": "iconOnStyle"; "required": false; }; "iconOffClass": { "alias": "iconOffClass"; "required": false; }; "iconOffStyle": { "alias": "iconOffStyle"; "required": false; }; "iconCancelClass": { "alias": "iconCancelClass"; "required": false; }; "iconCancelStyle": { "alias": "iconCancelStyle"; "required": false; }; }, { "onRate": "onRate"; "onCancel": "onCancel"; }, ["templates"], never, false, never>;
 }
 export declare class RatingModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<RatingModule, never>;

package/rating/rating.interface.d.ts

@@ -0,0 +1,34 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom change event.
+ * @see {@link Rating.onRate}
+ * @group Events
+ */
+export interface RatingRateEvent {
+    /**
+     * Browser event
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: number;
+}
+/**
+ * Defines valid templates in Rating.
+ * @group Templates
+ */
+export interface RatingTemplates {
+    /**
+     * Custom on icon template.
+     */
+    onicon(): TemplateRef<any>;
+    /**
+     * Custom off icon template.
+     */
+    officon(): TemplateRef<any>;
+    /**
+     * Custom cancel icon template.
+     */
+    cancelicon(): TemplateRef<any>;
+}