primeng 20.1.2 → 20.3.0-rc.1

package/types/galleria/index.d.ts

@@ -0,0 +1,233 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Galleria.pt}
+ * @group Interface
+ */
+interface GalleriaPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the host's DOM element.
+     */
+    host?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the close icon's DOM element.
+     */
+    closeIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the header's DOM element.
+     */
+    header?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the items container's DOM element.
+     */
+    itemsContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the items's DOM element.
+     */
+    items?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the previous button's DOM element.
+     */
+    prevButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the previous icon's DOM element.
+     */
+    prevIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the item's DOM element.
+     */
+    item?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the next button's DOM element.
+     */
+    nextButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the next icon's DOM element.
+     */
+    nextIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the caption's DOM element.
+     */
+    caption?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the indicator list's DOM element.
+     */
+    indicatorList?: PassThroughOption<HTMLUListElement, I>;
+    /**
+     * Used to pass attributes to the indicator's DOM element.
+     */
+    indicator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass attributes to the indicator button's DOM element.
+     */
+    indicatorButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the thumbnails's DOM element.
+     */
+    thumbnails?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail content's DOM element.
+     */
+    thumbnailContent?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail previous button's DOM element.
+     */
+    thumbnailPrevButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail previous icon's DOM element.
+     */
+    thumbnailPrevIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the thumbnails viewport's DOM element.
+     */
+    thumbnailsViewport?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail items's DOM element.
+     */
+    thumbnailItems?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail item's DOM element.
+     */
+    thumbnailItem?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail's DOM element.
+     */
+    thumbnail?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail next button's DOM element.
+     */
+    thumbnailNextButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the thumbnail next icon's DOM element.
+     */
+    thumbnailNextIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the footer's DOM element.
+     */
+    footer?: PassThroughOption<HTMLDivElement, I>;
+}
+/**
+ * Defines valid pass-through options in Galleria.
+ * @see {@link GalleriaPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type GalleriaPassThrough<I = unknown> = PassThrough<I, GalleriaPassThroughOptions<I>>;
+/**
+ * Responsive options of the component.
+ * @group Interface
+ */
+interface GalleriaResponsiveOptions {
+    /**
+     * Breakpoint for responsive mode. Exp; @media screen and (max-width: ${breakpoint}) {...}
+     */
+    breakpoint: string;
+    /**
+     * The number of visible items on breakpoint.
+     */
+    numVisible: number;
+}
+/**
+ * Defines valid templates in Galleria.
+ * @group Templates
+ */
+interface GalleriaTemplates {
+    /**
+     * Custom template of header.
+     */
+    header(): TemplateRef<any>;
+    /**
+     * Custom template of footer.
+     */
+    footer(): TemplateRef<any>;
+    /**
+     * Custom template of indicator.
+     * @param {Object} context - indicator data.
+     */
+    indicator(context: {
+        /**
+         * Index of the item.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon(): TemplateRef<any>;
+    /**
+     * Custom template of itemnexticon.
+     */
+    itemnexticon(): TemplateRef<any>;
+    /**
+     * Custom template of itempreviousicon.
+     */
+    itempreviousicon(): TemplateRef<any>;
+    /**
+     * Custom template of previousthumbnailicon.
+     */
+    previousthumbnailicon(): TemplateRef<any>;
+    /**
+     * Custom template of nextthumbnailicon.
+     */
+    nextthumbnailicon(): TemplateRef<any>;
+    /**
+     * Custom template of caption.
+     * @param {Object} context - item data.
+     */
+    caption(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of thumbnail.
+     * @param {Object} context - item data.
+     */
+    thumbnail(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+    /**
+     * Custom template of item.
+     * @param {Object} context - item data.
+     */
+    item(context: {
+        /**
+         * Item instance.
+         */
+        $implicit: any;
+    }): TemplateRef<{
+        $implicit: any;
+    }>;
+}
+
+export type { GalleriaPassThrough, GalleriaPassThroughOptions, GalleriaResponsiveOptions, GalleriaTemplates };

package/types/iconfield/index.d.ts

@@ -0,0 +1,26 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link IconField.pt}
+ * @group Interface
+ */
+interface IconFieldPassThroughOptions<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 IconFieldPassThrough<I = unknown> = PassThrough<I, IconFieldPassThroughOptions<I>>;
+
+export type { IconFieldPassThrough, IconFieldPassThroughOptions };

package/types/iftalabel/index.d.ts

@@ -0,0 +1,26 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link IftaLabel.pt}
+ * @group Interface
+ */
+interface IftaLabelPassThroughOptions<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 IftaLabelPassThrough<I = unknown> = PassThrough<I, IftaLabelPassThroughOptions<I>>;
+
+export type { IftaLabelPassThrough, IftaLabelPassThroughOptions };

package/types/image/index.d.ts

@@ -0,0 +1,193 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Image.pt}
+ * @group Interface
+ */
+interface ImagePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLSpanElement, I>;
+    /**
+     * Used to pass attributes to the image's DOM element.
+     */
+    image?: PassThroughOption<HTMLImageElement, I>;
+    /**
+     * Used to pass attributes to the preview mask button's DOM element.
+     */
+    previewMask?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the preview icon's DOM element.
+     */
+    previewIcon?: PassThroughOption<SVGElement, I>;
+    /**
+     * Used to pass attributes to the mask's DOM element.
+     */
+    mask?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the toolbar's DOM element.
+     */
+    toolbar?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the rotate right button's DOM element.
+     */
+    rotateRightButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the rotate left button's DOM element.
+     */
+    rotateLeftButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the zoom out button's DOM element.
+     */
+    zoomOutButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the zoom in button's DOM element.
+     */
+    zoomInButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the close button's DOM element.
+     */
+    closeButton?: PassThroughOption<HTMLButtonElement, I>;
+    /**
+     * Used to pass attributes to the original/preview image's DOM element.
+     */
+    original?: PassThroughOption<HTMLImageElement, I>;
+}
+/**
+ * Defines valid pass-through options in Image.
+ * @see {@link ImagePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ImagePassThrough<I = unknown> = PassThrough<I, ImagePassThroughOptions<I>>;
+/**
+ * Defines valid templates in Image.
+ * @group Templates
+ */
+interface ImageTemplates {
+    /**
+     * Custom template of indicator.
+     */
+    indicator(): TemplateRef<any>;
+    /**
+     * Custom template of image.
+     */
+    image(context: {
+        /**
+         * Style class of the image element.
+         */
+        class: any;
+        /**
+         * Style of the image element.
+         */
+        style: any;
+        /**
+         * Image click function.
+         */
+        errorCallback: Function;
+    }): TemplateRef<{
+        class: any;
+        style: any;
+        errorCallback: Function;
+    }>;
+    /**
+     * Custom preview template.
+     */
+    preview(context: {
+        /**
+         * Preview click function.
+         */
+        errorCallback: Function;
+    }): TemplateRef<{
+        errorCallback: Function;
+    }>;
+    /**
+     * Custom template of rotaterighticon.
+     */
+    rotaterighticon(): TemplateRef<any>;
+    /**
+     * Custom template of rotatelefticon.
+     */
+    rotatelefticon(): TemplateRef<any>;
+    /**
+     * Custom template of zoomouticon.
+     */
+    zoomouticon(): TemplateRef<any>;
+    /**
+     * Custom template of zoominicon.
+     */
+    zoominicon(): TemplateRef<any>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon(): TemplateRef<any>;
+}
+/**
+ * Defines valid templates in Image.
+ * @group Templates
+ */
+interface ImageTemplates {
+    /**
+     * Custom template of indicator.
+     */
+    indicator(): TemplateRef<any>;
+    /**
+     * Custom template of image.
+     */
+    image(context: {
+        /**
+         * Style class of the image element.
+         */
+        class: any;
+        /**
+         * Style of the image element.
+         */
+        style: any;
+        /**
+         * Image click function.
+         */
+        errorCallback: Function;
+    }): TemplateRef<{
+        class: any;
+        style: any;
+        errorCallback: Function;
+    }>;
+    /**
+     * Custom preview template.
+     */
+    preview(context: {
+        /**
+         * Preview click function.
+         */
+        errorCallback: Function;
+    }): TemplateRef<{
+        errorCallback: Function;
+    }>;
+    /**
+     * Custom template of rotaterighticon.
+     */
+    rotaterighticon(): TemplateRef<any>;
+    /**
+     * Custom template of rotatelefticon.
+     */
+    rotatelefticon(): TemplateRef<any>;
+    /**
+     * Custom template of zoomouticon.
+     */
+    zoomouticon(): TemplateRef<any>;
+    /**
+     * Custom template of zoominicon.
+     */
+    zoominicon(): TemplateRef<any>;
+    /**
+     * Custom template of closeicon.
+     */
+    closeicon(): TemplateRef<any>;
+}
+
+export type { ImagePassThrough, ImagePassThroughOptions, ImageTemplates };

package/types/imagecompare/index.d.ts

@@ -0,0 +1,28 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link ImageCompare.pt}
+ * @group Interface
+ */
+interface ImageComparePassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the slider's DOM element.
+     */
+    slider?: PassThroughOption<HTMLInputElement, I>;
+}
+/**
+ * Defines valid pass-through options in ImageCompare.
+ * @see {@link ImageComparePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type ImageComparePassThrough<I = unknown> = PassThrough<I, ImageComparePassThroughOptions<I>>;
+
+export type { ImageComparePassThrough, ImageComparePassThroughOptions };

package/types/inplace/index.d.ts

@@ -0,0 +1,61 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { ButtonPassThrough } from 'primeng/types/button';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link Inplace.pt}
+ * @group Interface
+ */
+interface InplacePassThroughOptions<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 display's DOM element.
+     */
+    display?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the Button component.
+     * @see {@link ButtonPassThrough}
+     */
+    pcButton?: ButtonPassThrough;
+}
+/**
+ * Defines valid pass-through options in Inplace.
+ * @see {@link InplacePassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type InplacePassThrough<I = unknown> = PassThrough<I, InplacePassThroughOptions<I>>;
+/**
+ * Defines valid templates in Inplace.
+ * @group Templates
+ */
+interface InplaceTemplates {
+    /**
+     * Custom template of display.
+     */
+    display(): TemplateRef<any>;
+    /**
+     * Custom template of content.
+     */
+    content(): TemplateRef<any>;
+    /**
+     * Custom template of close icon.
+     */
+    closeicon(): TemplateRef<any>;
+}
+
+export type { InplacePassThrough, InplacePassThroughOptions, InplaceTemplates };

package/types/inputgroup/index.d.ts

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

package/types/inputgroupaddon/index.d.ts

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

package/types/inputicon/index.d.ts

@@ -0,0 +1,26 @@
+import { PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputIcon.pt}
+ * @group Interface
+ */
+interface InputIconPassThroughOptions<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 InputIconPassThrough<I = unknown> = PassThrough<I, InputIconPassThroughOptions<I>>;
+
+export type { InputIconPassThrough, InputIconPassThroughOptions };