primeng 20.3.0 → 21.0.0-rc.1

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

@@ -89,76 +89,85 @@ interface OrderListFilterEvent {
      */
     value: any[];
 }
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface OrderListItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Whether the item is selected.
+     */
+    selected: boolean;
+    /**
+     * Index of the item.
+     */
+    index: number;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface OrderListFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: OrderListFilterOptions;
+}
 /**
  * Defines valid templates in OrderList.
  * @group Templates
  */
 interface OrderListTemplates {
     /**
-     * Custom header template.
-     * @param {Object} context - item data.
-     */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-        /**
-         * Index of the item.
-         */
-        index: number;
-    }): TemplateRef<{
-        $implicit: any;
-        index: number;
-    }>;
+     * Custom item template.
+     * @param {OrderListItemTemplateContext} context - item context.
+     */
+    item(context: OrderListItemTemplateContext): TemplateRef<OrderListItemTemplateContext>;
     /**
      * Custom header template.
      */
-    header(): TemplateRef<any>;
+    header(): TemplateRef<void>;
     /**
      * Custom filter template.
-     * @param {OrderListFilterOptions} options - filter options.
+     * @param {OrderListFilterTemplateContext} context - filter context.
      */
-    filter(context: {
-        /**
-         * Filter options.
-         */
-        options: OrderListFilterOptions;
-    }): TemplateRef<{
-        options: OrderListFilterOptions;
-    }>;
+    filter(context: OrderListFilterTemplateContext): TemplateRef<OrderListFilterTemplateContext>;
     /**
      * Custom empty filter template.
      */
-    emptyfilter(): TemplateRef<any>;
+    emptyfilter(): TemplateRef<void>;
     /**
      * Custom empty template.
      */
-    empty(): TemplateRef<any>;
+    empty(): TemplateRef<void>;
     /**
      * Custom clear icon template.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
     /**
      * Custom filter icon template.
      */
-    filtericon(): TemplateRef<any>;
+    filtericon(): TemplateRef<void>;
     /**
      * Custom move up icon template.
      */
-    moveupicon(): TemplateRef<any>;
+    moveupicon(): TemplateRef<void>;
     /**
      * Custom move top icon template.
      */
-    movetopicon(): TemplateRef<any>;
+    movetopicon(): TemplateRef<void>;
     /**
      * Custom move down icon template.
      */
-    movedownicon(): TemplateRef<any>;
+    movedownicon(): TemplateRef<void>;
     /**
      * Custom move bottom icon template.
      */
-    movebottomicon(): TemplateRef<any>;
+    movebottomicon(): TemplateRef<void>;
 }
 
-export type { OrderListFilterEvent, OrderListFilterOptions, OrderListPassThrough, OrderListPassThroughOptions, OrderListSelectionChangeEvent, OrderListTemplates };
+export type { OrderListFilterEvent, OrderListFilterOptions, OrderListFilterTemplateContext, OrderListItemTemplateContext, OrderListPassThrough, OrderListPassThroughOptions, OrderListSelectionChangeEvent, OrderListTemplates };

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

@@ -0,0 +1,60 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
+import { OverlayModeType, PassThroughOption, PassThrough } from 'primeng/api';
+
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface OverlayContentTemplateContext {
+    /**
+     * Object containing the overlay mode.
+     */
+    $implicit: {
+        /**
+         * Current overlay mode.
+         */
+        mode: OverlayModeType | string | null;
+    };
+}
+/**
+ * Defines valid templates in Overlay.
+ * @group Templates
+ */
+interface OverlayTemplates {
+    /**
+     * Custom content template.
+     * @param {OverlayContentTemplateContext} context - content context.
+     */
+    content(context: OverlayContentTemplateContext): TemplateRef<OverlayContentTemplateContext>;
+}
+/**
+ * Custom pass-through(pt) options.
+ * @template I Type of instance.
+ *
+ * @see {@link OverlayProps.pt}
+ * @group Interface
+ */
+interface OverlayPassThroughOptions<I = unknown> {
+    /**
+     * Used to pass attributes to the root's DOM element.
+     */
+    root?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content's DOM element.
+     */
+    content?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
+}
+/**
+ * Defines valid pass-through options in Overlay component.
+ * @see {@link OverlayPassThroughOptions}
+ *
+ * @template I Type of instance.
+ */
+type OverlayPassThrough<I = unknown> = PassThrough<I, OverlayPassThroughOptions<I>>;
+
+export type { OverlayContentTemplateContext, OverlayPassThrough, OverlayPassThroughOptions, OverlayTemplates };

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

@@ -96,10 +96,46 @@ type PaginatorPassThrough<I = unknown> = PassThrough<I, PaginatorPassThroughOpti
  * @group Interface
  */
 interface PaginatorState {
+    /**
+     * Current page number.
+     */
     page?: number;
+    /**
+     * Index of the first record.
+     */
     first?: number;
+    /**
+     * Number of rows per page.
+     */
     rows?: number;
+    /**
+     * Total number of pages.
+     */
     pageCount?: number;
+    /**
+     * Total number of records.
+     */
+    totalRecords?: number;
+}
+/**
+ * Custom template context for left/right templates.
+ * @group Interface
+ */
+interface PaginatorTemplateContext {
+    /**
+     * Paginator state.
+     */
+    $implicit: PaginatorState;
+}
+/**
+ * Custom template context for dropdown item templates.
+ * @group Interface
+ */
+interface PaginatorDropdownItemTemplateContext {
+    /**
+     * Dropdown item instance.
+     */
+    $implicit: any;
 }
 /**
  * Defines valid templates in PaginatorTemplates.
@@ -109,23 +145,23 @@ interface PaginatorTemplates {
     /**
      * Custom dropdown trigger icon template.
      */
-    dropdownicon(): TemplateRef<any>;
+    dropdownicon(): TemplateRef<void>;
     /**
      * Custom first page link icon template.
      */
-    firstpagelinkicon(): TemplateRef<any>;
+    firstpagelinkicon(): TemplateRef<void>;
     /**
      * Custom previous page link icon template.
      */
-    previouspagelinkicon(): TemplateRef<any>;
+    previouspagelinkicon(): TemplateRef<void>;
     /**
      * Custom last page link icon template.
      */
-    lastpagelinkicon(): TemplateRef<any>;
+    lastpagelinkicon(): TemplateRef<void>;
     /**
      * Custom next page link icon template.
      */
-    nextpagelinkicon(): TemplateRef<any>;
+    nextpagelinkicon(): TemplateRef<void>;
 }
 
-export type { PaginatorPassThrough, PaginatorPassThroughOptions, PaginatorState, PaginatorTemplates };
+export type { PaginatorDropdownItemTemplateContext, PaginatorPassThrough, PaginatorPassThroughOptions, PaginatorState, PaginatorTemplateContext, PaginatorTemplates };

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

@@ -1,3 +1,5 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 import { ButtonPassThrough } from 'primeng/types/button';
 
@@ -38,6 +40,10 @@ interface PanelPassThroughOptions<I = unknown> {
      * Used to pass attributes to the content container's DOM element.
      */
     contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the content wrapper DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
     /**
      * Used to pass attributes to the content's DOM element.
      */
@@ -46,6 +52,10 @@ interface PanelPassThroughOptions<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 Panel component.
@@ -88,5 +98,32 @@ interface PanelHeaderIconsTemplateContext {
      */
     $implicit: boolean;
 }
+/**
+ * Defines valid templates in Panel.
+ * @group Templates
+ */
+interface PanelTemplates {
+    /**
+     * Custom header template.
+     */
+    header(): TemplateRef<void>;
+    /**
+     * Custom icons template.
+     */
+    icons(): TemplateRef<void>;
+    /**
+     * Custom content template.
+     */
+    content(): TemplateRef<void>;
+    /**
+     * Custom footer template.
+     */
+    footer(): TemplateRef<void>;
+    /**
+     * Custom header icons template.
+     * @param {PanelHeaderIconsTemplateContext} context - header icons context.
+     */
+    headericons(context: PanelHeaderIconsTemplateContext): TemplateRef<PanelHeaderIconsTemplateContext>;
+}
 
-export type { PanelAfterToggleEvent, PanelBeforeToggleEvent, PanelHeaderIconsTemplateContext, PanelPassThrough, PanelPassThroughOptions };
+export type { PanelAfterToggleEvent, PanelBeforeToggleEvent, PanelHeaderIconsTemplateContext, PanelPassThrough, PanelPassThroughOptions, PanelTemplates };

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

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
 
 /**
@@ -45,6 +46,10 @@ interface PanelMenuPassThroughOptions<I = unknown> {
      * Used to pass attributes to the toggleable content's DOM element.
      */
     contentContainer?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass attributes to the toggleable content's DOM element.
+     */
+    contentWrapper?: PassThroughOption<HTMLDivElement, I>;
     /**
      * Used to pass attributes to the menu content's DOM element.
      */
@@ -81,6 +86,10 @@ interface PanelMenuPassThroughOptions<I = unknown> {
      * Used to pass attributes to the separator's DOM element.
      */
     separator?: PassThroughOption<HTMLLIElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in PanelMenu.
@@ -89,6 +98,16 @@ interface PanelMenuPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type PanelMenuPassThrough<I = unknown> = PassThrough<I, PanelMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface PanelMenuItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: MenuItem;
+}
 /**
  * Defines valid templates in PanelMenu.
  * @group Templates
@@ -96,19 +115,17 @@ type PanelMenuPassThrough<I = unknown> = PassThrough<I, PanelMenuPassThroughOpti
 interface PanelMenuTemplates {
     /**
      * Custom item template.
+     * @param {PanelMenuItemTemplateContext} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: MenuItem;
-    }): TemplateRef<{
-        $implicit: MenuItem;
-    }>;
+    item(context: PanelMenuItemTemplateContext): TemplateRef<PanelMenuItemTemplateContext>;
     /**
      * Custom template of submenuicon.
      */
-    submenuicon(): TemplateRef<any>;
+    submenuicon(): TemplateRef<void>;
+    /**
+     * Custom template of headericon.
+     */
+    headericon(): TemplateRef<void>;
 }
 
-export type { PanelMenuPassThrough, PanelMenuPassThroughOptions, PanelMenuTemplates };
+export type { PanelMenuItemTemplateContext, PanelMenuPassThrough, PanelMenuPassThroughOptions, PanelMenuTemplates };

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

@@ -1,6 +1,8 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 import { InputTextPassThrough } from 'primeng/types/inputtext';
+import { OverlayPassThrough } from 'primeng/types/overlay';
 
 /**
  * Custom pass-through(pt) options.
@@ -35,6 +37,11 @@ interface PasswordPassThroughOptions<I = unknown> {
      * Used to pass attributes to the unmask icon's DOM element.
      */
     unmaskIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass attributes to the Overlay component.
+     * @see {@link OverlayPassThrough}
+     */
+    pcOverlay?: OverlayPassThrough;
     /**
      * Used to pass attributes to the overlay's DOM element.
      */
@@ -55,6 +62,10 @@ interface PasswordPassThroughOptions<I = unknown> {
      * Used to pass attributes to the meter text's DOM element.
      */
     meterText?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in Password.
@@ -63,6 +74,16 @@ interface PasswordPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type PasswordPassThrough<I = unknown> = PassThrough<I, PasswordPassThroughOptions<I>>;
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface PasswordIconTemplateContext {
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
 /**
  * Defines valid templates in Password.
  * @group Templates
@@ -71,27 +92,29 @@ interface PasswordTemplates {
     /**
      * Custom template of header.
      */
-    header(): TemplateRef<any>;
+    header(): TemplateRef<void>;
     /**
      * Custom template of content.
      */
-    content(): TemplateRef<any>;
+    content(): TemplateRef<void>;
     /**
      * Custom template of footer.
      */
-    footer(): TemplateRef<any>;
+    footer(): TemplateRef<void>;
     /**
      * Custom template of clear icon.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
     /**
      * Custom template of hide icon.
+     * @param {PasswordIconTemplateContext} context - icon context.
      */
-    hideicon(): TemplateRef<any>;
+    hideicon(context: PasswordIconTemplateContext): TemplateRef<PasswordIconTemplateContext>;
     /**
      * Custom template of show icon.
+     * @param {PasswordIconTemplateContext} context - icon context.
      */
-    showicon(): TemplateRef<any>;
+    showicon(context: PasswordIconTemplateContext): TemplateRef<PasswordIconTemplateContext>;
 }
 
-export type { PasswordPassThrough, PasswordPassThroughOptions, PasswordTemplates };
+export type { PasswordIconTemplateContext, PasswordPassThrough, PasswordPassThroughOptions, PasswordTemplates };

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

@@ -213,6 +213,48 @@ interface PickListSourceFilterEvent {
  */
 interface PickListTargetFilterEvent extends PickListSourceFilterEvent {
 }
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface PickListItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Item index.
+     */
+    index: number;
+    /**
+     * Whether the item is selected.
+     */
+    selected: boolean;
+    /**
+     * Whether the item is disabled.
+     */
+    disabled: boolean;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface PickListFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: PickListFilterOptions;
+}
+/**
+ * Custom transfer icon template context.
+ * @group Interface
+ */
+interface PickListTransferIconTemplateContext {
+    /**
+     * Boolean value indicates if the view is changed according to breakpoints.
+     */
+    $implicit: boolean;
+}
 /**
  * Defines valid templates in PickList.
  * @group Templates
@@ -220,134 +262,87 @@ interface PickListTargetFilterEvent extends PickListSourceFilterEvent {
 interface PickListTemplates {
     /**
      * Custom item template.
+     * @param {PickListItemTemplateContext} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-        /**
-         * Item index.
-         */
-        index: number;
-    }): TemplateRef<{
-        $implicit: any;
-        index: number;
-    }>;
+    item(context: PickListItemTemplateContext): TemplateRef<PickListItemTemplateContext>;
     /**
      * Custom source header template.
      */
-    sourceHeader(): TemplateRef<any>;
+    sourceHeader(): TemplateRef<void>;
     /**
      * Custom target header template.
      */
-    targetHeader(): TemplateRef<any>;
+    targetHeader(): TemplateRef<void>;
     /**
      * Custom source filter template.
+     * @param {PickListFilterTemplateContext} context - filter context.
      */
-    sourceFilter(context: {
-        /**
-         * Source filter options.
-         */
-        options: PickListFilterOptions;
-    }): TemplateRef<{
-        options: PickListFilterOptions;
-    }>;
+    sourceFilter(context: PickListFilterTemplateContext): TemplateRef<PickListFilterTemplateContext>;
     /**
      * Custom target filter template.
+     * @param {PickListFilterTemplateContext} context - filter context.
      */
-    targetFilter(context: {
-        /**
-         * Target filter options.
-         */
-        options: PickListFilterOptions;
-    }): TemplateRef<{
-        options: PickListFilterOptions;
-    }>;
+    targetFilter(context: PickListFilterTemplateContext): TemplateRef<PickListFilterTemplateContext>;
     /**
      * Custom source list empty message template.
      */
-    emptymessagesource(): TemplateRef<any>;
+    emptymessagesource(): TemplateRef<void>;
     /**
      * Custom source list empty filter message template.
      */
-    emptyfiltermessagesource(): TemplateRef<any>;
+    emptyfiltermessagesource(): TemplateRef<void>;
     /**
      * Custom target list empty message template.
      */
-    emptymessagetarget(): TemplateRef<any>;
+    emptymessagetarget(): TemplateRef<void>;
     /**
      * Custom target list empty filter message template.
      */
-    emptyfiltermessagetarget(): TemplateRef<any>;
+    emptyfiltermessagetarget(): TemplateRef<void>;
     /**
      * Custom move up icon template.
      */
-    moveupicon(): TemplateRef<any>;
+    moveupicon(): TemplateRef<void>;
     /**
      * Custom move top icon template.
      */
-    movetopicon(): TemplateRef<any>;
+    movetopicon(): TemplateRef<void>;
     /**
      * Custom move down icon template.
      */
-    movedownicon(): TemplateRef<any>;
+    movedownicon(): TemplateRef<void>;
     /**
      * Custom move bottom icon template.
      */
-    movebottomicon(): TemplateRef<any>;
+    movebottomicon(): TemplateRef<void>;
     /**
      * Custom move to target icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
      */
-    movetotargeticon(context: {
-        /**
-         * Boolean value indicates if the view is changed according to breakpoints.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    movetotargeticon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
     /**
      * Custom move all to target icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
      */
-    movealltotargeticon(context: {
-        /**
-         * Boolean value indicates if the view is changed according to breakpoints.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    movealltotargeticon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
     /**
      * Custom move to source icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
      */
-    movetosourceicon(context: {
-        /**
-         * Boolean value indicates if the view is changed according to breakpoints.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    movetosourceicon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
     /**
      * Custom move all to source icon template.
+     * @param {PickListTransferIconTemplateContext} context - icon context.
      */
-    movealltosourceicon(context: {
-        /**
-         * Boolean value indicates if the view is changed according to breakpoints.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    movealltosourceicon(context: PickListTransferIconTemplateContext): TemplateRef<PickListTransferIconTemplateContext>;
     /**
      * Custom target filter icon template.
      */
-    targetfiltericon(): TemplateRef<any>;
+    targetfiltericon(): TemplateRef<void>;
     /**
      * Custom source filter icon template.
      */
-    sourcefiltericon(): TemplateRef<any>;
+    sourcefiltericon(): TemplateRef<void>;
 }
 
-export type { PickListFilterOptions, PickListMoveAllToSourceEvent, PickListMoveAllToTargetEvent, PickListMoveToSourceEvent, PickListMoveToTargetEvent, PickListPassThrough, PickListPassThroughOptions, PickListSourceFilterEvent, PickListSourceReorderEvent, PickListSourceSelectEvent, PickListTargetFilterEvent, PickListTargetReorderEvent, PickListTargetSelectEvent, PickListTemplates };
+export type { PickListFilterOptions, PickListFilterTemplateContext, PickListItemTemplateContext, PickListMoveAllToSourceEvent, PickListMoveAllToTargetEvent, PickListMoveToSourceEvent, PickListMoveToTargetEvent, PickListPassThrough, PickListPassThroughOptions, PickListSourceFilterEvent, PickListSourceReorderEvent, PickListSourceSelectEvent, PickListTargetFilterEvent, PickListTargetReorderEvent, PickListTargetSelectEvent, PickListTemplates, PickListTransferIconTemplateContext };