primeng 20.3.0 → 21.0.0-rc.1

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

@@ -1,9 +1,14 @@
 import { TemplateRef } from '@angular/core';
 import { PassThroughOption, PassThrough, FilterMetadata, LazyLoadMeta } from 'primeng/api';
-import { ButtonProps } from 'primeng/types/button';
+import { ButtonPassThrough, ButtonProps } from 'primeng/types/button';
 import { CheckboxPassThrough } from 'primeng/types/checkbox';
 import { PaginatorPassThrough } from 'primeng/types/paginator';
 import { VirtualScrollerPassThrough } from 'primeng/types/scroller';
+import { InputTextPassThrough } from 'primeng/types/inputtext';
+import { SelectPassThrough } from 'primeng/types/select';
+import { InputNumberPassThrough } from 'primeng/types/inputnumber';
+import { DatePickerPassThrough } from 'primeng/types/datepicker';
+import { MotionOptions } from '@primeuix/motion';
 
 /**
  * Custom pass-through(pt) options for ColumnFilter.
@@ -19,7 +24,7 @@ interface ColumnFilterPassThroughOptions<I = unknown> {
     /**
      * Used to pass attributes to the column filter button component.
      */
-    pcColumnFilterButton?: PassThroughOption<HTMLButtonElement, I>;
+    pcColumnFilterButton?: ButtonPassThrough;
     /**
      * Used to pass attributes to the filter overlay element.
      */
@@ -47,7 +52,7 @@ interface ColumnFilterPassThroughOptions<I = unknown> {
     /**
      * Used to pass attributes to the filter operator dropdown component.
      */
-    pcFilterOperatorDropdown?: PassThroughOption<HTMLElement, I>;
+    pcFilterOperatorDropdown?: SelectPassThrough;
     /**
      * Used to pass attributes to the filter rule list element.
      */
@@ -59,15 +64,15 @@ interface ColumnFilterPassThroughOptions<I = unknown> {
     /**
      * Used to pass attributes to the filter constraint dropdown component.
      */
-    pcFilterConstraintDropdown?: PassThroughOption<HTMLElement, I>;
+    pcFilterConstraintDropdown?: SelectPassThrough;
     /**
      * Used to pass attributes to the filter remove rule button component.
      */
-    pcFilterRemoveRuleButton?: PassThroughOption<HTMLButtonElement, I>;
+    pcFilterRemoveRuleButton?: ButtonPassThrough;
     /**
      * Used to pass attributes to the add rule button label.
      */
-    pcAddRuleButtonLabel?: PassThroughOption<HTMLButtonElement, I>;
+    pcAddRuleButtonLabel?: ButtonPassThrough;
     /**
      * Used to pass attributes to the filter button bar element.
      */
@@ -75,19 +80,19 @@ interface ColumnFilterPassThroughOptions<I = unknown> {
     /**
      * Used to pass attributes to the filter clear button component.
      */
-    pcFilterClearButton?: PassThroughOption<HTMLButtonElement, I>;
+    pcFilterClearButton?: ButtonPassThrough;
     /**
      * Used to pass attributes to the filter apply button component.
      */
-    pcFilterApplyButton?: PassThroughOption<HTMLButtonElement, I>;
+    pcFilterApplyButton?: ButtonPassThrough;
     /**
      * Used to pass attributes to the filter input text component.
      */
-    pcFilterInputText?: PassThroughOption<HTMLInputElement, I>;
+    pcFilterInputText?: InputTextPassThrough;
     /**
      * Used to pass attributes to the filter input number component.
      */
-    pcFilterInputNumber?: PassThroughOption<HTMLElement, I>;
+    pcFilterInputNumber?: InputNumberPassThrough;
     /**
      * Used to pass attributes to the filter checkbox component.
      */
@@ -95,7 +100,11 @@ interface ColumnFilterPassThroughOptions<I = unknown> {
     /**
      * Used to pass attributes to the filter datepicker component.
      */
-    pcFilterDatePicker?: PassThroughOption<HTMLElement, I>;
+    pcFilterDatePicker?: DatePickerPassThrough;
+    /**
+     * Used to pass options to the motion component/directive.
+     */
+    motion?: MotionOptions;
 }
 /**
  * Defines valid pass-through options in ColumnFilter.

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

@@ -39,9 +39,9 @@ type TagPassThrough<I = unknown> = PassThrough<I, TagPassThroughOptions<I>>;
  */
 interface TagTemplates {
     /**
-     * Custom icon template
+     * Custom icon template.
      */
-    icon(): TemplateRef<any>;
+    icon(): TemplateRef<void>;
 }
 
 export type { TagPassThrough, TagPassThroughOptions, TagTemplates };

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

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -49,6 +50,10 @@ interface TieredMenuPassThroughOptions<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 TieredMenu.
@@ -57,31 +62,34 @@ interface TieredMenuPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type TieredMenuPassThrough<I = unknown> = PassThrough<I, TieredMenuPassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @group Interface
+ */
+interface TieredMenuItemTemplateContext {
+    /**
+     * Item instance.
+     */
+    $implicit: any;
+    /**
+     * Whether the item has a submenu.
+     */
+    hasSubmenu: boolean;
+}
 /**
  * Defines valid templates in TieredMenu.
  * @group Templates
  */
 interface TieredMenuTemplates {
     /**
-     * Custom template of item.
+     * Custom item template.
+     * @param {TieredMenuItemTemplateContext} context - item context.
      */
-    item(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-        /**
-         * Submenu control of the item.
-         */
-        hasSubmenu: boolean;
-    }): TemplateRef<{
-        $implicit: any;
-        hasSubmenu: boolean;
-    }>;
+    item(context: TieredMenuItemTemplateContext): TemplateRef<TieredMenuItemTemplateContext>;
     /**
-     * Custom template of submenuicon.
+     * Custom submenu icon template.
      */
-    submenuicon(): TemplateRef<any>;
+    submenuicon(): TemplateRef<void>;
 }
 
-export type { TieredMenuPassThrough, TieredMenuPassThroughOptions, TieredMenuTemplates };
+export type { TieredMenuItemTemplateContext, TieredMenuPassThrough, TieredMenuPassThroughOptions, TieredMenuTemplates };

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

@@ -49,47 +49,37 @@ interface TimelinePassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type TimelinePassThrough<I = unknown> = PassThrough<I, TimelinePassThroughOptions<I>>;
+/**
+ * Custom item template context.
+ * @template T Type of item.
+ * @group Interface
+ */
+interface TimelineItemTemplateContext<T = any> {
+    /**
+     * Item instance.
+     */
+    $implicit: T;
+}
 /**
  * Defines valid templates in Timeline.
  * @group Templates
  */
-interface TimelineTemplates {
+interface TimelineTemplates<T = any> {
     /**
      * Custom content template.
-     * @param {Object} context - item data.
+     * @param {TimelineItemTemplateContext} context - item data.
      */
-    content(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    content(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
     /**
      * Custom opposite item template.
-     * @param {Object} context - item data.
+     * @param {TimelineItemTemplateContext} context - item data.
      */
-    opposite(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    opposite(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
     /**
      * Custom marker template.
-     * @param {Object} context - item data.
+     * @param {TimelineItemTemplateContext} context - item data.
      */
-    marker(context: {
-        /**
-         * Item instance.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+    marker(context: TimelineItemTemplateContext<T>): TemplateRef<TimelineItemTemplateContext<T>>;
 }
 
-export type { TimelinePassThrough, TimelinePassThroughOptions, TimelineTemplates };
+export type { TimelineItemTemplateContext, TimelinePassThrough, TimelinePassThroughOptions, TimelineTemplates };

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

@@ -1,4 +1,5 @@
 import { TemplateRef } from '@angular/core';
+import { MotionOptions } from '@primeuix/motion';
 import { PassThroughOption, PassThrough, ToastMessageOptions } from 'primeng/api';
 
 /**
@@ -49,6 +50,10 @@ interface ToastPassThroughOptions<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 Toast.
@@ -57,33 +62,45 @@ interface ToastPassThroughOptions<I = unknown> {
  * @template I Type of instance.
  */
 type ToastPassThrough<I = unknown> = PassThrough<I, ToastPassThroughOptions<I>>;
+/**
+ * Custom message template context.
+ * @group Interface
+ */
+interface ToastMessageTemplateContext {
+    /**
+     * Message instance.
+     */
+    $implicit: ToastMessageOptions | null | undefined;
+}
+/**
+ * Custom headless template context.
+ * @group Interface
+ */
+interface ToastHeadlessTemplateContext {
+    /**
+     * Message instance.
+     */
+    $implicit: ToastMessageOptions | null | undefined;
+    /**
+     * Callback to close the toast.
+     */
+    closeFn: (event: Event) => void;
+}
 /**
  * Defines valid templates in Toast.
  * @group Templates
  */
 interface ToastTemplates {
     /**
-     * Custom template of message.
-     */
-    message(context: {
-        /**
-         * Data of the message.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
-    /**
-     * Headless template.
-     */
-    headless(context: {
-        /**
-         * Data of the message.
-         */
-        $implicit: any;
-    }): TemplateRef<{
-        $implicit: any;
-    }>;
+     * Custom message template.
+     * @param {ToastMessageTemplateContext} context - message context.
+     */
+    message(context: ToastMessageTemplateContext): TemplateRef<ToastMessageTemplateContext>;
+    /**
+     * Custom headless template.
+     * @param {ToastHeadlessTemplateContext} context - headless context.
+     */
+    headless(context: ToastHeadlessTemplateContext): TemplateRef<ToastHeadlessTemplateContext>;
 }
 /**
  * Defines the position type for Toast.
@@ -111,4 +128,4 @@ interface ToastItemCloseEvent extends ToastCloseEvent {
     index: number;
 }
 
-export type { ToastCloseEvent, ToastItemCloseEvent, ToastPassThrough, ToastPassThroughOptions, ToastPositionType, ToastTemplates };
+export type { ToastCloseEvent, ToastHeadlessTemplateContext, ToastItemCloseEvent, ToastMessageTemplateContext, ToastPassThrough, ToastPassThroughOptions, ToastPositionType, ToastTemplates };

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

@@ -46,6 +46,26 @@ interface ToggleButtonChangeEvent {
      */
     checked: boolean;
 }
+/**
+ * Custom icon template context.
+ * @group Interface
+ */
+interface ToggleButtonIconTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
+/**
+ * Custom content template context.
+ * @group Interface
+ */
+interface ToggleButtonContentTemplateContext {
+    /**
+     * Checked state.
+     */
+    $implicit: boolean;
+}
 /**
  * Defines valid templates in ToggleButton.
  * @group Templates
@@ -53,33 +73,14 @@ interface ToggleButtonChangeEvent {
 interface ToggleButtonTemplates {
     /**
      * Custom icon template.
-     * @param {boolean} context - checked state as boolean.
+     * @param {ToggleButtonIconTemplateContext} context - icon context.
      */
-    icon(context: {
-        /**
-         * Checked.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    icon(context: ToggleButtonIconTemplateContext): TemplateRef<ToggleButtonIconTemplateContext>;
     /**
      * Custom content template.
-     * @param {Object} context - content data.
+     * @param {ToggleButtonContentTemplateContext} context - content context.
      */
-    content(context: {
-        /**
-         * Checked.
-         */
-        $implicit: boolean;
-        /**
-         * Label of the component.
-         */
-        label: string;
-    }): TemplateRef<{
-        $implicit: boolean | null;
-        label: string;
-    }>;
+    content(context: ToggleButtonContentTemplateContext): TemplateRef<ToggleButtonContentTemplateContext>;
 }
 
-export type { ToggleButtonChangeEvent, ToggleButtonPassThrough, ToggleButtonPassThroughOptions, ToggleButtonTemplates };
+export type { ToggleButtonChangeEvent, ToggleButtonContentTemplateContext, ToggleButtonIconTemplateContext, ToggleButtonPassThrough, ToggleButtonPassThroughOptions, ToggleButtonTemplates };

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

@@ -1,3 +1,4 @@
+import { TemplateRef } from '@angular/core';
 import { PassThroughOption, PassThrough } from 'primeng/api';
 
 /**
@@ -47,5 +48,26 @@ interface ToggleSwitchChangeEvent {
      */
     checked: boolean;
 }
+/**
+ * Custom handle template context.
+ * @group Interface
+ */
+interface ToggleSwitchHandleTemplateContext {
+    /**
+     * Checked state of the toggle switch.
+     */
+    checked: boolean;
+}
+/**
+ * Defines valid templates in ToggleSwitch.
+ * @group Templates
+ */
+interface ToggleSwitchTemplates {
+    /**
+     * Custom handle template.
+     * @param {ToggleSwitchHandleTemplateContext} context - handle context.
+     */
+    handle(context: ToggleSwitchHandleTemplateContext): TemplateRef<ToggleSwitchHandleTemplateContext>;
+}
 
-export type { ToggleSwitchChangeEvent, ToggleSwitchPassThrough, ToggleSwitchPassThroughOptions };
+export type { ToggleSwitchChangeEvent, ToggleSwitchHandleTemplateContext, ToggleSwitchPassThrough, ToggleSwitchPassThroughOptions, ToggleSwitchTemplates };

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

@@ -39,17 +39,17 @@ type ToolbarPassThrough<I = unknown> = PassThrough<I, ToolbarPassThroughOptions<
  */
 interface ToolbarTemplates {
     /**
-     * Custom start content.
+     * Custom start template.
      */
-    start(): TemplateRef<any>;
+    start(): TemplateRef<void>;
     /**
-     * Custom end content.
+     * Custom end template.
      */
-    end(): TemplateRef<any>;
+    end(): TemplateRef<void>;
     /**
-     * Custom center content.
+     * Custom center template.
      */
-    center(): TemplateRef<any>;
+    center(): TemplateRef<void>;
 }
 
 export type { ToolbarPassThrough, ToolbarPassThroughOptions, ToolbarTemplates };

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

@@ -236,6 +236,62 @@ interface TreeFilterEvent {
      */
     filteredValue: TreeNode<any>[] | null | undefined;
 }
+/**
+ * Custom filter template context.
+ * @group Interface
+ */
+interface TreeFilterTemplateContext {
+    /**
+     * Filter options with filter and reset methods.
+     */
+    $implicit: {
+        filter: (value: string) => void;
+        reset: () => void;
+    };
+}
+/**
+ * Custom loader template context.
+ * @group Interface
+ */
+interface TreeLoaderTemplateContext {
+    /**
+     * Scroller options.
+     * @see {@link ScrollerOptions}
+     */
+    options: ScrollerOptions;
+}
+/**
+ * Custom toggler icon template context.
+ * @group Interface
+ */
+interface TreeTogglerIconTemplateContext {
+    /**
+     * Expanded state of the node.
+     */
+    $implicit: boolean;
+    /**
+     * Loading state of the node.
+     */
+    loading: boolean;
+}
+/**
+ * Custom checkbox icon template context.
+ * @group Interface
+ */
+interface TreeCheckboxIconTemplateContext {
+    /**
+     * Checked state of the node.
+     */
+    $implicit: boolean;
+    /**
+     * Partial selection state of the node.
+     */
+    partialSelected: boolean;
+    /**
+     * Style class of the checkbox.
+     */
+    class: string;
+}
 /**
  * Defines valid templates in Tree.
  * @group Templates
@@ -244,65 +300,43 @@ interface TreeTemplates {
     /**
      * Custom header template.
      */
-    header(): TemplateRef<any>;
+    header(): TemplateRef<void>;
     /**
      * Custom empty message template.
      */
-    empty(): TemplateRef<any>;
+    empty(): TemplateRef<void>;
     /**
      * Custom footer template.
      */
-    footer(): TemplateRef<any>;
+    footer(): TemplateRef<void>;
+    /**
+     * Custom filter template.
+     * @param {TreeFilterTemplateContext} context - filter context.
+     */
+    filter(context: TreeFilterTemplateContext): TemplateRef<TreeFilterTemplateContext>;
     /**
      * Custom loader template.
-     * @param {Object} context - loader options.
-     */
-    loader(context: {
-        /**
-         * Scroller options.
-         * @see {@link ScrollerOptions}
-         */
-        options: ScrollerOptions;
-    }): TemplateRef<{
-        options: ScrollerOptions;
-    }>;
+     * @param {TreeLoaderTemplateContext} context - loader context.
+     */
+    loader(context: TreeLoaderTemplateContext): TemplateRef<TreeLoaderTemplateContext>;
     /**
      * Custom toggler icon template.
-     * @param {Object} context - expand data.
+     * @param {TreeTogglerIconTemplateContext} context - toggler icon context.
      */
-    togglericon(context: {
-        /**
-         * Expanded state of the node.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-    }>;
+    togglericon(context: TreeTogglerIconTemplateContext): TemplateRef<TreeTogglerIconTemplateContext>;
     /**
      * Custom checkbox icon template.
-     * @param {Object} context - node data.
-     */
-    checkboxicon(context: {
-        /**
-         * Checked state of the node.
-         */
-        $implicit: boolean;
-        /**
-         * Partial selection state of the node.
-         */
-        partialSelected: boolean;
-    }): TemplateRef<{
-        $implicit: boolean;
-        partialSelected: boolean;
-    }>;
+     * @param {TreeCheckboxIconTemplateContext} context - checkbox icon context.
+     */
+    checkboxicon(context: TreeCheckboxIconTemplateContext): TemplateRef<TreeCheckboxIconTemplateContext>;
     /**
      * Custom loading icon template.
      */
-    loadingicon(): TemplateRef<any>;
+    loadingicon(): TemplateRef<void>;
     /**
      * Custom filter icon template.
      */
-    filtericon(): TemplateRef<any>;
+    filtericon(): TemplateRef<void>;
 }
 
-export type { TreeFilterEvent, TreeLazyLoadEvent, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDoubleClickEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreePassThrough, TreePassThroughOptions, TreeScrollEvent, TreeScrollIndexChangeEvent, TreeTemplates };
+export type { TreeCheckboxIconTemplateContext, TreeFilterEvent, TreeFilterTemplateContext, TreeLazyLoadEvent, TreeLoaderTemplateContext, TreeNodeCollapseEvent, TreeNodeContextMenuSelectEvent, TreeNodeDoubleClickEvent, TreeNodeDropEvent, TreeNodeExpandEvent, TreeNodeSelectEvent, TreeNodeUnSelectEvent, TreePassThrough, TreePassThroughOptions, TreeScrollEvent, TreeScrollIndexChangeEvent, TreeTemplates, TreeTogglerIconTemplateContext };