primeng 16.0.0-rc.1 → 16.0.0

package/cascadeselect/cascadeselect.d.ts

@@ -1,7 +1,9 @@
 import { AnimationEvent } from '@angular/animations';
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, OnInit, QueryList, TemplateRef } from '@angular/core';
-import { OverlayOptions, OverlayService, PrimeNGConfig } from 'primeng/api';
+import { OverlayOptions, OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { Overlay } from 'primeng/overlay';
+import { CascadeSelectBeforeHideEvent, CascadeSelectBeforeShowEvent, CascadeSelectHideEvent, CascadeSelectShowEvent } from './cascadeselect.interface';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/overlay";
@@ -13,17 +15,17 @@ import * as i7 from "primeng/icons/times";
 export declare const CASCADESELECT_VALUE_ACCESSOR: any;
 export declare class CascadeSelectSub implements OnInit {
     private el;
-    selectionPath: any[];
-    options: any[];
-    optionGroupChildren: any[];
-    optionTemplate: TemplateRef<any>;
-    groupIconTemplate: TemplateRef<any>;
+    selectionPath: string[] | string | undefined | null;
+    options: string[] | string | undefined | null;
+    optionGroupChildren: string[] | string | undefined | null;
+    optionTemplate: Nullable<TemplateRef<any>>;
+    groupIconTemplate: Nullable<TemplateRef<any>>;
     level: number;
-    optionLabel: string;
-    optionValue: string;
-    optionGroupLabel: string;
-    dirty: boolean;
-    root: boolean;
+    optionLabel: string | undefined;
+    optionValue: string | undefined;
+    optionGroupLabel: string | undefined;
+    dirty: boolean | undefined;
+    root: boolean | undefined;
     onSelect: EventEmitter<any>;
     onGroupSelect: EventEmitter<any>;
     get parentActive(): boolean;
@@ -31,101 +33,241 @@ export declare class CascadeSelectSub implements OnInit {
     activeOption: any;
     _parentActive: boolean;
     cascadeSelect: CascadeSelect;
-    constructor(cascadeSelect: any, el: ElementRef);
+    constructor(cascadeSelect: CascadeSelect, el: ElementRef);
     ngOnInit(): void;
-    onOptionClick(event: any, option: any): void;
-    onOptionSelect(event: any): void;
-    onOptionGroupSelect(event: any): void;
-    getOptionLabel(option: any): any;
-    getOptionValue(option: any): any;
-    getOptionGroupLabel(optionGroup: any): any;
-    getOptionGroupChildren(optionGroup: any): any;
-    isOptionGroup(option: any): any;
-    getOptionLabelToRender(option: any): any;
-    getItemClass(option: any): {
+    onOptionClick(event: Event, option: string | string[]): void;
+    onOptionSelect(event: Event): void;
+    onOptionGroupSelect(event: Event): void;
+    getOptionLabel(option: string | string[]): any;
+    getOptionValue(option: string | string[]): any;
+    getOptionGroupLabel(optionGroup: string | string[]): any;
+    getOptionGroupChildren(optionGroup: string | string[]): any;
+    isOptionGroup(option: string | string[]): any;
+    getOptionLabelToRender(option: string | string[]): any;
+    getItemClass(option: string | string[]): {
         'p-cascadeselect-item': boolean;
         'p-cascadeselect-item-group': any;
         'p-cascadeselect-item-active p-highlight': boolean;
     };
-    isOptionActive(option: any): boolean;
-    onKeyDown(event: any, option: any, index: any): void;
+    isOptionActive(option: string | string[]): boolean;
+    onKeyDown(event: any, option: string | string[], index: number): void;
     position(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CascadeSelectSub, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CascadeSelectSub, "p-cascadeSelectSub", never, { "selectionPath": { "alias": "selectionPath"; "required": false; }; "options": { "alias": "options"; "required": false; }; "optionGroupChildren": { "alias": "optionGroupChildren"; "required": false; }; "optionTemplate": { "alias": "optionTemplate"; "required": false; }; "groupIconTemplate": { "alias": "groupIconTemplate"; "required": false; }; "level": { "alias": "level"; "required": false; }; "optionLabel": { "alias": "optionLabel"; "required": false; }; "optionValue": { "alias": "optionValue"; "required": false; }; "optionGroupLabel": { "alias": "optionGroupLabel"; "required": false; }; "dirty": { "alias": "dirty"; "required": false; }; "root": { "alias": "root"; "required": false; }; "parentActive": { "alias": "parentActive"; "required": false; }; }, { "onSelect": "onSelect"; "onGroupSelect": "onGroupSelect"; }, never, never, false, never>;
 }
+/**
+ * CascadeSelect is a form component to select a value from a nested structure of options.
+ * @group Components
+ */
 export declare class CascadeSelect implements OnInit, AfterContentInit {
     private el;
     private cd;
     private config;
     overlayService: OverlayService;
-    styleClass: string;
-    style: any;
-    options: any[];
-    optionLabel: string;
-    optionValue: string;
-    optionGroupLabel: string;
-    optionGroupChildren: any[];
-    placeholder: string;
-    value: string;
-    dataKey: string;
-    inputId: string;
-    tabindex: string;
-    ariaLabelledBy: string;
-    inputLabel: string;
-    ariaLabel: string;
-    appendTo: any;
-    disabled: boolean;
-    rounded: boolean;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * An array of selectitems to display as the available options.
+     * @group Props
+     */
+    options: string[] | string | undefined;
+    /**
+     * Property name or getter function to use as the label of an option.
+     * @group Props
+     */
+    optionLabel: string | undefined;
+    /**
+     * Property name or getter function to use as the value of an option, defaults to the option itself when not defined.
+     * @group Props
+     */
+    optionValue: string | undefined;
+    /**
+     * Property name or getter function to use as the label of an option group.
+     * @group Props
+     */
+    optionGroupLabel: string | string[] | undefined;
+    /**
+     * Property name or getter function to retrieve the items of a group.
+     * @group Props
+     */
+    optionGroupChildren: string | string[] | undefined;
+    /**
+     * Default text to display when no option is selected.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * No description available.
+     * @group Props
+     */
+    value: string | undefined | null;
+    /**
+     * A property to uniquely identify an option.
+     * @group Props
+     */
+    dataKey: string | undefined;
+    /**
+     * Identifier of the underlying input element.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: 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;
+    /**
+     * Label of the input for accessibility.
+     * @group Props
+     */
+    inputLabel: string | undefined;
+    /**
+     * Defines a string that labels the input for accessibility.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Id of the element or "body" for document where the overlay should be appended to.
+     * @group Props
+     */
+    appendTo: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * No description available.
+     * @group Props
+     */
+    rounded: boolean | undefined;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     showClear: boolean;
-    panelStyleClass: string;
-    panelStyle: object;
-    overlayOptions: OverlayOptions;
-    focusInputEl: ElementRef;
-    containerEl: ElementRef;
-    panelEl: ElementRef;
-    overlayViewChild: Overlay;
-    onChange: EventEmitter<any>;
-    onGroupChange: EventEmitter<any>;
-    onShow: EventEmitter<any>;
-    onHide: EventEmitter<any>;
+    /**
+     * Style class of the overlay panel.
+     * @group Props
+     */
+    panelStyleClass: string | undefined;
+    /**
+     * Inline style of the overlay panel.
+     * @group Props
+     */
+    panelStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Whether to use overlay API feature. The properties of overlay API can be used like an object in it.
+     * @group Props
+     */
+    overlayOptions: OverlayOptions | undefined;
+    /**
+     * Callback to invoke on value change.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onChange: EventEmitter<Event>;
+    /**
+     * Callback to invoke when a group changes.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onGroupChange: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the overlay is shown.
+     * @param {CascadeSelectShowEvent} event - Custom overlay show event.
+     * @group Emits
+     */
+    onShow: EventEmitter<CascadeSelectShowEvent>;
+    /**
+     * Callback to invoke when the overlay is hidden.
+     * @param {CascadeSelectHideEvent} event - Custom overlay hide event.
+     * @group Emits
+     */
+    onHide: EventEmitter<CascadeSelectHideEvent>;
+    /**
+     * Callback to invoke when the clear token is clicked.
+     * @group Emits
+     */
     onClear: EventEmitter<any>;
-    onBeforeShow: EventEmitter<any>;
-    onBeforeHide: EventEmitter<any>;
-    templates: QueryList<any>;
-    _showTransitionOptions: string;
+    /**
+     * Callback to invoke before overlay is shown.
+     * @param {CascadeSelectBeforeShowEvent} event - Custom overlay show event.
+     * @group Emits
+     */
+    onBeforeShow: EventEmitter<CascadeSelectBeforeShowEvent>;
+    /**
+     * Callback to invoke before overlay is hidden.
+     * @param {CascadeSelectBeforeHideEvent} event - Custom overlay hide event.
+     * @group Emits
+     */
+    onBeforeHide: EventEmitter<CascadeSelectBeforeHideEvent>;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
+     */
     get showTransitionOptions(): string;
     set showTransitionOptions(val: string);
-    _hideTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     * @deprecated deprecated since v14.2.0, use overlayOptions property instead.
+     */
     get hideTransitionOptions(): string;
     set hideTransitionOptions(val: string);
+    focusInputEl: Nullable<ElementRef>;
+    containerEl: Nullable<ElementRef>;
+    panelEl: Nullable<ElementRef>;
+    overlayViewChild: Nullable<Overlay>;
+    templates: QueryList<PrimeTemplate>;
+    _showTransitionOptions: string;
+    _hideTransitionOptions: string;
     selectionPath: any;
     focused: boolean;
     filled: boolean;
     overlayVisible: boolean;
     dirty: boolean;
-    valueTemplate: TemplateRef<any>;
-    optionTemplate: TemplateRef<any>;
-    triggerIconTemplate: TemplateRef<any>;
-    groupIconTemplate: TemplateRef<any>;
-    clearIconTemplate: TemplateRef<any>;
+    valueTemplate: Nullable<TemplateRef<any>>;
+    optionTemplate: Nullable<TemplateRef<any>>;
+    triggerIconTemplate: Nullable<TemplateRef<any>>;
+    groupIconTemplate: Nullable<TemplateRef<any>>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
     onModelChange: Function;
     onModelTouched: Function;
     constructor(el: ElementRef, cd: ChangeDetectorRef, config: PrimeNGConfig, overlayService: OverlayService);
     ngOnInit(): void;
     ngAfterContentInit(): void;
     onOptionSelect(event: any): void;
-    onOptionGroupSelect(event: any): void;
-    getOptionLabel(option: any): any;
-    getOptionValue(option: any): any;
-    getOptionGroupChildren(optionGroup: any, level: any): any;
-    isOptionGroup(option: any, level: any): any;
+    onOptionGroupSelect(event: Event): void;
+    getOptionLabel(option: string | object): any;
+    getOptionValue(option: string | object): any;
+    getOptionGroupChildren(optionGroup: string | object, level: number): any;
+    isOptionGroup(option: string | object, level: number): any;
     updateSelectionPath(): void;
     updateFilledState(): void;
-    findModelOptionInGroup(option: any, level: any): any;
+    findModelOptionInGroup(option: string | object, level: number): Nullable<object[] | any>;
     show(): void;
     hide(): void;
-    clear(event: any): void;
-    onClick(event: any): void;
+    clear(event: Event): void;
+    onClick(event: Event): void;
     onFocus(): void;
     onBlur(): void;
     onOverlayAnimationDone(event: AnimationEvent): void;

package/cascadeselect/cascadeselect.interface.d.ts

@@ -0,0 +1,92 @@
+import { ElementRef, TemplateRef } from '@angular/core';
+import { Overlay } from 'primeng/overlay';
+/**
+ * Custom panel show event.
+ * @see {@link CascadeSelect.onShow}
+ * @group Events
+ */
+export interface CascadeSelectShowEvent {
+    /**
+     * Overlay element.
+     */
+    overlay?: Overlay | ElementRef | TemplateRef<any> | HTMLElement | null | undefined;
+    /**
+     * Target element.
+     */
+    target?: Overlay | ElementRef | TemplateRef<any> | HTMLElement | null | undefined;
+    /**
+     * Overlay mode.
+     */
+    overlayMode?: 'modal' | 'overlay' | string;
+}
+/**
+ * Custom panel hide event.
+ * @see {@link CascadeSelect.onHide}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+export interface CascadeSelectHideEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Custom panel show event emits right before the panel is shown.
+ * @see {@link CascadeSelect.onBeforeShow}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+export interface CascadeSelectBeforeShowEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Custom panel hide event emits right before the panel is hidden.
+ * @see {@link CascadeSelect.onBeforeHide}
+ * @extends {CascadeSelectShowEvent}
+ * @group Events
+ */
+export interface CascadeSelectBeforeHideEvent extends CascadeSelectShowEvent {
+}
+/**
+ * Defines valid templates in CascadeSelect.
+ * @group Templates
+ */
+export interface CascadeSelectTemplates {
+    /**
+     * Custom value template.
+     * @param {Object} context - value data.
+     */
+    value(context: {
+        /**
+         * Value.
+         */
+        $implicit: any;
+        /**
+         * Placeholder.
+         */
+        placeholder: string;
+    }): TemplateRef<{
+        $implicit: any;
+        placeholder: string;
+    }>;
+    /**
+     * Custom option template.
+     * @param {Object} context - option data.
+     */
+    option(context: {
+        /**
+         * Option instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom dropdown trigger icon template.
+     */
+    triggericon(): TemplateRef<any>;
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom option group icon template.
+     */
+    optiongroupicon(): TemplateRef<any>;
+}

package/cascadeselect/public_api.d.ts

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

package/chart/chart.d.ts

@@ -1,27 +1,63 @@
 import { ElementRef, AfterViewInit, OnDestroy, EventEmitter } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Chart groups a collection of contents in tabs.
+ * @group Components
+ */
 export declare class UIChart implements AfterViewInit, OnDestroy {
     private platformId;
     el: ElementRef;
-    type: string;
+    /**
+     * Type of the chart.
+     * @group Props
+     */
+    type: string | undefined;
+    /**
+     * Array of per-chart plugins to customize the chart behaviour.
+     * @group Props
+     */
     plugins: any[];
-    width: string;
-    height: string;
+    /**
+     * Width of the chart.
+     * @group Props
+     */
+    width: string | undefined;
+    /**
+     * Height of the chart.
+     * @group Props
+     */
+    height: string | undefined;
+    /**
+     * Whether the chart is redrawn on screen size change.
+     * @group Props
+     */
     responsive: boolean;
+    /**
+     * Data to display.
+     * @group Props
+     */
+    get data(): any;
+    set data(val: any);
+    /**
+     * Options to customize the chart.
+     * @group Props
+     */
+    get options(): any;
+    set options(val: any);
+    /**
+     * Callback to execute when an element on chart is clicked.
+     * @group Emits
+     */
     onDataSelect: EventEmitter<any>;
     isBrowser: boolean;
-    initialized: boolean;
+    initialized: boolean | undefined;
     _data: any;
     _options: any;
     chart: any;
     constructor(platformId: any, el: ElementRef);
-    get data(): any;
-    set data(val: any);
-    get options(): any;
-    set options(val: any);
     ngAfterViewInit(): void;
-    onCanvasClick(event: any): void;
+    onCanvasClick(event: Event): void;
     initChart(): void;
     getCanvas(): any;
     getBase64Image(): any;

package/checkbox/checkbox.d.ts

@@ -1,33 +1,119 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, QueryList, TemplateRef } from '@angular/core';
 import { ControlValueAccessor, FormControl } from '@angular/forms';
+import { PrimeTemplate } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
+import { CheckboxChangeEvent } from './checkbox.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/icons/check";
 import * as i3 from "primeng/api";
 export declare const CHECKBOX_VALUE_ACCESSOR: any;
+/**
+ * Checkbox is an extension to standard checkbox element with theming.
+ * @group Components
+ */
 export declare class Checkbox implements ControlValueAccessor {
     cd: ChangeDetectorRef;
-    value: any;
-    name: string;
-    disabled: boolean;
-    binary: boolean;
-    label: string;
-    ariaLabelledBy: string;
-    ariaLabel: string;
-    tabindex: number;
-    inputId: string;
-    style: any;
-    styleClass: string;
-    labelStyleClass: string;
-    formControl: FormControl;
-    checkboxIcon: string;
-    readonly: boolean;
-    required: boolean;
+    /**
+     * Value of the checkbox.
+     * @group Props
+     */
+    value: string | object | boolean | undefined | null;
+    /**
+     * Name of the checkbox group.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Allows to select a boolean value instead of multiple values.
+     * @group Props
+     */
+    binary: boolean | undefined;
+    /**
+     * Label of the checkbox.
+     * @group Props
+     */
+    label: 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Form control value.
+     * @group Props
+     */
+    formControl: FormControl | undefined;
+    /**
+     * Icon class of the checkbox icon.
+     * @group Props
+     */
+    checkboxIcon: string | undefined;
+    /**
+     * When present, it specifies that the component cannot be edited.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * When present, it specifies that checkbox must be checked before submitting the form.
+     * @group Props
+     */
+    required: boolean | undefined;
+    /**
+     * Value in checked state.
+     * @group Props
+     */
     trueValue: any;
+    /**
+     * Value in unchecked state.
+     * @group Props
+     */
     falseValue: any;
-    inputViewChild: ElementRef;
-    onChange: EventEmitter<any>;
-    templates: QueryList<any>;
+    /**
+     * Callback to invoke on value change.
+     * @param {CheckboxChangeEvent} event - Custom value change event.
+     * @group Emits
+     */
+    onChange: EventEmitter<CheckboxChangeEvent>;
+    inputViewChild: Nullable<ElementRef>;
+    templates: Nullable<QueryList<PrimeTemplate>>;
     checkboxIconTemplate: TemplateRef<any>;
     model: any;
     onModelChange: Function;
@@ -35,9 +121,9 @@ export declare class Checkbox implements ControlValueAccessor {
     focused: boolean;
     constructor(cd: ChangeDetectorRef);
     ngAfterContentInit(): void;
-    onClick(event: any, checkbox: any, focus: boolean): void;
-    updateModel(event: any): void;
-    handleChange(event: any): void;
+    onClick(event: Event, checkbox: HTMLElement, focus: boolean): void;
+    updateModel(event: Event): void;
+    handleChange(event: Event): void;
     onFocus(): void;
     onBlur(): void;
     focus(): void;

package/checkbox/checkbox.interface.d.ts

@@ -0,0 +1,26 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom change event.
+ * @see {@link Checkbox.onChange}
+ * @group Events
+ */
+export interface CheckboxChangeEvent {
+    /**
+     * Checked value.
+     */
+    checked?: any;
+    /**
+     * Browser event.
+     */
+    originalEvent?: Event;
+}
+/**
+ * Defines valid templates in Checkbox.
+ * @group Templates
+ */
+export interface CheckboxTemplates {
+    /**
+     * Custom checkbox icon template
+     */
+    icon(): TemplateRef<any>;
+}