primeng 16.0.0-rc.1 → 16.0.0

package/inputmask/inputmask.d.ts

@@ -1,5 +1,8 @@
 import { ChangeDetectorRef, ElementRef, EventEmitter, OnInit, QueryList, TemplateRef } from '@angular/core';
 import { ControlValueAccessor } from '@angular/forms';
+import { PrimeTemplate } from 'primeng/api';
+import { Nullable } from 'primeng/ts-helpers';
+import { Caret } from './inputmask.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/inputtext";
@@ -7,94 +10,223 @@ import * as i3 from "primeng/autofocus";
 import * as i4 from "primeng/icons/times";
 import * as i5 from "primeng/api";
 export declare const INPUTMASK_VALUE_ACCESSOR: any;
+/**
+ * InputMask component is used to enter input in a certain format such as numeric, date, currency, email and phone.
+ * @group Components
+ */
 export declare class InputMask implements OnInit, ControlValueAccessor {
     private document;
     private platformId;
     el: ElementRef;
     cd: ChangeDetectorRef;
+    /**
+     * HTML5 input type.
+     * @group Props
+     */
     type: string;
+    /**
+     * Placeholder character in mask, default is underscore.
+     * @group Props
+     */
     slotChar: string;
+    /**
+     * Clears the incomplete value on blur.
+     * @group Props
+     */
     autoClear: boolean;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     showClear: boolean;
-    style: any;
-    inputId: string;
-    styleClass: string;
-    placeholder: string;
-    size: number;
-    maxlength: number;
-    tabindex: string;
-    title: string;
-    ariaLabel: string;
-    ariaRequired: boolean;
-    disabled: boolean;
-    readonly: boolean;
-    unmask: boolean;
-    name: string;
-    required: boolean;
+    /**
+     * Inline style of the input field.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Identifier of the focus input to match a label defined for the component.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Style class of the input field.
+     * @group Props
+     */
+    styleClass: string | 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: string | 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;
+    /**
+     * When present, it specifies that the element value cannot be altered.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * When present, it specifies that an input field is read-only.
+     * @group Props
+     */
+    readonly: boolean | undefined;
+    /**
+     * Defines if ngModel sets the raw unmasked value to bound value or the formatted mask value.
+     * @group Props
+     */
+    unmask: boolean | undefined;
+    /**
+     * Name of the input field.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * When present, it specifies that an input field must be filled out before submitting the form.
+     * @group Props
+     */
+    required: boolean | undefined;
+    /**
+     * Regex pattern for alpha characters
+     * @group Props
+     */
     characterPattern: string;
-    autoFocus: boolean;
-    autocomplete: string;
+    /**
+     * When present, the input gets a focus automatically on load.
+     * @group Props
+     */
+    autoFocus: boolean | undefined;
+    /**
+     * Used to define a string that autocomplete attribute the current element.
+     * @group Props
+     */
+    autocomplete: string | undefined;
+    /**
+     * When present, it specifies that whether to clean buffer value from model.
+     * @group Props
+     */
     keepBuffer: boolean;
-    inputViewChild: ElementRef;
+    /**
+     * Mask pattern.
+     * @group Props
+     */
+    get mask(): string | undefined | null;
+    set mask(val: string | undefined | null);
+    /**
+     * Callback to invoke when the mask is completed.
+     * @group Emits
+     */
     onComplete: EventEmitter<any>;
-    onFocus: EventEmitter<any>;
-    onBlur: EventEmitter<any>;
-    onInput: EventEmitter<any>;
-    onKeydown: EventEmitter<any>;
+    /**
+     * 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.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onInput: EventEmitter<Event>;
+    /**
+     * Callback to invoke on input key press.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onKeydown: EventEmitter<Event>;
+    /**
+     * Callback to invoke when input field is cleared.
+     * @group Emits
+     */
     onClear: EventEmitter<any>;
-    templates: QueryList<any>;
-    clearIconTemplate: TemplateRef<any>;
-    value: any;
-    _mask: string;
+    inputViewChild: Nullable<ElementRef>;
+    templates: QueryList<PrimeTemplate>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    value: Nullable<string>;
+    _mask: Nullable<string>;
     onModelChange: Function;
     onModelTouched: Function;
-    input: HTMLInputElement;
-    filled: boolean;
-    defs: any;
-    tests: any[];
-    partialPosition: any;
-    firstNonMaskPos: number;
-    lastRequiredNonMaskPos: any;
-    len: number;
-    oldVal: string;
-    buffer: any;
-    defaultBuffer: string;
-    focusText: string;
+    input: Nullable<HTMLInputElement>;
+    filled: Nullable<boolean>;
+    defs: Nullable<{
+        [klass: string]: any;
+    }>;
+    tests: RegExp[] | any;
+    partialPosition: Nullable<number>;
+    firstNonMaskPos: Nullable<number>;
+    lastRequiredNonMaskPos: Nullable<number>;
+    len: Nullable<number>;
+    oldVal: Nullable<string>;
+    buffer: string[] | any;
+    defaultBuffer: Nullable<string>;
+    focusText: Nullable<string>;
     caretTimeoutId: any;
     androidChrome: boolean;
-    focused: boolean;
+    focused: Nullable<boolean>;
     constructor(document: Document, platformId: any, el: ElementRef, cd: ChangeDetectorRef);
     ngOnInit(): void;
     ngAfterContentInit(): void;
-    get mask(): string;
-    set mask(val: string);
     initMask(): void;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;
     setDisabledState(val: boolean): void;
-    caret(first?: number, last?: number): {
-        begin: any;
-        end: any;
-    };
+    caret(first?: number, last?: number): Caret | undefined;
     isCompleted(): boolean;
     getPlaceholder(i: number): string;
-    seekNext(pos: any): any;
-    seekPrev(pos: any): any;
+    seekNext(pos: number): number;
+    seekPrev(pos: number): number;
     shiftL(begin: number, end: number): void;
-    shiftR(pos: any): void;
-    handleAndroidInput(e: any): void;
-    onInputBlur(e: any): void;
-    onInputKeydown(e: any): void;
-    onKeyPress(e: any): void;
-    clearBuffer(start: any, end: any): void;
+    shiftR(pos: number): void;
+    handleAndroidInput(e: Event): void;
+    onInputBlur(e: Event): void;
+    onInputKeydown(e: KeyboardEvent): void;
+    onKeyPress(e: KeyboardEvent): void;
+    clearBuffer(start: number, end: number): void;
     writeBuffer(): void;
-    checkVal(allow?: boolean): any;
-    onInputFocus(event: any): void;
-    onInputChange(event: any): void;
-    handleInputChange(event: any): void;
+    checkVal(allow?: boolean): number;
+    onInputFocus(event: Event): void;
+    onInputChange(event: Event): void;
+    handleInputChange(event: Event): void;
     getUnmaskedValue(): string;
-    updateModel(e: any): void;
+    updateModel(e: Event): void;
     updateFilledState(): void;
     focus(): void;
     clear(): void;

package/inputmask/inputmask.interface.d.ts

@@ -0,0 +1,19 @@
+import { TemplateRef } from '@angular/core';
+/**
+ * Caret positions.
+ * @group Types
+ */
+export type Caret = {
+    begin: number;
+    end: number;
+};
+/**
+ * Defines valid templates in InputMask.
+ * @group Templates
+ */
+export interface InputMaskTemplates {
+    /**
+     * Custom clear icon template.
+     */
+    clearicon(): TemplateRef<any>;
+}

package/inputmask/public_api.d.ts

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