primenglab 22.0.0-beta.1

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

@@ -0,0 +1,416 @@
+import { HttpEvent } from '@angular/common/http';
+import { TemplateRef } from '@angular/core';
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+import { BadgePassThrough } from 'primenglab/types/badge';
+import { ButtonPassThrough } from 'primenglab/types/button';
+import { MessageSeverity, MessagePassThrough } from 'primenglab/types/message';
+import { ProgressBarPassThrough } from 'primenglab/types/progressbar';
+
+/**
+ * Message displayed in FileUpload component.
+ * @group Interface
+ */
+interface FileUploadMessage {
+    /**
+     * Severity of the message.
+     */
+    severity: MessageSeverity;
+    /**
+     * Text content of the message.
+     */
+    text: string;
+}
+/**
+ * Event emitted from FileContent component when a file is removed.
+ * @group Interface
+ */
+interface FileContentRemoveEvent {
+    /**
+     * Browser event.
+     */
+    event: Event;
+    /**
+     * Index of the removed file.
+     */
+    index: number;
+}
+/**
+ * Context for file remove icon template.
+ * @group Interface
+ */
+interface FileRemoveIconTemplateContext {
+    /**
+     * CSS class for the icon.
+     */
+    class: string;
+    /**
+     * File being removed.
+     */
+    file: File;
+    /**
+     * Index of the file.
+     */
+    index: number;
+}
+/**
+ * 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: FileList | 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: FileUploadMessage[];
+    /**
+     * 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 template context.
+ * @group Interface
+ */
+interface FileUploadFileTemplateContext {
+    /**
+     * The file.
+     */
+    $implicit: File;
+}
+/**
+ * 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, FileContentRemoveEvent, FileProgressEvent, FileRemoveEvent, FileRemoveIconTemplateContext, FileSelectEvent, FileSendEvent, FileUploadContentTemplateContext, FileUploadErrorEvent, FileUploadEvent, FileUploadFileLabelTemplateContext, FileUploadFileTemplateContext, FileUploadHandlerEvent, FileUploadHeaderTemplateContext, FileUploadMessage, FileUploadPassThrough, FileUploadPassThroughOptions, FileUploadTemplates, FormDataEvent, RemoveUploadedFileEvent, UploadEvent };

package/types/primenglab-types-floatlabel.d.ts

@@ -0,0 +1,27 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+type FloatLabelVariant = 'in' | 'over' | 'on';
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link FloatLabel.pt}
+ * @group Interface
+ */
+interface FloatLabelPassThroughOptions<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<HTMLSpanElement, I>;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type FloatLabelPassThrough<I = unknown> = PassThrough<I, FloatLabelPassThroughOptions<I>>;
+
+export type { FloatLabelPassThrough, FloatLabelPassThroughOptions, FloatLabelVariant };

package/types/primenglab-types-fluid.d.ts

@@ -0,0 +1,28 @@
+import { PassThrough, PassThroughOption } from 'primenglab/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Fluid.pt}
+ * @group Interface
+ */
+interface FluidPassThroughOptions<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>;
+}
+/**
+ * Defines valid pass-through options in Fluid component.
+ * @see {@link FluidPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type FluidPassThrough<I = unknown> = PassThrough<I, FluidPassThroughOptions<I>>;
+
+export type { FluidPassThrough, FluidPassThroughOptions };