primeng 16.0.0-rc.1 → 16.0.0-rc.2

package/password/password.d.ts

@@ -1,7 +1,9 @@
 import { AfterContentInit, ChangeDetectorRef, DoCheck, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, PipeTransform, QueryList, Renderer2, TemplateRef } from '@angular/core';
-import { OverlayService, PrimeNGConfig } from 'primeng/api';
+import { OverlayService, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
 import { ConnectedOverlayScrollHandler } from 'primeng/dom';
 import { Subscription } from 'rxjs';
+import { Nullable, VoidListener } from 'primeng/ts-helpers';
+import { AnimationEvent } from '@angular/animations';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "primeng/inputtext";
@@ -9,36 +11,64 @@ import * as i3 from "primeng/icons/times";
 import * as i4 from "primeng/icons/eyeslash";
 import * as i5 from "primeng/icons/eye";
 import * as i6 from "primeng/api";
+type Meter = {
+    strength: string;
+    width: string;
+};
 export declare class PasswordDirective implements OnDestroy, DoCheck {
     private document;
     private platformId;
     private renderer;
     el: ElementRef;
     zone: NgZone;
+    /**
+     * Text to prompt password entry. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
     promptLabel: string;
+    /**
+     * Text for a weak password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
     weakLabel: string;
+    /**
+     * Text for a medium password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
     mediumLabel: string;
+    /**
+     * Text for a strong password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
     strongLabel: string;
+    /**
+     * Whether to show the strength indicator or not.
+     * @group Props
+     */
     feedback: boolean;
+    /**
+     * Sets the visibility of the password field.
+     * @group Props
+     */
     set showPassword(show: boolean);
-    panel: HTMLDivElement;
-    meter: any;
-    info: any;
-    filled: boolean;
-    scrollHandler: ConnectedOverlayScrollHandler;
-    documentResizeListener: () => void | null;
+    panel: Nullable<HTMLDivElement>;
+    meter: Nullable<Meter>;
+    info: Nullable<HTMLDivElement>;
+    filled: Nullable<boolean>;
+    scrollHandler: Nullable<ConnectedOverlayScrollHandler>;
+    documentResizeListener: VoidListener;
     constructor(document: Document, platformId: any, renderer: Renderer2, el: ElementRef, zone: NgZone);
     ngDoCheck(): void;
-    onInput(e: any): void;
+    onInput(e: Event): void;
     updateFilledState(): void;
     createPanel(): void;
     showOverlay(): void;
     hideOverlay(): void;
     onFocus(): void;
     onBlur(): void;
-    onKeyup(e: any): void;
+    onKeyup(e: Event): void;
     testStrength(str: string): number;
-    normalize(x: any, y: any): number;
+    normalize(x: number, y: number): number;
     get disabled(): boolean;
     bindScrollListener(): void;
     unbindScrollListener(): void;
@@ -64,72 +94,186 @@ export declare class Password implements AfterContentInit, OnInit {
     private config;
     el: ElementRef;
     overlayService: OverlayService;
-    ariaLabel: string;
-    ariaLabelledBy: string;
-    label: string;
-    disabled: boolean;
-    promptLabel: string;
+    /**
+     * Defines a string that labels the input for accessibility.
+     * @group Props
+     */
+    ariaLabel: string | undefined;
+    /**
+     * Specifies one or more IDs in the DOM that labels the input field.
+     * @group Props
+     */
+    ariaLabelledBy: string | undefined;
+    /**
+     * Label of the input for accessibility.
+     * @group Props
+     */
+    label: string | undefined;
+    /**
+     * Indicates whether the component is disabled or not.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * Text to prompt password entry. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
+    promptLabel: string | undefined;
+    /**
+     * ^(((?=.*[a-z])(?=.*[A-Z]))|((?=.*[a-z])(?=.*[0-9]))|((?=.*[A-Z])(?=.*[0-9])))(?=.{6,}).
+     * @group Props
+     */
     mediumRegex: string;
+    /**
+     * ^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})
+     * @group Props
+     */
     strongRegex: string;
-    weakLabel: string;
-    mediumLabel: string;
-    maxLength: number;
-    strongLabel: string;
-    inputId: string;
+    /**
+     * Text for a weak password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
+    weakLabel: string | undefined;
+    /**
+     * Text for a medium password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
+    mediumLabel: string | undefined;
+    /**
+     * specifies the maximum number of characters allowed in the input element.
+     * @group Props
+     */
+    maxLength: number | undefined;
+    /**
+     * Text for a strong password. Defaults to PrimeNG I18N API configuration.
+     * @group Props
+     */
+    strongLabel: string | undefined;
+    /**
+     * Identifier of the accessible input element.
+     * @group Props
+     */
+    inputId: string | undefined;
+    /**
+     * Whether to show the strength indicator or not.
+     * @group Props
+     */
     feedback: boolean;
-    appendTo: any;
-    toggleMask: boolean;
-    inputStyleClass: string;
+    /**
+     * 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;
+    /**
+     * Whether to show an icon to display the password as plain text.
+     * @group Props
+     */
+    toggleMask: boolean | undefined;
+    /**
+     * Style class of the input field.
+     * @group Props
+     */
+    inputStyleClass: string | undefined;
+    /**
+     * Inline style of the overlay panel element.
+     * @group Props
+     */
     panelStyle: any;
-    panelStyleClass: string;
-    styleClass: string;
+    /**
+     * Style class of the overlay panel element.
+     * @group Props
+     */
+    panelStyleClass: string | undefined;
+    /**
+     * Style class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
     style: any;
+    /**
+     * Inline style of the input field.
+     * @group Props
+     */
     inputStyle: any;
+    /**
+     * Transition options of the show animation.
+     * @group Props
+     */
     showTransitionOptions: string;
+    /**
+     * Transition options of the hide animation.
+     * @group Props
+     */
     hideTransitionOptions: string;
-    placeholder: string;
+    /**
+     * Advisory information to display on input.
+     * @group Props
+     */
+    placeholder: string | undefined;
+    /**
+     * When enabled, a clear icon is displayed to clear the value.
+     * @group Props
+     */
     showClear: boolean;
+    /**
+     * 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 when clear button is clicked.
+     * @group Emits
+     */
+    onClear: EventEmitter<undefined | null>;
     input: ElementRef;
-    onFocus: EventEmitter<any>;
-    onBlur: EventEmitter<any>;
-    onClear: EventEmitter<any>;
-    contentTemplate: TemplateRef<any>;
-    footerTemplate: TemplateRef<any>;
-    headerTemplate: TemplateRef<any>;
-    clearIconTemplate: TemplateRef<any>;
-    hideIconTemplate: TemplateRef<any>;
-    showIconTemplate: TemplateRef<any>;
-    templates: QueryList<any>;
+    contentTemplate: Nullable<TemplateRef<any>>;
+    footerTemplate: Nullable<TemplateRef<any>>;
+    headerTemplate: Nullable<TemplateRef<any>>;
+    clearIconTemplate: Nullable<TemplateRef<any>>;
+    hideIconTemplate: Nullable<TemplateRef<any>>;
+    showIconTemplate: Nullable<TemplateRef<any>>;
+    templates: QueryList<PrimeTemplate>;
     overlayVisible: boolean;
-    meter: any;
-    infoText: string;
+    meter: Nullable<Meter>;
+    infoText: Nullable<string>;
     focused: boolean;
     unmasked: boolean;
-    mediumCheckRegExp: any;
-    strongCheckRegExp: any;
-    resizeListener: VoidFunction | null;
-    scrollHandler: ConnectedOverlayScrollHandler | null;
-    overlay: any;
-    value: string;
+    mediumCheckRegExp: RegExp;
+    strongCheckRegExp: RegExp;
+    resizeListener: VoidListener;
+    scrollHandler: Nullable<ConnectedOverlayScrollHandler>;
+    overlay: HTMLElement | ElementRef | null | undefined;
+    value: Nullable<string>;
     onModelChange: Function;
     onModelTouched: Function;
-    translationSubscription: Subscription;
+    translationSubscription: Nullable<Subscription>;
     constructor(document: Document, platformId: any, renderer: Renderer2, cd: ChangeDetectorRef, config: PrimeNGConfig, el: ElementRef, overlayService: OverlayService);
     ngAfterContentInit(): void;
     ngOnInit(): void;
-    onAnimationStart(event: any): void;
-    onAnimationEnd(event: any): void;
+    onAnimationStart(event: AnimationEvent): void;
+    onAnimationEnd(event: AnimationEvent): void;
     appendContainer(): void;
     alignOverlay(): void;
-    onInput(event: any): void;
+    onInput(event: Event): void;
     onInputFocus(event: Event): void;
     onInputBlur(event: Event): void;
     onKeyDown(event: KeyboardEvent): void;
-    onKeyUp(event: any): void;
-    updateUI(value: any): void;
+    onKeyUp(event: Event): void;
+    updateUI(value: string): void;
     onMaskToggle(): void;
-    onOverlayClick(event: any): void;
-    testStrength(str: any): number;
+    onOverlayClick(event: Event): void;
+    testStrength(str: string): number;
     writeValue(value: any): void;
     registerOnChange(fn: Function): void;
     registerOnTouched(fn: Function): void;