primeng 20.3.0 → 21.0.0-rc.1

package/types/primeng-types-fileupload.d.ts

@@ -0,0 +1,360 @@
+import { HttpEvent } from '@angular/common/http';
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { BadgePassThrough } from 'primeng/types/badge';
+import { ButtonPassThrough } from 'primeng/types/button';
+import { MessagePassThrough } from 'primeng/types/message';
+import { ProgressBarPassThrough } from 'primeng/types/progressbar';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link FileUpload.pt}
+ * @group Interface
+ */
+interface FileUploadPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the input's DOM element.
+     */
+    input?: PassThroughOption<HTMLInputElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the choose button component.
+     */
+    pcChooseButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the upload button component.
+     */
+    pcUploadButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the cancel button component.
+     */
+    pcCancelButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the progress bar component.
+     */
+    pcProgressBar?: ProgressBarPassThrough;
+    /**
+     * Used to pass attributes to the message component.
+     */
+    pcMessage?: MessagePassThrough;
+    /**
+     * Used to pass attributes to the file list's DOM element.
+     */
+    fileList?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the file's DOM element.
+     */
+    file?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the file thumbnail's DOM element.
+     */
+    fileThumbnail?: PassThroughOption<HTMLImageElement, I>;
+    /**
+     * Used to pass attributes to the file info's DOM element.
+     */
+    fileInfo?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the file name's DOM element.
+     */
+    fileName?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the file size's DOM element.
+     */
+    fileSize?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the file badge component.
+     */
+    pcFileBadge?: BadgePassThrough;
+    /**
+     * Used to pass attributes to the file actions's DOM element.
+     */
+    fileActions?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the file remove button component.
+     */
+    pcFileRemoveButton?: ButtonPassThrough;
+    /**
+     * Used to pass attributes to the basic content's DOM element.
+     */
+    basicContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the empty's DOM element.
+     */
+    empty?: PassThroughOption<HTMLElement, I>;
+}
+/**
+ * Defines valid pass-through options in FileUpload.
+ * @see {@link FileUploadPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type FileUploadPassThrough<I = unknown> = PassThrough<I, FileUploadPassThroughOptions<I>>;
+/**
+ * Upload event.
+ * @group Events
+ */
+interface UploadEvent {
+    /**
+     * HTTP event.
+     */
+    originalEvent: HttpEvent<any>;
+}
+/**
+ * Remove uploaded file event.
+ * @group Events
+ */
+interface RemoveUploadedFileEvent {
+    /**
+     * Removed file.
+     */
+    file: any;
+    /**
+     * Uploaded files.
+     */
+    files: any[];
+}
+/**
+ * Form data event.
+ * @group Events
+ */
+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
+ */
+interface FileSendEvent extends UploadEvent, FormDataEvent {
+}
+/**
+ * Callback to invoke before file upload is initialized.
+ * @see {@link FileUpload.onBeforeUpload}
+ * @group Events
+ */
+interface FileBeforeUploadEvent extends FormDataEvent {
+}
+/**
+ * Callback to invoke when file upload is complete.
+ * @see {@link FileUpload.onUpload}
+ * @group Events
+ */
+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
+ */
+interface FileRemoveEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Selected file
+     */
+    file: File;
+}
+/**
+ * Callback to invoke when files are selected.
+ * @see {@link FileUpload.onSelect}
+ * @group Events
+ */
+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
+ */
+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
+ */
+interface FileUploadHandlerEvent {
+    /**
+     * List of selected files.
+     */
+    files: File[];
+}
+/**
+ * Callback to invoke on upload error.
+ * @see {@link FileUpload.onError}
+ * @group Events
+ */
+interface FileUploadErrorEvent {
+    /**
+     * List of selected files.
+     */
+    error?: ErrorEvent;
+    /**
+     * List of selected files.
+     */
+    files: File[];
+}
+/**
+ * Custom header template context.
+ * @group Interface
+ */
+interface FileUploadHeaderTemplateContext {
+    /**
+     * File list.
+     */
+    $implicit: File[];
+    /**
+     * Uploaded files list.
+     */
+    uploadedFiles: File[];
+    /**
+     * Callback to invoke on choose button click.
+     */
+    chooseCallback: () => void;
+    /**
+     * Callback to invoke on clear button click.
+     */
+    clearCallback: () => void;
+    /**
+     * Callback to invoke on upload.
+     */
+    uploadCallback: () => void;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface FileUploadContentTemplateContext {
+    /**
+     * File list.
+     */
+    $implicit: File[];
+    /**
+     * Uploaded files list.
+     */
+    uploadedFiles: File[];
+    /**
+     * Upload progress value (0-100).
+     */
+    progress: number;
+    /**
+     * Status messages about upload process.
+     */
+    messages: any[];
+    /**
+     * Callback to invoke on choose button click.
+     */
+    chooseCallback: () => void;
+    /**
+     * Callback to invoke to remove a file from the list.
+     */
+    removeFileCallback: (event: Event, index: number) => void;
+    /**
+     * Callback to invoke on clear button click.
+     */
+    clearCallback: () => void;
+    /**
+     * Callback to invoke on remove uploaded file.
+     */
+    removeUploadedFileCallback: (index: number) => void;
+}
+/**
+ * Custom file label template context.
+ * @group Interface
+ */
+interface FileUploadFileLabelTemplateContext {
+    /**
+     * File list.
+     */
+    $implicit: File[];
+}
+/**
+ * Defines valid templates in FileUpload.
+ * @group Templates
+ */
+interface FileUploadTemplates {
+    /**
+     * Custom file template.
+     */
+    file(): TemplateRef<void>;
+    /**
+     * Custom file label template.
+     * @param {Object} context - file label template context.
+     */
+    filelabel(context: FileUploadFileLabelTemplateContext): TemplateRef<FileUploadFileLabelTemplateContext>;
+    /**
+     * Custom header template.
+     * @param {Object} context - header template context.
+     */
+    header(context: FileUploadHeaderTemplateContext): TemplateRef<FileUploadHeaderTemplateContext>;
+    /**
+     * Custom content template.
+     * @param {Object} context - content template context.
+     */
+    content(context: FileUploadContentTemplateContext): TemplateRef<FileUploadContentTemplateContext>;
+    /**
+     * Custom toolbar template.
+     */
+    toolbar(): TemplateRef<void>;
+    /**
+     * Custom choose icon template.
+     */
+    chooseicon(): TemplateRef<void>;
+    /**
+     * Custom upload icon template.
+     */
+    uploadicon(): TemplateRef<void>;
+    /**
+     * Custom cancel icon template.
+     */
+    cancelicon(): TemplateRef<void>;
+    /**
+     * Custom empty state template.
+     */
+    empty(): TemplateRef<void>;
+}
+
+export type { FileBeforeUploadEvent, FileProgressEvent, FileRemoveEvent, FileSelectEvent, FileSendEvent, FileUploadContentTemplateContext, FileUploadErrorEvent, FileUploadEvent, FileUploadFileLabelTemplateContext, FileUploadHandlerEvent, FileUploadHeaderTemplateContext, FileUploadPassThrough, FileUploadPassThroughOptions, FileUploadTemplates, FormDataEvent, RemoveUploadedFileEvent, UploadEvent };

package/types/{galleria/index.d.ts → primeng-types-galleria.d.ts}

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -125,6 +126,10 @@ interface GalleriaPassThroughOptions<I = unknown> {
      * Used to pass attributes to the footer's DOM element.
      */
     footer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in Galleria.
@@ -147,87 +152,99 @@ interface GalleriaResponsiveOptions {
      */
     numVisible: number;
 }
+/**
+ * Custom indicator template context.
+ * @group Interface
+ */
+interface GalleriaIndicatorTemplateContext {
+    /**
+     * Index of the indicator.
+     */
+    $implicit: number;
+}
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface GalleriaItemTemplateContext<T = any> {
+    /**
+     * Item instance.
+     */
+    $implicit: T;
+}
+/**
+ * Custom thumbnail template context.
+ * @group Interface
+ */
+interface GalleriaThumbnailTemplateContext<T = any> {
+    /**
+     * Item instance.
+     */
+    $implicit: T;
+}
+/**
+ * Custom caption template context.
+ * @group Interface
+ */
+interface GalleriaCaptionTemplateContext<T = any> {
+    /**
+     * Item instance.
+     */
+    $implicit: T;
+}
 /**
  * Defines valid templates in Galleria.
  * @group Templates
  */
 interface GalleriaTemplates {
     /**
-     * Custom template of header.
+     * Custom header template.
      */
-    header(): TemplateRef<any>;
+    header(): TemplateRef<void>;
     /**
-     * Custom template of footer.
+     * Custom footer template.
      */
-    footer(): TemplateRef<any>;
+    footer(): TemplateRef<void>;
     /**
-     * Custom template of indicator.
-     * @param {Object} context - indicator data.
+     * Custom indicator template.
+     * @param {Object} context - indicator context.
      */
-    indicator(context: {
-        /**
-         * Index of the item.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    indicator(context: GalleriaIndicatorTemplateContext): TemplateRef<GalleriaIndicatorTemplateContext>;
     /**
-     * Custom template of closeicon.
+     * Custom close icon template.
      */
-    closeicon(): TemplateRef<any>;
+    closeicon(): TemplateRef<void>;
     /**
-     * Custom template of itemnexticon.
+     * Custom item next icon template.
      */
-    itemnexticon(): TemplateRef<any>;
+    itemnexticon(): TemplateRef<void>;
     /**
-     * Custom template of itempreviousicon.
+     * Custom item previous icon template.
      */
-    itempreviousicon(): TemplateRef<any>;
+    itempreviousicon(): TemplateRef<void>;
     /**
-     * Custom template of previousthumbnailicon.
+     * Custom previous thumbnail icon template.
      */
-    previousthumbnailicon(): TemplateRef<any>;
+    previousthumbnailicon(): TemplateRef<void>;
     /**
-     * Custom template of nextthumbnailicon.
+     * Custom next thumbnail icon template.
      */
-    nextthumbnailicon(): TemplateRef<any>;
+    nextthumbnailicon(): TemplateRef<void>;
     /**
-     * Custom template of caption.
-     * @param {Object} context - item data.
+     * Custom caption template.
+     * @param {Object} context - caption context.
      */
-    caption(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    caption(context: GalleriaCaptionTemplateContext): TemplateRef<GalleriaCaptionTemplateContext>;
     /**
-     * Custom template of thumbnail.
-     * @param {Object} context - item data.
+     * Custom thumbnail template.
+     * @param {Object} context - thumbnail context.
      */
-    thumbnail(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    thumbnail(context: GalleriaThumbnailTemplateContext): TemplateRef<GalleriaThumbnailTemplateContext>;
     /**
-     * Custom template of item.
-     * @param {Object} context - item data.
+     * Custom item template.
+     * @param {Object} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    item(context: GalleriaItemTemplateContext): TemplateRef<GalleriaItemTemplateContext>;
 }
 
-export type { GalleriaPassThrough, GalleriaPassThroughOptions, GalleriaResponsiveOptions, GalleriaTemplates };
+export type { GalleriaCaptionTemplateContext, GalleriaIndicatorTemplateContext, GalleriaItemTemplateContext, GalleriaPassThrough, GalleriaPassThroughOptions, GalleriaResponsiveOptions, GalleriaTemplates, GalleriaThumbnailTemplateContext };