primeng 20.3.0 → 21.0.0-rc.1

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

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough, MenuItem } from 'primeng/api';
 
 /**
@@ -53,6 +54,10 @@ interface MenuPassThroughOptions<I = unknown> {
      * Used to pass attributes to the end's DOM element.
      */
     end?: PassThroughOption<HTMLDivElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in Menu.
@@ -61,6 +66,26 @@ interface MenuPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type MenuPassThrough<I = unknown> = PassThrough<I, MenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface MenuItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+}
+/**
+ * Custom submenu header template context.
+ * @group Interface
+ */
+interface MenuSubmenuHeaderTemplateContext {
+    /**
+     * Submenu item instance.
+     */
+    $implicit: MenuItem;
+}
 /**
  * Defines valid templates in Menu.
  * @group Templates
@@ -69,33 +94,21 @@ interface MenuTemplates {
     /**
      * Custom template of start.
      */
-    start(): TemplateRef<any>;
+    start(): TemplateRef<void>;
     /**
      * Custom template of end.
      */
-    end(): TemplateRef<any>;
+    end(): TemplateRef<void>;
     /**
      * Custom template of item.
+     * @param {Object} context - item context.
+     */
+    item(context: MenuItemTemplateContext): TemplateRef<MenuItemTemplateContext>;
+    /**
+     * Custom template of submenu header.
+     * @param {Object} context - submenu header context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: MenuItem;
-    }): TemplateRef<{
-        $implicit: MenuItem;
-    }>;
-    /**
-     * Custom template of submenuheader.
-     */
-    submenuheader(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: MenuItem;
-    }): TemplateRef<{
-        $implicit: MenuItem;
-    }>;
+    submenuheader(context: MenuSubmenuHeaderTemplateContext): TemplateRef<MenuSubmenuHeaderTemplateContext>;
 }
 
-export type { MenuPassThrough, MenuPassThroughOptions, MenuTemplates };
+export type { MenuItemTemplateContext, MenuPassThrough, MenuPassThroughOptions, MenuSubmenuHeaderTemplateContext, MenuTemplates };

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

@@ -79,6 +79,20 @@ interface MenubarPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type MenubarPassThrough<I = unknown> = PassThrough<I, MenubarPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface MenubarItemTemplateContext {
+    /**
+     * Menu item instance.
+     */
+    $implicit: MenuItem;
+    /**
+     * Whether the item is at the root level.
+     */
+    root: boolean;
+}
 /**
  * Defines valid templates in Menubar.
  * @group Templates
@@ -86,36 +100,25 @@ type MenubarPassThrough<I = unknown> = PassThrough<I, MenubarPassThroughOptions<
 interface MenubarTemplates {
     /**
      * Custom item template.
+     * @param {Object} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: MenuItem;
-        /**
-         * Whether root or not
-         */
-        root: boolean;
-    }): TemplateRef<{
-        $implicit: MenuItem;
-        root: boolean;
-    }>;
+    item(context: MenubarItemTemplateContext): TemplateRef<MenubarItemTemplateContext>;
     /**
      * Custom template of start.
      */
-    start(): TemplateRef<any>;
+    start(): TemplateRef<void>;
     /**
      * Custom template of end.
      */
-    end(): TemplateRef<any>;
+    end(): TemplateRef<void>;
     /**
-     * Custom template of menuicon.
+     * Custom template of menu icon.
      */
-    menuicon(): TemplateRef<any>;
+    menuicon(): TemplateRef<void>;
     /**
-     * Custom template of submenuicon.
+     * Custom template of submenu icon.
      */
-    submenuicon(): TemplateRef<any>;
+    submenuicon(): TemplateRef<void>;
 }
 
-export type { MenubarPassThrough, MenubarPassThroughOptions, MenubarTemplates };
+export type { MenubarItemTemplateContext, MenubarPassThrough, MenubarPassThroughOptions, MenubarTemplates };

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

@@ -1,3 +1,5 @@
+import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -36,6 +38,10 @@ interface MessagePassThroughOptions<I = unknown> {
      * Used to pass attributes to the close icon's DOM element.
      */
     closeIcon?: PassThroughOption<HTMLElement, I>;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in Message.
@@ -44,5 +50,34 @@ interface MessagePassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type MessagePassThrough<I = unknown> = PassThrough<I, MessagePassThroughOptions<I>>;
+/**
+ * Custom container template context.
+ * @group Interface
+ */
+interface MessageContainerTemplateContext {
+    /**
+     * Callback to close the message.
+     */
+    closeCallback: (event: Event) => void;
+}
+/**
+ * Defines valid templates in Message.
+ * @group Templates
+ */
+interface MessageTemplates {
+    /**
+     * Custom container template.
+     * @param {Object} context - container context.
+     */
+    container(context: MessageContainerTemplateContext): TemplateRef<MessageContainerTemplateContext>;
+    /**
+     * Custom icon template.
+     */
+    icon(): TemplateRef<void>;
+    /**
+     * Custom close icon template.
+     */
+    closeicon(): TemplateRef<void>;
+}
 
-export type { MessagePassThrough, MessagePassThroughOptions };
+export type { MessageContainerTemplateContext, MessagePassThrough, MessagePassThroughOptions, MessageTemplates };

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

@@ -53,6 +53,72 @@ interface MeterGroupPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type MeterGroupPassThrough<I = unknown> = PassThrough<I, MeterGroupPassThroughOptions<I>>;
+/**
+ * Custom label template context.
+ * @group Interface
+ */
+interface MeterGroupLabelTemplateContext {
+    /**
+     * Array of meter items.
+     */
+    $implicit: MeterItem[];
+    /**
+     * Total percent of the metergroup items.
+     */
+    totalPercent: number;
+    /**
+     * Array of sequential sum of values of metergroup items.
+     */
+    percentages: number[];
+}
+/**
+ * Custom meter template context.
+ * @group Interface
+ */
+interface MeterGroupMeterTemplateContext {
+    /**
+     * Current meter item.
+     */
+    $implicit: MeterItem;
+    /**
+     * Current index of the meter item.
+     */
+    index: number;
+    /**
+     * Current orientation of the component.
+     */
+    orientation: 'horizontal' | 'vertical';
+    /**
+     * Style class of the meter item.
+     */
+    class: string;
+    /**
+     * Size (width/height percentage) of the meter item.
+     */
+    size: string;
+    /**
+     * Total percent of all metergroup items.
+     */
+    totalPercent: number;
+    /**
+     * DataP attributes.
+     */
+    dataP: string;
+}
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface MeterGroupIconTemplateContext {
+    /**
+     * Current meter item.
+     */
+    $implicit: MeterItem;
+    /**
+     * Icon class of the meter item.
+     */
+    icon: string | undefined;
+}
 /**
  * Defines valid templates in MeterGroup.
  * @group Templates
@@ -60,97 +126,29 @@ type MeterGroupPassThrough<I = unknown> = PassThrough<I, MeterGroupPassThroughOp
 interface MeterGroupTemplates {
     /**
      * Custom label template.
+     * @param {Object} context - label context.
      */
-    label(context: {
-        /**
-         * Current value of the component.
-         */
-        $implicit?: MeterItem;
-        /**
-         * Total percent of the metergroup items.
-         */
-        totalPercent?: number;
-        /**
-         * Array of sequential sum of values of metergroup items.
-         */
-        percentages?: number;
-    }): TemplateRef<any>;
+    label(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
     /**
      * Custom meter item template.
+     * @param {Object} context - meter context.
      */
-    meter(context: {
-        /**
-         * Current value of the component.
-         */
-        $implicit?: MeterItem;
-        /**
-         * Current index of the meter item.
-         */
-        index?: number;
-        /**
-         * Style class of the meter item
-         */
-        class?: string;
-        /**
-         * Current orientation of the component.
-         */
-        orientation?: string;
-        /**
-         * Current width of the meter item.
-         */
-        size?: string;
-        /**
-         * Total percent of the metergroup items
-         */
-        totalPercent?: number;
-    }): TemplateRef<any>;
+    meter(context: MeterGroupMeterTemplateContext): TemplateRef<MeterGroupMeterTemplateContext>;
     /**
      * Custom start template.
+     * @param {Object} context - start context.
      */
-    start(context: {
-        /**
-         * Current value of the component.
-         */
-        $implicit?: MeterItem;
-        /**
-         * Total percent of the metergroup items.
-         */
-        totalPercent?: number;
-        /**
-         * Array of sequential sum of values of metergroup items.
-         */
-        percentages?: number;
-    }): TemplateRef<any>;
+    start(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
     /**
-     * Custom start template.
+     * Custom end template.
+     * @param {Object} context - end context.
      */
-    end(context: {
-        /**
-         * Current value of the component.
-         */
-        $implicit?: MeterItem;
-        /**
-         * Total percent of the metergroup items.
-         */
-        totalPercent?: number;
-        /**
-         * Array of sequential sum of values of metergroup items.
-         */
-        percentages?: number;
-    }): TemplateRef<any>;
+    end(context: MeterGroupLabelTemplateContext): TemplateRef<MeterGroupLabelTemplateContext>;
     /**
      * Custom icon template.
+     * @param {Object} context - icon context.
      */
-    icon(context: {
-        /**
-         * Current value of the component.
-         */
-        $implicit?: MeterItem;
-        /**
-         * Style class of the icon.
-         */
-        class?: string;
-    }): TemplateRef<any>;
+    icon(context: MeterGroupIconTemplateContext): TemplateRef<MeterGroupIconTemplateContext>;
 }
 /**
  * Represents a meter item configuration.
@@ -175,4 +173,4 @@ interface MeterItem {
     icon?: string;
 }
 
-export type { MeterGroupPassThrough, MeterGroupPassThroughOptions, MeterGroupTemplates, MeterItem };
+export type { MeterGroupIconTemplateContext, MeterGroupLabelTemplateContext, MeterGroupMeterTemplateContext, MeterGroupPassThrough, MeterGroupPassThroughOptions, MeterGroupTemplates, MeterItem };

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

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

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

@@ -220,143 +220,195 @@ interface MultiSelectRemoveEvent {
      */
     removed: unknown;
 }
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface MultiSelectItemTemplateContext<T = any> {
+    /**
+     * Data of the option.
+     */
+    $implicit: T;
+}
+/**
+ * Custom selected items template context.
+ * @group Interface
+ */
+interface MultiSelectSelectedItemsTemplateContext<T = any> {
+    /**
+     * Selected options value.
+     */
+    $implicit: T[];
+    /**
+     * Function to remove a chip.
+     */
+    removeChip: (chip: T, event: MouseEvent) => void;
+}
+/**
+ * Custom group template context.
+ * @group Interface
+ */
+interface MultiSelectGroupTemplateContext<T = any> {
+    /**
+     * Group option.
+     */
+    $implicit: T;
+}
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface MultiSelectFilterTemplateContext {
+    /**
+     * Filter options.
+     */
+    options: MultiSelectFilterOptions;
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface MultiSelectLoaderTemplateContext {
+    /**
+     * Virtual scroller options.
+     */
+    options: ScrollerOptions;
+}
+/**
+ * Custom dropdown icon template context.
+ * @group Interface
+ */
+interface MultiSelectDropdownIconTemplateContext {
+    /**
+     * DataP attributes.
+     */
+    dataP: string;
+}
+/**
+ * Custom chip icon template context.
+ * @group Interface
+ */
+interface MultiSelectChipIconTemplateContext {
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
+/**
+ * Custom header checkbox icon template context.
+ * @group Interface
+ */
+interface MultiSelectHeaderCheckboxIconTemplateContext {
+    /**
+     * Defines if all items are selected.
+     */
+    checked: boolean;
+    /**
+     * Defines if items are partially selected.
+     */
+    partialSelected: boolean;
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
+/**
+ * Custom item checkbox icon template context.
+ * @group Interface
+ */
+interface MultiSelectItemCheckboxIconTemplateContext {
+    /**
+     * Selection status of the item.
+     */
+    checked: boolean;
+    /**
+     * Style class of the icon.
+     */
+    class: string;
+}
 /**
  * Defines valid templates in MultiSelect.
  * @group Templates
  */
-interface MultiSelectTemplates {
+interface MultiSelectTemplates<T = any> {
     /**
-     * Custom header template.
+     * Custom item template.
      * @param {Object} context - item data.
      */
-    item(context: {
-        /**
-         * Data of the option.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    item(context: MultiSelectItemTemplateContext<T>): TemplateRef<MultiSelectItemTemplateContext<T>>;
     /**
-     * Custom selected item template.
+     * Custom selected items template.
      * @param {Object} context - selected items data.
      */
-    selecteditems(context: {
-        /**
-         * Selected option value.
-         */
-        $implicit: any;
-        /**
-         * Function to remove chip.
-         */
-        removeChip: (chip: unknown, event: MouseEvent) => void;
-    }): TemplateRef<{
-        $implicit: any;
-        removeChip: Function;
-    }>;
+    selecteditems(context: MultiSelectSelectedItemsTemplateContext<T>): TemplateRef<MultiSelectSelectedItemsTemplateContext<T>>;
     /**
      * Custom header template.
      */
-    header(): TemplateRef<any>;
+    header(): TemplateRef<void>;
     /**
      * Custom filter template.
      * @param {MultiSelectFilterOptions} options - filter options.
      */
-    filter(context: {
-        /**
-         * Filter options.
-         */
-        options: MultiSelectFilterOptions;
-    }): TemplateRef<{
-        options: MultiSelectFilterOptions;
-    }>;
+    filter(context: MultiSelectFilterTemplateContext): TemplateRef<MultiSelectFilterTemplateContext>;
     /**
      * Custom footer template.
      */
-    footer(): TemplateRef<any>;
+    footer(): TemplateRef<void>;
     /**
      * Custom empty filter template.
      */
-    emptyfilter(): TemplateRef<any>;
+    emptyfilter(): TemplateRef<void>;
     /**
      * Custom empty template.
      */
-    empty(): TemplateRef<any>;
+    empty(): TemplateRef<void>;
     /**
      * Custom group template.
      */
-    group(context: {
-        /**
-         * Data of the item.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    group(context: MultiSelectGroupTemplateContext<T>): TemplateRef<MultiSelectGroupTemplateContext<T>>;
     /**
      * Custom loader template. This template can be used with virtualScroll.
      * @param {ScrollerOptions} options - virtual scroller options.
      */
-    loader(context: {
-        /**
-         * Virtual scroller options.
-         */
-        options: ScrollerOptions;
-    }): TemplateRef<{
-        options: ScrollerOptions;
-    }>;
+    loader(context: MultiSelectLoaderTemplateContext): TemplateRef<MultiSelectLoaderTemplateContext>;
     /**
      * Custom dropdown trigger icon template.
+     * @param {Object} context - icon context.
      */
-    dropdownicon(): TemplateRef<any>;
+    dropdownicon(context: MultiSelectDropdownIconTemplateContext): TemplateRef<MultiSelectDropdownIconTemplateContext>;
     /**
      * Custom clear icon template.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
     /**
      * Custom filter icon template.
      */
-    filtericon(): TemplateRef<any>;
+    filtericon(): TemplateRef<void>;
     /**
-     * Custom check icon template.
-     * @deprecated Use headercheckboxicon or itemcheckboxicon instead.
+     * Custom loading icon template.
      */
-    checkicon(): TemplateRef<any>;
+    loadingicon(): TemplateRef<void>;
     /**
      * Custom check icon template for the header checkbox.
+     * @param {Object} context - checkbox icon context.
      */
-    headercheckboxicon(context: {
-        /**
-         * Defines if all items are selected.
-         */
-        $implicit: boolean;
-        /**
-         * Defines if items are partially selected.
-         */
-        partialSelected: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-        partialSelected: boolean;
-    }>;
+    headercheckboxicon(context: MultiSelectHeaderCheckboxIconTemplateContext): TemplateRef<MultiSelectHeaderCheckboxIconTemplateContext>;
     /**
      * Custom check icon template for the item checkbox.
+     * @param {Object} context - checkbox icon context.
      */
-    itemcheckboxicon(context: {
-        /**
-         * Selection status of the item.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    itemcheckboxicon(context: MultiSelectItemCheckboxIconTemplateContext): TemplateRef<MultiSelectItemCheckboxIconTemplateContext>;
     /**
-     * Custom close icon template.
+     * Custom chip icon template.
+     * @param {Object} context - icon context.
      */
-    closeicon(): TemplateRef<any>;
+    chipicon(context: MultiSelectChipIconTemplateContext): TemplateRef<MultiSelectChipIconTemplateContext>;
     /**
      * Custom remove token icon template.
+     * @deprecated Use chipicon instead.
+     * @param {Object} context - icon context.
      */
-    removetokenicon(): TemplateRef<any>;
+    removetokenicon(context: MultiSelectChipIconTemplateContext): TemplateRef<MultiSelectChipIconTemplateContext>;
 }
 
-export type { MultiSelectBlurEvent, MultiSelectChangeEvent, MultiSelectFilterEvent, MultiSelectFilterOptions, MultiSelectFocusEvent, MultiSelectLazyLoadEvent, MultiSelectPassThrough, MultiSelectPassThroughOptions, MultiSelectRemoveEvent, MultiSelectSelectAllChangeEvent, MultiSelectTemplates };
+export type { MultiSelectBlurEvent, MultiSelectChangeEvent, MultiSelectChipIconTemplateContext, MultiSelectDropdownIconTemplateContext, MultiSelectFilterEvent, MultiSelectFilterOptions, MultiSelectFilterTemplateContext, MultiSelectFocusEvent, MultiSelectGroupTemplateContext, MultiSelectHeaderCheckboxIconTemplateContext, MultiSelectItemCheckboxIconTemplateContext, MultiSelectItemTemplateContext, MultiSelectLazyLoadEvent, MultiSelectLoaderTemplateContext, MultiSelectPassThrough, MultiSelectPassThroughOptions, MultiSelectRemoveEvent, MultiSelectSelectAllChangeEvent, MultiSelectSelectedItemsTemplateContext, MultiSelectTemplates };