primeng 16.0.0-rc.1 → 16.0.0

package/fileupload/fileupload.d.ts

@@ -1,8 +1,10 @@
 import { HttpClient, HttpHeaders } from '@angular/common/http';
 import { AfterContentInit, AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnDestroy, OnInit, QueryList, Renderer2, TemplateRef } from '@angular/core';
 import { DomSanitizer } from '@angular/platform-browser';
-import { BlockableUI, Message, PrimeNGConfig } from 'primeng/api';
+import { BlockableUI, Message, PrimeNGConfig, PrimeTemplate } from 'primeng/api';
+import { VoidListener } from 'primeng/ts-helpers';
 import { Subscription } from 'rxjs';
+import { FileBeforeUploadEvent, FileProgressEvent, FileRemoveEvent, FileSelectEvent, FileSendEvent, FileUploadErrorEvent, FileUploadEvent, FileUploadHandlerEvent } from './fileupload.interface';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
 import * as i2 from "@angular/common/http";
@@ -14,6 +16,10 @@ import * as i7 from "primeng/ripple";
 import * as i8 from "primeng/icons/plus";
 import * as i9 from "primeng/icons/upload";
 import * as i10 from "primeng/icons/times";
+/**
+ * FileUpload is an advanced uploader with dragdrop support, multi file uploads, auto uploading, progress tracking and validations.
+ * @group Components
+ */
 export declare class FileUpload implements AfterViewInit, AfterContentInit, OnInit, OnDestroy, BlockableUI {
     private document;
     private platformId;
@@ -24,73 +30,261 @@ export declare class FileUpload implements AfterViewInit, AfterContentInit, OnIn
     private http;
     cd: ChangeDetectorRef;
     config: PrimeNGConfig;
-    name: string;
-    url: string;
-    method: string;
-    multiple: boolean;
-    accept: string;
-    disabled: boolean;
-    auto: boolean;
-    withCredentials: boolean;
-    maxFileSize: number;
+    /**
+     * Name of the request parameter to identify the files at backend.
+     * @group Props
+     */
+    name: string | undefined;
+    /**
+     * Remote url to upload the files.
+     * @group Props
+     */
+    url: string | undefined;
+    /**
+     * HTTP method to send the files to the url such as "post" and "put".
+     * @group Props
+     */
+    method: 'post' | 'put' | undefined;
+    /**
+     * Used to select multiple files at once from file dialog.
+     * @group Props
+     */
+    multiple: boolean | undefined;
+    /**
+     * Pattern to restrict the allowed file types such as 'image/*'.
+     * @group Props
+     */
+    accept: string | undefined;
+    /**
+     * Disables the upload functionality.
+     * @group Props
+     */
+    disabled: boolean | undefined;
+    /**
+     * When enabled, upload begins automatically after selection is completed.
+     * @group Props
+     */
+    auto: boolean | undefined;
+    /**
+     * Cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates.
+     * @group Props
+     */
+    withCredentials: boolean | undefined;
+    /**
+     * Maximum file size allowed in bytes.
+     * @group Props
+     */
+    maxFileSize: number | undefined;
+    /**
+     * Summary message of the invalid file size.
+     * @group Props
+     */
     invalidFileSizeMessageSummary: string;
+    /**
+     * Detail message of the invalid file size.
+     * @group Props
+     */
     invalidFileSizeMessageDetail: string;
+    /**
+     * Summary message of the invalid file type.
+     * @group Props
+     */
     invalidFileTypeMessageSummary: string;
+    /**
+     * Detail message of the invalid file type.
+     * @group Props
+     */
     invalidFileTypeMessageDetail: string;
+    /**
+     * Detail message of the invalid file type.
+     * @group Props
+     */
     invalidFileLimitMessageDetail: string;
+    /**
+     * Summary message of the invalid file type.
+     * @group Props
+     */
     invalidFileLimitMessageSummary: string;
-    style: any;
-    styleClass: string;
+    /**
+     * Inline style of the element.
+     * @group Props
+     */
+    style: {
+        [klass: string]: any;
+    } | null | undefined;
+    /**
+     * Class of the element.
+     * @group Props
+     */
+    styleClass: string | undefined;
+    /**
+     * Width of the image thumbnail in pixels.
+     * @group Props
+     */
     previewWidth: number;
-    chooseLabel: string;
-    uploadLabel: string;
-    cancelLabel: string;
-    chooseIcon: string;
-    uploadIcon: string;
-    cancelIcon: string;
+    /**
+     * Label of the choose button. Defaults to PrimeVue Locale configuration.
+     * @group Props
+     */
+    chooseLabel: string | undefined;
+    /**
+     * Label of the upload button. Defaults to PrimeVue Locale configuration.
+     * @group Props
+     */
+    uploadLabel: string | undefined;
+    /**
+     * Label of the cancel button. Defaults to PrimeVue Locale configuration.
+     * @group Props
+     */
+    cancelLabel: string | undefined;
+    /**
+     * Icon of the choose button.
+     * @group Props
+     */
+    chooseIcon: string | undefined;
+    /**
+     * Icon of the upload button.
+     * @group Props
+     */
+    uploadIcon: string | undefined;
+    /**
+     * Icon of the cancel button.
+     * @group Props
+     */
+    cancelIcon: string | undefined;
+    /**
+     * Whether to show the upload button.
+     * @group Props
+     */
     showUploadButton: boolean;
+    /**
+     * Whether to show the cancel button.
+     * @group Props
+     */
     showCancelButton: boolean;
-    mode: string;
-    headers: HttpHeaders;
-    customUpload: boolean;
-    fileLimit: number;
-    uploadStyleClass: string;
-    cancelStyleClass: string;
-    removeStyleClass: string;
-    chooseStyleClass: string;
-    onBeforeUpload: EventEmitter<any>;
-    onSend: EventEmitter<any>;
-    onUpload: EventEmitter<any>;
-    onError: EventEmitter<any>;
-    onClear: EventEmitter<any>;
-    onRemove: EventEmitter<any>;
-    onSelect: EventEmitter<any>;
-    onProgress: EventEmitter<any>;
-    uploadHandler: EventEmitter<any>;
-    onImageError: EventEmitter<any>;
-    templates: QueryList<any>;
-    advancedFileInput: ElementRef;
-    basicFileInput: ElementRef;
-    content: ElementRef;
+    /**
+     * Defines the UI of the component.
+     * @group Props
+     */
+    mode: 'advanced' | 'basic' | undefined;
+    /**
+     * HttpHeaders class represents the header configuration options for an HTTP request.
+     * @group Props
+     */
+    headers: HttpHeaders | undefined;
+    /**
+     * Whether to use the default upload or a manual implementation defined in uploadHandler callback. Defaults to PrimeNG Locale configuration.
+     * @group Props
+     */
+    customUpload: boolean | undefined;
+    /**
+     * Maximum number of files that can be uploaded.
+     * @group Props
+     */
+    fileLimit: number | undefined;
+    /**
+     * Style class of the upload button.
+     * @group Props
+     */
+    uploadStyleClass: string | undefined;
+    /**
+     * Style class of the cancel button.
+     * @group Props
+     */
+    cancelStyleClass: string | undefined;
+    /**
+     * Style class of the remove button.
+     * @group Props
+     */
+    removeStyleClass: string | undefined;
+    /**
+     * Style class of the choose button.
+     * @group Props
+     */
+    chooseStyleClass: string | undefined;
+    /**
+     * Callback to invoke before file upload is initialized.
+     * @param {FileBeforeUploadEvent} event - Custom upload event.
+     * @group Emits
+     */
+    onBeforeUpload: EventEmitter<FileBeforeUploadEvent>;
+    /**
+     * An event indicating that the request was sent to the server. Useful when a request may be retried multiple times, to distinguish between retries on the final event stream.
+     * @param {FileSendEvent} event - Custom send event.
+     * @group Emits
+     */
+    onSend: EventEmitter<FileSendEvent>;
+    /**
+     * Callback to invoke when file upload is complete.
+     * @param {FileUploadEvent} event - Custom upload event.
+     * @group Emits
+     */
+    onUpload: EventEmitter<FileUploadEvent>;
+    /**
+     * Callback to invoke if file upload fails.
+     * @param {FileUploadErrorEvent} event - Custom error event.
+     * @group Emits
+     */
+    onError: EventEmitter<FileUploadErrorEvent>;
+    /**
+     * Callback to invoke when files in queue are removed without uploading using clear all button.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onClear: EventEmitter<Event>;
+    /**
+     * Callback to invoke when a file is removed without uploading using clear button of a file.
+     * @param {FileRemoveEvent} event - Remove event.
+     * @group Emits
+     */
+    onRemove: EventEmitter<FileRemoveEvent>;
+    /**
+     * Callback to invoke when files are selected.
+     * @param {FileSelectEvent} event - Select event.
+     * @group Emits
+     */
+    onSelect: EventEmitter<FileSelectEvent>;
+    /**
+     * Callback to invoke when files are being uploaded.
+     * @param {FileProgressEvent} event - Progress event.
+     * @group Emits
+     */
+    onProgress: EventEmitter<FileProgressEvent>;
+    /**
+     * Callback to invoke in custom upload mode to upload the files manually.
+     * @param {FileUploadHandlerEvent} event - Upload handler event.
+     * @group Emits
+     */
+    uploadHandler: EventEmitter<FileUploadHandlerEvent>;
+    /**
+     * This event is triggered if an error occurs while loading an image file.
+     * @param {Event} event - Browser event.
+     * @group Emits
+     */
+    onImageError: EventEmitter<Event>;
+    templates: QueryList<PrimeTemplate> | undefined;
+    advancedFileInput: ElementRef | undefined | any;
+    basicFileInput: ElementRef | undefined;
+    content: ElementRef | undefined;
     set files(files: File[]);
     get files(): File[];
     get basicButtonLabel(): string;
     _files: File[];
     progress: number;
-    dragHighlight: boolean;
-    msgs: Message[];
-    fileTemplate: TemplateRef<any>;
-    contentTemplate: TemplateRef<any>;
-    toolbarTemplate: TemplateRef<any>;
-    chooseIconTemplate: TemplateRef<any>;
-    uploadIconTemplate: TemplateRef<any>;
-    cancelIconTemplate: TemplateRef<any>;
+    dragHighlight: boolean | undefined;
+    msgs: Message[] | undefined;
+    fileTemplate: TemplateRef<any> | undefined;
+    contentTemplate: TemplateRef<any> | undefined;
+    toolbarTemplate: TemplateRef<any> | undefined;
+    chooseIconTemplate: TemplateRef<any> | undefined;
+    uploadIconTemplate: TemplateRef<any> | undefined;
+    cancelIconTemplate: TemplateRef<any> | undefined;
     uploadedFileCount: number;
-    focus: boolean;
-    uploading: boolean;
-    duplicateIEEvent: boolean;
-    translationSubscription: Subscription;
-    dragOverListener: () => void | null;
+    focus: boolean | undefined;
+    uploading: boolean | undefined;
+    duplicateIEEvent: boolean | undefined;
+    translationSubscription: Subscription | undefined;
+    dragOverListener: VoidListener;
     constructor(document: Document, platformId: any, renderer: Renderer2, el: ElementRef, sanitizer: DomSanitizer, zone: NgZone, http: HttpClient, cd: ChangeDetectorRef, config: PrimeNGConfig);
     ngAfterContentInit(): void;
     ngOnInit(): void;
@@ -106,7 +300,15 @@ export declare class FileUpload implements AfterViewInit, AfterContentInit, OnIn
     getFileExtension(file: File): string;
     isImage(file: File): boolean;
     onImageLoad(img: any): void;
+    /**
+     * Uploads the selected files.
+     * @group Method
+     */
     upload(): void;
+    /**
+     * Clears the files list.
+     * @group Method
+     */
     clear(): void;
     remove(event: Event, index: number): void;
     isFileLimitExceeded(): boolean;
@@ -115,16 +317,16 @@ export declare class FileUpload implements AfterViewInit, AfterContentInit, OnIn
     clearInputElement(): void;
     clearIEInput(): void;
     hasFiles(): boolean;
-    onDragEnter(e: any): void;
-    onDragOver(e: any): void;
-    onDragLeave(event: any): void;
+    onDragEnter(e: DragEvent): void;
+    onDragOver(e: DragEvent): void;
+    onDragLeave(event: DragEvent): void;
     onDrop(event: any): void;
     onFocus(): void;
     onBlur(): void;
-    formatSize(bytes: any): string;
+    formatSize(bytes: number): string;
     onBasicUploaderClick(): void;
     onBasicKeydown(event: KeyboardEvent): void;
-    imageError(event: any): void;
+    imageError(event: Event): void;
     getBlockableElement(): HTMLElement;
     get chooseButtonLabel(): string;
     get uploadButtonLabel(): string;

package/fileupload/fileupload.interface.d.ts

@@ -0,0 +1,156 @@
+import { HttpEvent } from '@angular/common/http';
+import { TemplateRef } from '@angular/core';
+/**
+ * Upload event.
+ * @group Events
+ */
+export interface UploadEvent {
+    /**
+     * HTTP event.
+     */
+    originalEvent: HttpEvent<any>;
+}
+/**
+ * Form data event.
+ * @group Events
+ */
+export interface FormDataEvent {
+    /**
+     * FormData object.
+     */
+    formData: FormData;
+}
+/**
+ * An event indicating that the request was sent to the server. Useful when a request may be retried multiple times, to distinguish between retries on the final event stream.
+ * @see {@link FileUpload.onSend}
+ * @group Events
+ */
+export interface FileSendEvent extends UploadEvent, FormDataEvent {
+}
+/**
+ * Callback to invoke before file upload is initialized.
+ * @see {@link FileUpload.onBeforeUpload}
+ * @group Events
+ */
+export interface FileBeforeUploadEvent extends FormDataEvent {
+}
+/**
+ * Callback to invoke when file upload is complete.
+ * @see {@link FileUpload.onUpload}
+ * @group Events
+ */
+export interface FileUploadEvent extends UploadEvent {
+    /**
+     * Uploaded files.
+     */
+    files: File[];
+}
+/**
+ * Callback to invoke when a file is removed without uploading using clear button of a file.
+ * @see {@link FileUpload.onRemove}
+ * @group Events
+ */
+export interface FileRemoveEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected file
+     */
+    file: File;
+}
+/**
+ * Callback to invoke when files are selected.
+ * @see {@link FileUpload.onSelect}
+ * @group Events
+ */
+export interface FileSelectEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Uploaded files.
+     */
+    files: File[];
+    /**
+     * All files to be uploaded.
+     */
+    currentFiles: File[];
+}
+/**
+ * Callback to invoke when files are being uploaded.
+ * @see {@link FileUpload.onProgress}
+ * @extends {UploadEvent}
+ * @group Events
+ */
+export interface FileProgressEvent extends UploadEvent {
+    /**
+     * Calculated progress value.
+     */
+    progress: number;
+}
+/**
+ * Callback to invoke in custom upload mode to upload the files manually.
+ * @see {@link FileUpload.uploadHandler}
+ * @group Events
+ */
+export interface FileUploadHandlerEvent {
+    /**
+     * List of selected files.
+     */
+    files: File[];
+}
+/**
+ * Callback to invoke on upload error.
+ * @see {@link FileUpload.onError}
+ * @group Events
+ */
+export interface FileUploadErrorEvent {
+    /**
+     * List of selected files.
+     */
+    error?: ErrorEvent;
+    /**
+     * List of selected files.
+     */
+    files: File[];
+}
+/**
+ * Defines valid templates in FileUpload.
+ * @group Templates
+ */
+export interface FileUploadTemplates {
+    /**
+     * Custom template of file.
+     */
+    file(): TemplateRef<any>;
+    /**
+     * Custom template of content.
+     */
+    content(context: {
+        /**
+         * File list.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of toolbar.
+     */
+    toolbar(): TemplateRef<any>;
+    /**
+     * Custom template of chooseicon.
+     */
+    chooseicon(): TemplateRef<any>;
+    /**
+     * Custom template of uploadicon.
+     */
+    uploadicon(): TemplateRef<any>;
+    /**
+     * Custom template of cancelicon.
+     */
+    cancelicon(): TemplateRef<any>;
+}

package/fileupload/public_api.d.ts

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

package/focustrap/focustrap.d.ts

@@ -1,11 +1,19 @@
 import { ElementRef } from '@angular/core';
 import * as i0 from "@angular/core";
 import * as i1 from "@angular/common";
+/**
+ * Focus Trap keeps focus within a certain DOM element while tabbing.
+ * @group Components
+ */
 export declare class FocusTrap {
     el: ElementRef;
+    /**
+     * When set as true, focus wouldn't be managed.
+     * @group Props
+     */
     pFocusTrapDisabled: boolean;
     constructor(el: ElementRef);
-    onkeydown(e: any): void;
+    onkeydown(e: KeyboardEvent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<FocusTrap, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<FocusTrap, "[pFocusTrap]", never, { "pFocusTrapDisabled": { "alias": "pFocusTrapDisabled"; "required": false; }; }, {}, never, never, false, never>;
 }