primeng 20.3.0 → 21.0.0-rc.1

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

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -57,6 +58,10 @@ interface ImagePassThroughOptions<I = unknown> {
      * Used to pass attributes to the original/preview image's DOM element.
      */
     original?: PassThroughOption<HTMLImageElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in Image.
@@ -66,66 +71,34 @@ interface ImagePassThroughOptions<I = unknown> {
  */
 type ImagePassThrough<I = unknown> = PassThrough<I, ImagePassThroughOptions<I>>;
 /**
- * Defines valid templates in Image.
- * @group Templates
+ * Custom image template context.
+ * @group Interface
  */
-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;
-    }>;
+interface ImageImageTemplateContext {
     /**
-     * Custom template of rotaterighticon.
+     * Callback to invoke on image error.
      */
-    rotaterighticon(): TemplateRef<any>;
-    /**
-     * Custom template of rotatelefticon.
-     */
-    rotatelefticon(): TemplateRef<any>;
+    errorCallback: (event: Event) => void;
+}
+/**
+ * Custom preview template context.
+ * @group Interface
+ */
+interface ImagePreviewTemplateContext {
     /**
-     * Custom template of zoomouticon.
+     * Style class of the preview image element.
      */
-    zoomouticon(): TemplateRef<any>;
+    class: string;
     /**
-     * Custom template of zoominicon.
+     * Inline style of the preview image element.
      */
-    zoominicon(): TemplateRef<any>;
+    style: {
+        [key: string]: any;
+    };
     /**
-     * Custom template of closeicon.
+     * Callback to invoke on preview image click.
      */
-    closeicon(): TemplateRef<any>;
+    previewCallback: () => void;
 }
 /**
  * Defines valid templates in Image.
@@ -133,61 +106,39 @@ interface ImageTemplates {
  */
 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 indicator template.
+     */
+    indicator(): TemplateRef<void>;
+    /**
+     * Custom image template.
+     * @param {Object} context - image context.
+     */
+    image(context: ImageImageTemplateContext): TemplateRef<ImageImageTemplateContext>;
     /**
      * Custom preview template.
+     * @param {Object} context - preview context.
      */
-    preview(context: {
-        /**
-         * Preview click function.
-         */
-        errorCallback: Function;
-    }): TemplateRef<{
-        errorCallback: Function;
-    }>;
+    preview(context: ImagePreviewTemplateContext): TemplateRef<ImagePreviewTemplateContext>;
     /**
-     * Custom template of rotaterighticon.
+     * Custom rotate right icon template.
      */
-    rotaterighticon(): TemplateRef<any>;
+    rotaterighticon(): TemplateRef<void>;
     /**
-     * Custom template of rotatelefticon.
+     * Custom rotate left icon template.
      */
-    rotatelefticon(): TemplateRef<any>;
+    rotatelefticon(): TemplateRef<void>;
     /**
-     * Custom template of zoomouticon.
+     * Custom zoom out icon template.
      */
-    zoomouticon(): TemplateRef<any>;
+    zoomouticon(): TemplateRef<void>;
     /**
-     * Custom template of zoominicon.
+     * Custom zoom in icon template.
      */
-    zoominicon(): TemplateRef<any>;
+    zoominicon(): TemplateRef<void>;
     /**
-     * Custom template of closeicon.
+     * Custom close icon template.
      */
-    closeicon(): TemplateRef<any>;
+    closeicon(): TemplateRef<void>;
 }
 
-export type { ImagePassThrough, ImagePassThroughOptions, ImageTemplates };
+export type { ImageImageTemplateContext, ImagePassThrough, ImagePassThroughOptions, ImagePreviewTemplateContext, ImageTemplates };

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

@@ -1,3 +1,4 @@
+import { TemplateRef } from '@angular/core';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -24,5 +25,19 @@ interface ImageComparePassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type ImageComparePassThrough<I = unknown> = PassThrough<I, ImageComparePassThroughOptions<I>>;
+/**
+ * Defines valid templates in ImageCompare.
+ * @group Templates
+ */
+interface ImageCompareTemplates {
+    /**
+     * Custom left side template.
+     */
+    left(): TemplateRef<void>;
+    /**
+     * Custom right side template.
+     */
+    right(): TemplateRef<void>;
+}
 
-export type { ImageComparePassThrough, ImageComparePassThroughOptions };
+export type { ImageComparePassThrough, ImageComparePassThroughOptions, ImageCompareTemplates };

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

@@ -39,23 +39,34 @@ interface InplacePassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type InplacePassThrough<I = unknown> = PassThrough<I, InplacePassThroughOptions<I>>;
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface InplaceContentTemplateContext {
+    /**
+     * Callback to invoke to close the inplace content.
+     */
+    closeCallback: (event: MouseEvent) => void;
+}
 /**
  * Defines valid templates in Inplace.
  * @group Templates
  */
 interface InplaceTemplates {
     /**
-     * Custom template of display.
+     * Custom display template.
      */
-    display(): TemplateRef<any>;
+    display(): TemplateRef<void>;
     /**
-     * Custom template of content.
+     * Custom content template.
+     * @param {Object} context - content context.
      */
-    content(): TemplateRef<any>;
+    content(context: InplaceContentTemplateContext): TemplateRef<InplaceContentTemplateContext>;
     /**
-     * Custom template of close icon.
+     * Custom close icon template.
      */
-    closeicon(): TemplateRef<any>;
+    closeicon(): TemplateRef<void>;
 }
 
-export type { InplacePassThrough, InplacePassThroughOptions, InplaceTemplates };
+export type { InplaceContentTemplateContext, InplacePassThrough, InplacePassThroughOptions, InplaceTemplates };

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

@@ -50,7 +50,7 @@ interface InputMaskTemplates {
     /**
      * Custom clear icon template.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
 }
 
 export type { Caret, InputMaskPassThrough, InputMaskPassThroughOptions, InputMaskTemplates };

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

@@ -81,15 +81,15 @@ interface InputNumberTemplates {
     /**
      * Custom clear icon template.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
     /**
      * Custom increment button icon template.
      */
-    incrementbuttonicon(): TemplateRef<any>;
+    incrementbuttonicon(): TemplateRef<void>;
     /**
      * Custom decrement button icon template.
      */
-    decrementbuttonicon(): TemplateRef<any>;
+    decrementbuttonicon(): TemplateRef<void>;
 }
 
 export type { InputNumberInputEvent, InputNumberPassThrough, InputNumberPassThroughOptions, InputNumberTemplates };

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

@@ -0,0 +1,101 @@
+import { TemplateRef } from '@angular/core';
+import { PassThroughOption, PassThrough } from 'primeng/api';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link InputOtp.pt}
+ * @group Interface
+ */
+interface InputOtpPassThroughOptions<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 InputText component.
+     */
+    pcInputText?: InputTextPassThrough;
+}
+/**
+ * Custom passthrough attributes for each DOM elements
+ * @group Interface
+ */
+type InputOtpPassThrough<I = unknown> = PassThrough<I, InputOtpPassThroughOptions<I>>;
+/**
+ * Input change event.
+ * @group Events
+ */
+interface InputOtpChangeEvent {
+    /**
+     * Browser event.
+     */
+    originalEvent: Event;
+    /**
+     * Updated value.
+     */
+    value: any;
+}
+/**
+ * Context interface for the input template events.
+ * @group Interface
+ */
+interface InputOtpTemplateEvents {
+    /**
+     * Input event handler.
+     */
+    input: (event: Event, index: number) => void;
+    /**
+     * Keydown event handler.
+     */
+    keydown: (event: Event) => void;
+    /**
+     * Focus event handler.
+     */
+    focus: (event: Event) => void;
+    /**
+     * Blur event handler.
+     */
+    blur: (event: Event) => void;
+    /**
+     * Paste event handler.
+     */
+    paste: (event: Event) => void;
+}
+/**
+ * Custom input template context.
+ * @group Interface
+ */
+interface InputOtpInputTemplateContext {
+    /**
+     * Token value.
+     */
+    $implicit: number | string;
+    /**
+     * Browser events of the template.
+     */
+    events: InputOtpTemplateEvents;
+    /**
+     * Index of the token.
+     */
+    index: number;
+}
+/**
+ * Defines valid templates in InputOtp.
+ * @group Templates
+ */
+interface InputOtpTemplates {
+    /**
+     * Custom input template.
+     * @param {Object} context - input context.
+     */
+    input(context: InputOtpInputTemplateContext): TemplateRef<InputOtpInputTemplateContext>;
+}
+
+export type { InputOtpChangeEvent, InputOtpInputTemplateContext, InputOtpPassThrough, InputOtpPassThroughOptions, InputOtpTemplateEvents, InputOtpTemplates };

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

@@ -1,5 +1,5 @@
 import { TemplateRef } from '@angular/core';
-import { PassThroughOption, PassThrough } from 'primeng/api';
+import { PassThroughOption, PassThrough, ScrollerOptions } from 'primeng/api';
 
 /**
  * Defines valid pass-through options in ListBox component.
@@ -179,7 +179,108 @@ interface ListboxClickEvent {
 interface ListboxDoubleClickEvent extends ListboxClickEvent {
 }
 /**
- * Defines valid templates in Panel.
+ * Custom item template context.
+ * @group Interface
+ */
+interface ListboxItemTemplateContext<T = any> {
+    /**
+     * Data of the option.
+     */
+    $implicit: T;
+    /**
+     * Index of the option.
+     */
+    index: number;
+    /**
+     * Whether the option is selected.
+     */
+    selected: boolean;
+    /**
+     * Whether the option is disabled.
+     */
+    disabled: boolean;
+}
+/**
+ * Custom group template context.
+ * @group Interface
+ */
+interface ListboxGroupTemplateContext<T = any> {
+    /**
+     * Group option data.
+     */
+    $implicit: T;
+}
+/**
+ * Custom header template context.
+ * @group Interface
+ */
+interface ListboxHeaderTemplateContext<T = any> {
+    /**
+     * Current model value.
+     */
+    $implicit: T;
+    /**
+     * Visible options.
+     */
+    options: any[];
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface ListboxFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: ListboxFilterOptions;
+}
+/**
+ * Custom footer template context.
+ * @group Interface
+ */
+interface ListboxFooterTemplateContext<T = any> {
+    /**
+     * Current model value.
+     */
+    $implicit: T;
+    /**
+     * Visible options.
+     */
+    options: any[];
+}
+/**
+ * Custom check icon template context.
+ * @group Interface
+ */
+interface ListboxCheckIconTemplateContext {
+    /**
+     * Whether the item is selected.
+     */
+    $implicit: boolean;
+}
+/**
+ * Custom checkmark template context.
+ * Note: Uses 'implicit' property instead of '$implicit'.
+ * @group Interface
+ */
+interface ListboxCheckmarkTemplateContext {
+    /**
+     * Whether the item is selected.
+     */
+    implicit: boolean;
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface ListboxLoaderTemplateContext {
+    /**
+     * Scroller options.
+     */
+    options: ScrollerOptions;
+}
+/**
+ * Defines valid templates in Listbox.
  * @group Templates
  */
 interface ListboxTemplates {
@@ -187,76 +288,54 @@ interface ListboxTemplates {
      * Custom item template.
      * @param {Object} context - item data.
      */
-    item(context: {
-        /**
-         * Data of the option.
-         */
-        $implicit: any;
-        /**
-         * Index of the option.
-         */
-        index: number;
-    }): TemplateRef<{
-        $implicit: any;
-        index: number;
-    }>;
+    item(context: ListboxItemTemplateContext): TemplateRef<ListboxItemTemplateContext>;
     /**
      * Custom group template.
      * @param {Object} context - group data.
      */
-    group(context: {
-        /**
-         * Group option.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    group(context: ListboxGroupTemplateContext): TemplateRef<ListboxGroupTemplateContext>;
     /**
      * Custom header template.
+     * @param {Object} context - header context.
      */
-    header(): TemplateRef<any>;
+    header(context: ListboxHeaderTemplateContext): TemplateRef<ListboxHeaderTemplateContext>;
     /**
      * Custom filter template.
      * @param {Object} context - filter options.
      */
-    filter(context: {
-        /**
-         * Filter options.
-         */
-        options: ListboxFilterOptions;
-    }): TemplateRef<any>;
+    filter(context: ListboxFilterTemplateContext): TemplateRef<ListboxFilterTemplateContext>;
     /**
      * Custom footer template.
+     * @param {Object} context - footer context.
      */
-    footer(): TemplateRef<any>;
+    footer(context: ListboxFooterTemplateContext): TemplateRef<ListboxFooterTemplateContext>;
     /**
      * Custom empty template.
      */
-    empty(): TemplateRef<any>;
+    empty(): TemplateRef<void>;
     /**
      * Custom empty filter template.
      */
-    emptyfilter(): TemplateRef<any>;
+    emptyfilter(): TemplateRef<void>;
     /**
      * Custom filter icon template.
      */
-    filtericon(): TemplateRef<any>;
+    filtericon(): TemplateRef<void>;
     /**
      * Custom check icon template.
+     * @param {Object} context - check icon context.
      */
-    checkicon(): TemplateRef<any>;
+    checkicon(context: ListboxCheckIconTemplateContext): TemplateRef<ListboxCheckIconTemplateContext>;
     /**
      * Custom checkmark template.
+     * @param {Object} context - checkmark context.
+     */
+    checkmark(context: ListboxCheckmarkTemplateContext): TemplateRef<ListboxCheckmarkTemplateContext>;
+    /**
+     * Custom loader template for virtual scroll.
+     * @param {Object} context - loader context.
      */
-    checkmark(context: {
-        /**
-         * Selection status.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    loader(context: ListboxLoaderTemplateContext): TemplateRef<ListboxLoaderTemplateContext>;
 }
 /**
  * Defines context options for ListBox passthrough.
@@ -277,4 +356,4 @@ interface ListBoxContext {
     disabled?: boolean;
 }
 
-export type { ListBoxContext, ListBoxPassThrough, ListBoxPassThroughOptions, ListboxChangeEvent, ListboxClickEvent, ListboxDoubleClickEvent, ListboxFilterEvent, ListboxFilterOptions, ListboxSelectAllChangeEvent, ListboxTemplates };
+export type { ListBoxContext, ListBoxPassThrough, ListBoxPassThroughOptions, ListboxChangeEvent, ListboxCheckIconTemplateContext, ListboxCheckmarkTemplateContext, ListboxClickEvent, ListboxDoubleClickEvent, ListboxFilterEvent, ListboxFilterOptions, ListboxFilterTemplateContext, ListboxFooterTemplateContext, ListboxGroupTemplateContext, ListboxHeaderTemplateContext, ListboxItemTemplateContext, ListboxLoaderTemplateContext, ListboxSelectAllChangeEvent, ListboxTemplates };

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

@@ -89,6 +89,16 @@ interface MegaMenuPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type MegaMenuPassThrough<I = unknown> = PassThrough<I, MegaMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface MegaMenuItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+}
 /**
  * Defines valid templates in MegaMenu.
  * @group Templates
@@ -96,27 +106,33 @@ type MegaMenuPassThrough<I = unknown> = PassThrough<I, MegaMenuPassThroughOption
 interface MegaMenuTemplates {
     /**
      * Custom item template.
+     * @param {Object} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: MenuItem;
-    }): TemplateRef<{
-        $implicit: MenuItem;
-    }>;
+    item(context: MegaMenuItemTemplateContext): TemplateRef<MegaMenuItemTemplateContext>;
     /**
      * Custom template of start.
      */
-    start(): TemplateRef<any>;
+    start(): TemplateRef<void>;
+    /**
+     * Custom template of end.
+     */
+    end(): TemplateRef<void>;
     /**
-     * Custom template of submenuicon.
+     * Custom template of submenu icon.
      */
-    submenuicon(): TemplateRef<any>;
+    submenuicon(): TemplateRef<void>;
     /**
-     * Custom template of end.
+     * Custom menu button template on responsive mode.
+     */
+    button(): TemplateRef<void>;
+    /**
+     * Custom menu button icon template on responsive mode.
+     */
+    buttonicon(): TemplateRef<void>;
+    /**
+     * Custom menu icon template.
      */
-    end(): TemplateRef<any>;
+    menuicon(): TemplateRef<void>;
 }
 
-export type { MegaMenuPassThrough, MegaMenuPassThroughOptions, MegaMenuTemplates };
+export type { MegaMenuItemTemplateContext, MegaMenuPassThrough, MegaMenuPassThroughOptions, MegaMenuTemplates };