primeng 16.0.0-rc.1 → 16.0.0

package/keyfilter/keyfilter.d.ts

@@ -3,19 +3,36 @@ import { Validator, AbstractControl } from '@angular/forms';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const KEYFILTER_VALIDATOR: any;
+/**
+ * KeyFilter Directive is a built-in feature of InputText to restrict user input based on a regular expression.
+ * @group Components
+ */
 export declare class KeyFilter implements Validator {
     private document;
     private platformId;
     el: ElementRef;
-    pValidateOnly: boolean;
-    ngModelChange: EventEmitter<any>;
+    /**
+     * When enabled, instead of blocking keys, input is validated internally to test against the regular expression.
+     * @group Props
+     */
+    pValidateOnly: boolean | undefined;
+    /**
+     * Sets the pattern for key filtering.
+     * @group Props
+     */
+    set pattern(_pattern: string | RegExp);
+    get pattern(): string | RegExp;
+    /**
+     * Emits a value whenever the ngModel of the component changes.
+     * @param {(string | number)} modelValue - Custom model change event.
+     * @group Emits
+     */
+    ngModelChange: EventEmitter<string | number>;
     regex: RegExp;
-    _pattern: any;
+    _pattern: string | RegExp;
     isAndroid: boolean;
     lastValue: any;
     constructor(document: Document, platformId: any, el: ElementRef);
-    get pattern(): any;
-    set pattern(_pattern: any);
     isNavKeyPress(e: KeyboardEvent): boolean;
     isSpecialKey(e: KeyboardEvent): boolean;
     getKey(e: KeyboardEvent): any;
@@ -25,10 +42,10 @@ export declare class KeyFilter implements Validator {
     isValidString(str: string): boolean;
     onInput(e: KeyboardEvent): void;
     onKeyPress(e: KeyboardEvent): void;
-    onPaste(e: any): void;
+    onPaste(e: ClipboardEvent): void;
     validate(c: AbstractControl): {
         [key: string]: any;
-    };
+    } | any;
     static ɵfac: i0.ɵɵFactoryDeclaration<KeyFilter, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<KeyFilter, "[pKeyFilter]", never, { "pValidateOnly": { "alias": "pValidateOnly"; "required": false; }; "pattern": { "alias": "pKeyFilter"; "required": false; }; }, { "ngModelChange": "ngModelChange"; }, never, never, false, never>;
 }

package/knob/knob.d.ts

@@ -1,52 +1,123 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, Renderer2 } from '@angular/core';
+import { VoidListener } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const KNOB_VALUE_ACCESSOR: any;
+/**
+ * Knob is a form component to define number inputs with a dial.
+ * @group Components
+ */
 export declare class Knob {
     private document;
     private renderer;
     private cd;
     private el;
-    styleClass: string;
-    style: any;
-    severity: string;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Background of the value.
+     * @group Props
+     */
     valueColor: string;
+    /**
+     * Background color of the range.
+     * @group Props
+     */
     rangeColor: string;
+    /**
+     * Color of the value text.
+     * @group Props
+     */
     textColor: string;
+    /**
+     * Template string of the value.
+     * @group Props
+     */
     valueTemplate: string;
-    name: string;
+    /**
+     * Name of the input element.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * Size of the component in pixels.
+     * @group Props
+     */
     size: number;
+    /**
+     * Step factor to increment/decrement the value.
+     * @group Props
+     */
     step: number;
+    /**
+     * Mininum boundary value.
+     * @group Props
+     */
     min: number;
+    /**
+     * Maximum boundary value.
+     * @group Props
+     */
     max: number;
+    /**
+     * Width of the knob stroke.
+     * @group Props
+     */
     strokeWidth: number;
-    disabled: boolean;
+    /**
+     * When present, it specifies that the component should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Whether the show the value inside the knob.
+     * @group Props
+     */
     showValue: boolean;
+    /**
+     * When present, it specifies that the component value cannot be edited.
+     * @group Props
+     */
     readonly: boolean;
-    onChange: EventEmitter<any>;
+    /**
+     * Callback to invoke on value change.
+     * @param {number} value - New value.
+     * @group Emits
+     */
+    onChange: EventEmitter<number>;
     radius: number;
     midX: number;
     midY: number;
     minRadians: number;
     maxRadians: number;
     value: number;
-    windowMouseMoveListener: () => void | null;
-    windowMouseUpListener: () => void | null;
-    windowTouchMoveListener: () => void | null;
-    windowTouchEndListener: () => void | null;
+    windowMouseMoveListener: VoidListener;
+    windowMouseUpListener: VoidListener;
+    windowTouchMoveListener: VoidListener;
+    windowTouchEndListener: VoidListener;
     onModelChange: Function;
     onModelTouched: Function;
     constructor(document: Document, renderer: Renderer2, cd: ChangeDetectorRef, el: ElementRef);
-    mapRange(x: any, inMin: any, inMax: any, outMin: any, outMax: any): any;
-    onClick(event: any): void;
-    updateValue(offsetX: any, offsetY: any): void;
-    updateModel(angle: any, start: any): void;
-    onMouseDown(event: any): void;
-    onMouseUp(event: any): void;
-    onTouchStart(event: any): void;
-    onTouchEnd(event: any): void;
-    onMouseMove(event: any): void;
-    onTouchMove(event: any): void;
+    mapRange(x: number, inMin: number, inMax: number, outMin: number, outMax: number): number;
+    onClick(event: MouseEvent): void;
+    updateValue(offsetX: number, offsetY: number): void;
+    updateModel(angle: number, start: number): void;
+    onMouseDown(event: MouseEvent): void;
+    onMouseUp(event: MouseEvent): void;
+    onTouchStart(event: TouchEvent): void;
+    onTouchEnd(event: TouchEvent): void;
+    onMouseMove(event: MouseEvent): void;
+    onTouchMove(event: Event): void;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
@@ -57,8 +128,8 @@ export declare class Knob {
     };
     rangePath(): string;
     valuePath(): string;
-    zeroRadians(): any;
-    valueRadians(): any;
+    zeroRadians(): number;
+    valueRadians(): number;
     minX(): number;
     minY(): number;
     maxX(): number;
@@ -72,7 +143,7 @@ export declare class Knob {
     valueToDisplay(): string;
     get _value(): number;
     static ɵfac: i0.ɵɵFactoryDeclaration<Knob, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<Knob, "p-knob", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; "valueColor": { "alias": "valueColor"; "required": false; }; "rangeColor": { "alias": "rangeColor"; "required": false; }; "textColor": { "alias": "textColor"; "required": false; }; "valueTemplate": { "alias": "valueTemplate"; "required": false; }; "name": { "alias": "name"; "required": false; }; "size": { "alias": "size"; "required": false; }; "step": { "alias": "step"; "required": false; }; "min": { "alias": "min"; "required": false; }; "max": { "alias": "max"; "required": false; }; "strokeWidth": { "alias": "strokeWidth"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "showValue": { "alias": "showValue"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "onChange": "onChange"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<Knob, "p-knob", never, { "styleClass": { "alias": "styleClass"; "required": false; }; "style": { "alias": "style"; "required": false; }; "valueColor": { "alias": "valueColor"; "required": false; }; "rangeColor": { "alias": "rangeColor"; "required": false; }; "textColor": { "alias": "textColor"; "required": false; }; "valueTemplate": { "alias": "valueTemplate"; "required": false; }; "name": { "alias": "name"; "required": false; }; "size": { "alias": "size"; "required": false; }; "step": { "alias": "step"; "required": false; }; "min": { "alias": "min"; "required": false; }; "max": { "alias": "max"; "required": false; }; "strokeWidth": { "alias": "strokeWidth"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "showValue": { "alias": "showValue"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "onChange": "onChange"; }, never, never, false, never>;
 }
 export declare class KnobModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<KnobModule, never>;

package/listbox/listbox.d.ts

@@ -1,7 +1,9 @@
 import { ElementRef, EventEmitter, AfterContentInit, QueryList, TemplateRef, ChangeDetectorRef, OnInit, OnDestroy } from '@angular/core';
-import { FilterService, PrimeNGConfig } from 'primeng/api';
+import { PrimeTemplate, FilterService, PrimeNGConfig } from 'primeng/api';
 import { ControlValueAccessor } from '@angular/forms';
 import { Subscription } from 'rxjs';
+import { Nullable } from 'primeng/ts-helpers';
+import { ListboxChangeEvent, ListboxClickEvent, ListboxDoubleClickEvent, ListboxFilterOptions } from './listbox.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/api";
@@ -9,74 +11,201 @@ import * as i3 from "primeng/ripple";
 import * as i4 from "primeng/icons/search";
 import * as i5 from "primeng/icons/check";
 export declare const LISTBOX_VALUE_ACCESSOR: any;
-export interface ListboxFilterOptions {
-    filter?: (value?: any) => void;
-    reset?: () => void;
-}
+/**
+ * ListBox is used to select one or more values from a list of items.
+ * @group Components
+ */
 export declare class Listbox implements AfterContentInit, OnInit, ControlValueAccessor, OnDestroy {
     el: ElementRef;
     cd: ChangeDetectorRef;
     filterService: FilterService;
     config: PrimeNGConfig;
-    multiple: boolean;
-    style: any;
-    styleClass: string;
-    listStyle: any;
-    listStyleClass: string;
-    readonly: boolean;
-    disabled: boolean;
+    /**
+     * When specified, allows selecting multiple values.
+     * @group Props
+     */
+    multiple: boolean | undefined;
+    /**
+     * Inline style of the container.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the container.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the list element.
+     * @group Props
+     */
+    listStyle: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the list element.
+     * @group Props
+     */
+    listStyleClass: string | undefined;
+    /**
+     * When present, it specifies that the element value cannot be changed.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * When specified, allows selecting items with checkboxes.
+     * @group Props
+     */
     checkbox: boolean;
+    /**
+     * When specified, displays a filter input at header.
+     * @group Props
+     */
     filter: boolean;
-    filterBy: string;
-    filterMatchMode: string;
-    filterLocale: string;
+    /**
+     * When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
+     * @group Props
+     */
+    filterBy: string | undefined;
+    /**
+     * Defines how the items are filtered.
+     * @group Props
+     */
+    filterMatchMode: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte';
+    /**
+     * Locale to use in filtering. The default locale is the host environment's current locale.
+     * @group Props
+     */
+    filterLocale: string | undefined;
+    /**
+     * Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
+     * @group Props
+     */
     metaKeySelection: boolean;
-    dataKey: string;
+    /**
+     * A property to uniquely identify a value in options.
+     * @group Props
+     */
+    dataKey: string | undefined;
+    /**
+     * Whether header checkbox is shown in multiple mode.
+     * @group Props
+     */
     showToggleAll: boolean;
-    optionLabel: string;
-    optionValue: string;
-    optionGroupChildren: string;
-    optionGroupLabel: string;
-    optionDisabled: string;
-    ariaFilterLabel: string;
-    filterPlaceHolder: string;
-    emptyFilterMessage: string;
-    emptyMessage: string;
-    group: boolean;
-    onChange: EventEmitter<any>;
-    onClick: EventEmitter<any>;
-    onDblClick: EventEmitter<any>;
-    headerCheckboxViewChild: ElementRef;
-    filterViewChild: ElementRef;
-    headerFacet: any;
-    footerFacet: any;
-    templates: QueryList<any>;
-    _options: any[];
-    itemTemplate: TemplateRef<any>;
-    groupTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    filterTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    emptyFilterTemplate: TemplateRef<any>;
-    emptyTemplate: TemplateRef<any>;
-    filterIconTemplate: TemplateRef<any>;
-    checkIconTemplate: TemplateRef<any>;
-    _filterValue: string;
-    _filteredOptions: any[];
-    filterOptions: ListboxFilterOptions;
-    filtered: boolean;
-    value: any;
-    onModelChange: Function;
-    onModelTouched: Function;
-    optionTouched: boolean;
-    focus: boolean;
-    headerCheckboxFocus: boolean;
-    translationSubscription: Subscription;
-    constructor(el: ElementRef, cd: ChangeDetectorRef, filterService: FilterService, config: PrimeNGConfig);
+    /**
+     * Name of the label field of an option.
+     * @group Props
+     */
+    optionLabel: string | undefined;
+    /**
+     * Name of the value field of an option.
+     * @group Props
+     */
+    optionValue: string | undefined;
+    /**
+     * Name of the options field of an option group.
+     * @group Props
+     */
+    optionGroupChildren: string | undefined;
+    /**
+     * Name of the label field of an option group.
+     * @group Props
+     */
+    optionGroupLabel: string | undefined;
+    /**
+     * Name of the disabled field of an option.
+     * @group Props
+     */
+    optionDisabled: string | undefined;
+    /**
+     * Defines a string that labels the filter input.
+     * @group Props
+     */
+    ariaFilterLabel: string | undefined;
+    /**
+     * Defines placeholder of the filter input.
+     * @group Props
+     */
+    filterPlaceHolder: string | undefined;
+    /**
+     * Text to display when filtering does not return any results.
+     * @group Props
+     */
+    emptyFilterMessage: string | undefined;
+    /**
+     * Text to display when there is no data. Defaults to global value in i18n translation configuration.
+     * @group Props
+     */
+    emptyMessage: string | undefined;
+    /**
+     * Whether to display options as grouped when nested options are provided.
+     * @group Props
+     */
+    group: boolean | undefined;
+    /**
+     * An array of selectitems to display as the available options.
+     * @group Props
+     */
     get options(): any[];
     set options(val: any[]);
+    /**
+     * When specified, filter displays with this value.
+     * @group Props
+     */
     get filterValue(): string;
     set filterValue(val: string);
+    /**
+     * Callback to invoke on value change.
+     * @param {ListboxChangeEvent} event - Custom change event.
+     * @group Emits
+     */
+    onChange: EventEmitter<ListboxChangeEvent>;
+    /**
+     * Callback to invoke when option is clicked.
+     * @param {ListboxClickEvent} event - Custom click event.
+     * @group Emits
+     */
+    onClick: EventEmitter<ListboxClickEvent>;
+    /**
+     * Callback to invoke when option is double clicked.
+     * @param {ListboxDoubleClickEvent} event - Custom double click event.
+     * @group Emits
+     */
+    onDblClick: EventEmitter<ListboxDoubleClickEvent>;
+    headerCheckboxViewChild: Nullable<ElementRef>;
+    filterViewChild: Nullable<ElementRef>;
+    headerFacet: Nullable<TemplateRef<any>>;
+    footerFacet: Nullable<TemplateRef<any>>;
+    templates: QueryList<PrimeTemplate>;
+    _options: any[] | null | undefined;
+    itemTemplate: TemplateRef<any> | undefined;
+    groupTemplate: TemplateRef<any> | undefined;
+    headerTemplate: TemplateRef<any> | undefined;
+    filterTemplate: TemplateRef<any> | undefined;
+    footerTemplate: TemplateRef<any> | undefined;
+    emptyFilterTemplate: TemplateRef<any> | undefined;
+    emptyTemplate: TemplateRef<any> | undefined;
+    filterIconTemplate: TemplateRef<any> | undefined;
+    checkIconTemplate: TemplateRef<any> | undefined;
+    _filterValue: string | undefined | null;
+    _filteredOptions: any[] | undefined | null;
+    filterOptions: ListboxFilterOptions | undefined;
+    filtered: boolean | undefined | null;
+    value: any | undefined | null;
+    onModelChange: Function;
+    onModelTouched: Function;
+    optionTouched: boolean | undefined | null;
+    focus: boolean | undefined | null;
+    headerCheckboxFocus: boolean | undefined | null;
+    translationSubscription: Nullable<Subscription>;
+    constructor(el: ElementRef, cd: ChangeDetectorRef, filterService: FilterService, config: PrimeNGConfig);
     ngOnInit(): void;
     ngAfterContentInit(): void;
     getOptionLabel(option: any): any;
@@ -91,9 +220,9 @@ export declare class Listbox implements AfterContentInit, OnInit, ControlValueAc
     onOptionClick(event: Event, option: any): void;
     onOptionTouchEnd(option: any): void;
     onOptionDoubleClick(event: Event, option: any): any;
-    onOptionClickSingle(event: any, option: any): void;
-    onOptionClickMultiple(event: any, option: any): void;
-    onOptionClickCheckbox(event: any, option: any): void;
+    onOptionClickSingle(event: Event, option: any): void;
+    onOptionClickMultiple(event: Event, option: any): void;
+    onOptionClickCheckbox(event: Event, option: any): void;
     removeOption(option: any): void;
     isSelected(option: any): boolean;
     get allChecked(): boolean;
@@ -106,12 +235,12 @@ export declare class Listbox implements AfterContentInit, OnInit, ControlValueAc
     activateFilter(): void;
     resetFilter(): void;
     get toggleAllDisabled(): boolean;
-    toggleAll(event: any): void;
+    toggleAll(event: Event): void;
     checkAll(): void;
     uncheckAll(): void;
     onOptionKeyDown(event: KeyboardEvent, option: any): void;
-    findNextItem(item: any): any;
-    findPrevItem(item: any): any;
+    findNextItem(item: HTMLElement): HTMLElement | null;
+    findPrevItem(item: HTMLElement): HTMLElement | null;
     onHeaderCheckboxFocus(): void;
     onHeaderCheckboxBlur(): void;
     ngOnDestroy(): void;

package/listbox/listbox.interface.d.ts

@@ -0,0 +1,126 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Filter options of listbox.
+ * @group Interface
+ */
+export interface ListboxFilterOptions {
+    /**
+     * Callback to filter options.
+     * @param {any} value - Filter value.
+     */
+    filter?: (value?: any) => void;
+    /**
+     * Callback to reset filter.
+     */
+    reset?: () => void;
+}
+/**
+ * Custom change event.
+ * @see {@link Listbox.onChange}
+ * @group Events
+ */
+export interface ListboxChangeEvent {
+    /**
+     * Original event
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+}
+/**
+ * Custom change event.
+ * @see {@link Listbox.onClick}
+ * @group Events
+ */
+export interface ListboxClickEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected option value
+     */
+    value: any;
+    /**
+     * Selected option
+     */
+    option: any;
+}
+/**
+ * Custom change event.
+ * @see {@link Listbox.onDblClick}
+ * @group Events
+ */
+export interface ListboxDoubleClickEvent extends ListboxClickEvent {
+}
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+export interface ListboxTemplates {
+    /**
+     * Custom item template.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Data of the option.
+         */
+        $implicit: any;
+        /**
+         * Index of the option.
+         */
+        index: number;
+    }): TemplateRef<{
+        $implicit: any;
+        index: number;
+    }>;
+    /**
+     * Custom group template.
+     * @param {Object} context - group data.
+     */
+    group(context: {
+        /**
+         * Group option.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom filter template.
+     * @param {Object} context - filter options.
+     */
+    filter(context: {
+        /**
+         * Filter options.
+         */
+        options: ListboxFilterOptions;
+    }): TemplateRef<any>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<any>;
+    /**
+     * Custom empty filter template.
+     */
+    emptyfilter(): TemplateRef<any>;
+    /**
+     * Custom filter icon template.
+     */
+    filtericon(): TemplateRef<any>;
+    /**
+     * Custom check icon template.
+     */
+    checkicon(): TemplateRef<any>;
+}

package/listbox/public_api.d.ts

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