primeng 16.0.0-rc.1 → 16.0.0

package/inputnumber/inputnumber.d.ts

@@ -1,5 +1,8 @@
 import { AfterContentInit, ChangeDetectorRef, ElementRef, EventEmitter, Injector, OnChanges, OnInit, QueryList, SimpleChanges, TemplateRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { PrimeTemplate } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
+import { InputNumberInputEvent } from './inputnumber.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/inputtext";
@@ -9,82 +12,272 @@ import * as i5 from "primeng/icons/angleup";
 import * as i6 from "primeng/icons/angledown";
 import * as i7 from "primeng/api";
 export declare const INPUTNUMBER_VALUE_ACCESSOR: any;
+/**
+ * InputNumber is an input component to provide numerical input.
+ * @group Components
+ */
 export declare class InputNumber implements OnInit, AfterContentInit, OnChanges, ControlValueAccessor {
     private document;
     el: ElementRef;
     private cd;
     private readonly injector;
+    /**
+     * Displays spinner buttons.
+     * @group Props
+     */
     showButtons: boolean;
+    /**
+     * Whether to format the value.
+     * @group Props
+     */
     format: boolean;
+    /**
+     * Layout of the buttons, valid values are "stacked" (default), "horizontal" and "vertical".
+     * @group Props
+     */
     buttonLayout: string;
-    inputId: string;
-    styleClass: string;
-    style: any;
-    placeholder: string;
-    size: number;
-    maxlength: number;
-    tabindex: number;
-    title: string;
-    ariaLabel: string;
-    ariaRequired: boolean;
-    name: string;
-    required: boolean;
-    autocomplete: string;
-    min: number;
-    max: number;
-    incrementButtonClass: string;
-    decrementButtonClass: string;
-    incrementButtonIcon: string;
-    decrementButtonIcon: string;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Advisory information to display on input.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * Size of the input field.
+     * @group Props
+     */
+    size: number | undefined;
+    /**
+     * Maximum number of character allows in the input field.
+     * @group Props
+     */
+    maxlength: number | undefined;
+    /**
+     * Specifies tab order of the element.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Title text of the input text.
+     * @group Props
+     */
+    title: string | undefined;
+    /**
+     * Used to define a string that labels the input element.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Used to indicate that user input is required on an element before a form can be submitted.
+     * @group Props
+     */
+    ariaRequired: boolean | undefined;
+    /**
+     * Name of the input field.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * No description available.
+     * @group Props
+     */
+    required: boolean | undefined;
+    /**
+     * Used to define a string that autocomplete attribute the current element.
+     * @group Props
+     */
+    autocomplete: string | undefined;
+    /**
+     * Mininum boundary value.
+     * @group Props
+     */
+    min: number | undefined;
+    /**
+     * Maximum boundary value.
+     * @group Props
+     */
+    max: number | undefined;
+    /**
+     * Style class of the increment button.
+     * @group Props
+     */
+    incrementButtonClass: string | undefined;
+    /**
+     * Style class of the decrement button.
+     * @group Props
+     */
+    decrementButtonClass: string | undefined;
+    /**
+     * Style class of the increment button.
+     * @group Props
+     */
+    incrementButtonIcon: string | undefined;
+    /**
+     * Style class of the decrement button.
+     * @group Props
+     */
+    decrementButtonIcon: string | undefined;
+    /**
+     * When present, it specifies that an input field is read-only.
+     * @group Props
+     */
     readonly: boolean;
+    /**
+     * Step factor to increment/decrement the value.
+     * @group Props
+     */
     step: number;
+    /**
+     * Determines whether the input field is empty.
+     * @group Props
+     */
     allowEmpty: boolean;
-    locale: string;
-    localeMatcher: string;
+    /**
+     * Locale to be used in formatting.
+     * @group Props
+     */
+    locale: string | undefined;
+    /**
+     * The locale matching algorithm to use. Possible values are "lookup" and "best fit"; the default is "best fit". See Locale Negotiation for details.
+     * @group Props
+     */
+    localeMatcher: string | undefined;
+    /**
+     * Defines the behavior of the component, valid values are "decimal" and "currency".
+     * @group Props
+     */
     mode: string;
-    currency: string;
-    currencyDisplay: string;
+    /**
+     * The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro, or "CNY" for the Chinese RMB. There is no default value; if the style is "currency", the currency property must be provided.
+     * @group Props
+     */
+    currency: string | undefined;
+    /**
+     * How to display the currency in currency formatting. Possible values are "symbol" to use a localized currency symbol such as €, ü"code" to use the ISO currency code, "name" to use a localized currency name such as "dollar"; the default is "symbol".
+     * @group Props
+     */
+    currencyDisplay: string | undefined;
+    /**
+     * Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators.
+     * @group Props
+     */
     useGrouping: boolean;
-    minFractionDigits: number;
-    maxFractionDigits: number;
-    prefix: string;
-    suffix: string;
+    /**
+     * The minimum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number and percent formatting is 0; the default for currency formatting is the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information).
+     * @group Props
+     */
+    minFractionDigits: number | undefined;
+    /**
+     * The maximum number of fraction digits to use. Possible values are from 0 to 20; the default for plain number formatting is the larger of minimumFractionDigits and 3; the default for currency formatting is the larger of minimumFractionDigits and the number of minor unit digits provided by the ISO 4217 currency code list (2 if the list doesn't provide that information).
+     * @group Props
+     */
+    maxFractionDigits: number | undefined;
+    /**
+     * Text to display before the value.
+     * @group Props
+     */
+    prefix: string | undefined;
+    /**
+     * Text to display after the value.
+     * @group Props
+     */
+    suffix: string | undefined;
+    /**
+     * Inline style of the input field.
+     * @group Props
+     */
     inputStyle: any;
-    inputStyleClass: string;
+    /**
+     * Style class of the input field.
+     * @group Props
+     */
+    inputStyleClass: string | undefined;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     showClear: boolean;
+    /**
+     * No description available.
+     * @group Emits
+     */
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    get disabled(): boolean | undefined;
+    set disabled(disabled: boolean | undefined);
+    /**
+     * Callback to invoke on input.
+     * @param {InputNumberInputEvent} event - Custom input event.
+     * @group Emits
+     */
+    onInput: EventEmitter<InputNumberInputEvent>;
+    /**
+     * Callback to invoke when the component receives focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onFocus: EventEmitter<Event>;
+    /**
+     * Callback to invoke when the component loses focus.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onBlur: EventEmitter<Event>;
+    /**
+     * Callback to invoke on input key press.
+     * @param {KeyboardEvent} event - Keyboard event.
+     * @group Emits
+     */
+    onKeyDown: EventEmitter<KeyboardEvent>;
+    /**
+     * Callback to invoke when clear token is clicked.
+     * @group Emits
+     */
+    onClear: EventEmitter<void>;
     input: ElementRef;
-    onInput: EventEmitter<any>;
-    onFocus: EventEmitter<any>;
-    onBlur: EventEmitter<any>;
-    onKeyDown: EventEmitter<any>;
-    onClear: EventEmitter<any>;
-    templates: QueryList<any>;
-    clearIconTemplate: TemplateRef<any>;
-    incrementButtonIconTemplate: TemplateRef<any>;
-    decrementButtonIconTemplate: TemplateRef<any>;
-    value: number;
+    templates: QueryList<PrimeTemplate>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    incrementButtonIconTemplate: Nullable<TemplateRef<any>>;
+    decrementButtonIconTemplate: Nullable<TemplateRef<any>>;
+    value: Nullable<number>;
     onModelChange: Function;
     onModelTouched: Function;
-    focused: boolean;
-    initialized: boolean;
+    focused: Nullable<boolean>;
+    initialized: Nullable<boolean>;
     groupChar: string;
     prefixChar: string;
     suffixChar: string;
-    isSpecialChar: boolean;
+    isSpecialChar: Nullable<boolean>;
     timer: any;
-    lastValue: string;
+    lastValue: Nullable<string>;
     _numeral: any;
     numberFormat: any;
     _decimal: any;
     _group: any;
     _minusSign: any;
-    _currency: any;
-    _prefix: any;
-    _suffix: any;
-    _index: any;
-    _disabled: boolean;
-    get disabled(): boolean;
-    set disabled(disabled: boolean);
+    _currency: Nullable<RegExp | string>;
+    _prefix: Nullable<RegExp>;
+    _suffix: Nullable<RegExp>;
+    _index: number | any;
+    _disabled: boolean | undefined;
     private ngControl;
     constructor(document: Document, el: ElementRef, cd: ChangeDetectorRef, injector: Injector);
     ngOnChanges(simpleChange: SimpleChanges): void;
@@ -101,7 +294,7 @@ export declare class InputNumber implements OnInit, AfterContentInit, OnChanges,
     };
     constructParser(): void;
     updateConstructParser(): void;
-    escapeRegExp(text: any): any;
+    escapeRegExp(text: string): string;
     getDecimalExpression(): RegExp;
     getGroupingExpression(): RegExp;
     getMinusSignExpression(): RegExp;
@@ -110,58 +303,58 @@ export declare class InputNumber implements OnInit, AfterContentInit, OnChanges,
     getSuffixExpression(): RegExp;
     formatValue(value: any): any;
     parseValue(text: any): any;
-    repeat(event: any, interval: any, dir: any): void;
-    spin(event: any, dir: any): void;
+    repeat(event: Event, interval: number | null, dir: number): void;
+    spin(event: Event, dir: number): void;
     clear(): void;
-    onUpButtonMouseDown(event: any): void;
+    onUpButtonMouseDown(event: MouseEvent): void;
     onUpButtonMouseUp(): void;
     onUpButtonMouseLeave(): void;
-    onUpButtonKeyDown(event: any): void;
+    onUpButtonKeyDown(event: KeyboardEvent): void;
     onUpButtonKeyUp(): void;
-    onDownButtonMouseDown(event: any): void;
+    onDownButtonMouseDown(event: MouseEvent): void;
     onDownButtonMouseUp(): void;
     onDownButtonMouseLeave(): void;
     onDownButtonKeyUp(): void;
-    onDownButtonKeyDown(event: any): void;
-    onUserInput(event: any): void;
-    onInputKeyDown(event: any): void;
-    onInputKeyPress(event: any): void;
-    onPaste(event: any): void;
+    onDownButtonKeyDown(event: KeyboardEvent): void;
+    onUserInput(event: Event): void;
+    onInputKeyDown(event: KeyboardEvent): void;
+    onInputKeyPress(event: KeyboardEvent): void;
+    onPaste(event: ClipboardEvent): void;
     allowMinusSign(): boolean;
-    isMinusSign(char: any): boolean;
-    isDecimalSign(char: any): boolean;
+    isMinusSign(char: string): boolean;
+    isDecimalSign(char: string): boolean;
     isDecimalMode(): boolean;
-    getDecimalCharIndexes(val: any): {
-        decimalCharIndex: any;
-        decimalCharIndexWithoutPrefix: any;
+    getDecimalCharIndexes(val: string): {
+        decimalCharIndex: number;
+        decimalCharIndexWithoutPrefix: number;
     };
-    getCharIndexes(val: any): {
-        decimalCharIndex: any;
-        minusCharIndex: any;
-        suffixCharIndex: any;
-        currencyCharIndex: any;
+    getCharIndexes(val: string): {
+        decimalCharIndex: number;
+        minusCharIndex: number;
+        suffixCharIndex: number;
+        currencyCharIndex: number;
     };
-    insert(event: any, text: any, sign?: {
+    insert(event: Event, text: string, sign?: {
         isDecimalSign: boolean;
         isMinusSign: boolean;
     }): void;
-    insertText(value: any, text: any, start: any, end: any): any;
-    deleteRange(value: any, start: any, end: any): any;
+    insertText(value: string, text: string, start: number, end: number): any;
+    deleteRange(value: string, start: number, end: number): any;
     initCursor(): any;
     onInputClick(): void;
-    isNumeralChar(char: any): boolean;
+    isNumeralChar(char: string): boolean;
     resetRegex(): void;
-    updateValue(event: any, valueStr: any, insertedValueStr: any, operation: any): void;
-    handleOnInput(event: any, currentValue: any, newValue: any): void;
-    isValueChanged(currentValue: any, newValue: any): boolean;
-    validateValue(value: any): any;
-    updateInput(value: any, insertedValueStr: any, operation: any, valueStr: any): void;
-    concatValues(val1: any, val2: any): any;
-    getDecimalLength(value: any): any;
-    onInputFocus(event: any): void;
-    onInputBlur(event: any): void;
+    updateValue(event: Event, valueStr: Nullable<string>, insertedValueStr: Nullable<string>, operation: Nullable<string>): void;
+    handleOnInput(event: Event, currentValue: string, newValue: any): void;
+    isValueChanged(currentValue: string, newValue: string): boolean;
+    validateValue(value: number | string): string | number;
+    updateInput(value: any, insertedValueStr: Nullable<string>, operation: Nullable<string>, valueStr: Nullable<string>): void;
+    concatValues(val1: string, val2: string): string;
+    getDecimalLength(value: string): number;
+    onInputFocus(event: Event): void;
+    onInputBlur(event: Event): void;
     formattedValue(): any;
-    updateModel(event: any, value: any): void;
+    updateModel(event: Event, value: any): void;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;

package/inputnumber/inputnumber.interface.d.ts

@@ -0,0 +1,38 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Custom input event.
+ * @see {@link InputNumber.onInput}
+ * @group Events
+ */
+export interface InputNumberInputEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Input value.
+     */
+    value: string;
+    /**
+     * Selected option value.
+     */
+    formattedValue: string;
+}
+/**
+ * Defines valid templates in InputNumber.
+ * @group Templates
+ */
+export interface InputNumberTemplates {
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+    /**
+     * Custom increment button icon template.
+     */
+    incrementbuttonicon(): TemplateRef<any>;
+    /**
+     * Custom decrement button icon template.
+     */
+    decrementbuttonicon(): TemplateRef<any>;
+}

package/inputnumber/public_api.d.ts

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

package/inputswitch/inputswitch.d.ts

@@ -1,25 +1,77 @@
 import { EventEmitter, ChangeDetectorRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { InputSwitchOnChangeEvent } from './inputswitch.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare const INPUTSWITCH_VALUE_ACCESSOR: any;
-export interface InputSwitchOnChangeEvent {
-    originalEvent: Event;
-    checked: boolean;
-}
+/**
+ * InputSwitch is used to select a boolean value.
+ * @group Components
+ */
 export declare class InputSwitch implements ControlValueAccessor {
     private cd;
-    style: any;
-    styleClass: string;
-    tabindex: number;
-    inputId: string;
-    name: string;
-    disabled: boolean;
-    readonly: boolean;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Index of the element in tabbing order.
+     * @group Props
+     */
+    tabindex: number | undefined;
+    /**
+     * Identifier of the input element.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Name of the input element.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * When present, it specifies that the element should be disabled.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * When present, it specifies that the component cannot be edited.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * Value in checked state.
+     * @group Props
+     */
     trueValue: any;
+    /**
+     * Value in unchecked state.
+     * @group Props
+     */
     falseValue: any;
-    ariaLabel: string;
-    ariaLabelledBy: string;
+    /**
+     * Used to define a string that autocomplete attribute the current element.
+     * @group Props
+     */
+    ariaLabel: 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;
+    /**
+     * Callback to invoke when the on value change.
+     * @param {InputSwitchOnChangeEvent} event - Custom change event.
+     * @group Emits
+     */
     onChange: EventEmitter<InputSwitchOnChangeEvent>;
     modelValue: any;
     focused: boolean;

package/inputswitch/inputswitch.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Custom change event.
+ * @see {@link InputSwitch.onChange}
+ * @group Events
+ */
+export interface InputSwitchOnChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Checked state.
+     */
+    checked: boolean;
+}

package/inputswitch/public_api.d.ts

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

package/inputtext/inputtext.d.ts

@@ -1,16 +1,17 @@
 import { ElementRef, DoCheck, ChangeDetectorRef, AfterViewInit } from '@angular/core';
 import { NgModel } from '@angular/forms';
+import { Nullable } from 'primeng/ts-helpers';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 export declare class InputText implements DoCheck, AfterViewInit {
     el: ElementRef;
     ngModel: NgModel;
     private cd;
-    filled: boolean;
+    filled: Nullable<boolean>;
     constructor(el: ElementRef, ngModel: NgModel, cd: ChangeDetectorRef);
     ngAfterViewInit(): void;
     ngDoCheck(): void;
-    onInput(e: any): void;
+    onInput(): void;
     updateFilledState(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<InputText, [null, { optional: true; }, null]>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<InputText, "[pInputText]", never, {}, {}, never, never, false, never>;

package/inputtextarea/inputtextarea.d.ts

@@ -3,24 +3,37 @@ import { NgModel, NgControl } from '@angular/forms';
 import { Subscription } from 'rxjs';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * InputTextarea adds styling and autoResize functionality to standard textarea element.
+ * @group Components
+ */
 export declare class InputTextarea implements OnInit, AfterViewInit, OnDestroy {
     el: ElementRef;
     ngModel: NgModel;
     control: NgControl;
     private cd;
-    autoResize: boolean;
-    onResize: EventEmitter<any>;
-    filled: boolean;
-    cachedScrollHeight: number;
-    ngModelSubscription: Subscription;
-    ngControlSubscription: Subscription;
+    /**
+     * When present, textarea size changes as being typed.
+     * @group Props
+     */
+    autoResize: boolean | undefined;
+    /**
+     * Callback to invoke on textarea resize.
+     * @param {(Event | {})} event - Custom resize event.
+     * @group Emits
+     */
+    onResize: EventEmitter<Event | {}>;
+    filled: boolean | undefined;
+    cachedScrollHeight: number | undefined;
+    ngModelSubscription: Subscription | undefined;
+    ngControlSubscription: Subscription | undefined;
     constructor(el: ElementRef, ngModel: NgModel, control: NgControl, cd: ChangeDetectorRef);
     ngOnInit(): void;
     ngAfterViewInit(): void;
-    onInput(e: any): void;
+    onInput(e: Event): void;
     updateFilledState(): void;
-    onFocus(e: any): void;
-    onBlur(e: any): void;
+    onFocus(e: Event): void;
+    onBlur(e: Event): void;
     resize(event?: Event): void;
     updateState(): void;
     ngOnDestroy(): void;