primeng 21.0.0-beta.1 → 21.0.0-rc.1

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

@@ -62,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.
@@ -116,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/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/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/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/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 };

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

@@ -136,6 +136,58 @@ interface TreeSelectNodeExpandEvent {
  */
 interface TreeSelectNodeExpandEvent extends TreeSelectNodeCollapseEvent {
 }
+/**
+ * Custom value template context.
+ * @group Interface
+ */
+interface TreeSelectValueTemplateContext {
+    /**
+     * Value of the component.
+     */
+    $implicit: any;
+    /**
+     * Placeholder of the component.
+     */
+    placeholder: string | undefined;
+}
+/**
+ * Custom header/footer template context.
+ * @group Interface
+ */
+interface TreeSelectHeaderTemplateContext {
+    /**
+     * Value of the component.
+     */
+    $implicit: any;
+    /**
+     * Options of the component.
+     */
+    options: TreeNode<any>[] | undefined;
+}
+/**
+ * Custom item toggler icon template context.
+ * @group Interface
+ */
+interface TreeSelectItemTogglerIconTemplateContext {
+    /**
+     * Expanded state of the node.
+     */
+    $implicit: boolean;
+}
+/**
+ * Custom item checkbox icon template context.
+ * @group Interface
+ */
+interface TreeSelectItemCheckboxIconTemplateContext {
+    /**
+     * Selected state of the node.
+     */
+    $implicit: boolean;
+    /**
+     * Partial selection state of the node.
+     */
+    partialSelected: boolean;
+}
 /**
  * Defines valid templates in TreeSelect.
  * @group Templates
@@ -143,82 +195,57 @@ interface TreeSelectNodeExpandEvent extends TreeSelectNodeCollapseEvent {
 interface TreeSelectTemplates {
     /**
      * Custom value template.
-     * @param {Object} context - value data.
-     */
-    value(context: {
-        /**
-         * Value of the component.
-         */
-        $implicit: TreeNode<any> | null;
-        /**
-         * Placeholder of the component.
-         */
-        placeholder: string;
-    }): TemplateRef<{
-        $implicit: TreeNode<any> | null;
-        placeholder: string;
-    }>;
+     * @param {TreeSelectValueTemplateContext} context - value context.
+     */
+    value(context: TreeSelectValueTemplateContext): TemplateRef<TreeSelectValueTemplateContext>;
     /**
      * Custom header template.
-     * @param {Object} context - header data.
-     */
-    header(context: {
-        /**
-         * Value of the component.
-         */
-        $implicit: TreeNode<any> | null | undefined;
-        /**
-         * Placeholder of the component.
-         */
-        options: TreeNode<any>[] | undefined;
-    }): TemplateRef<{
-        $implicit: TreeNode<any> | null;
-        options: TreeNode[] | null | undefined;
-    }>;
-    /**
-     * Custom empty template.
+     * @param {TreeSelectHeaderTemplateContext} context - header context.
      */
-    empty(): TemplateRef<any>;
+    header(context: TreeSelectHeaderTemplateContext): TemplateRef<TreeSelectHeaderTemplateContext>;
     /**
      * Custom footer template.
+     * @param {TreeSelectHeaderTemplateContext} context - footer context.
      */
-    footer(): TemplateRef<any>;
+    footer(context: TreeSelectHeaderTemplateContext): TemplateRef<TreeSelectHeaderTemplateContext>;
+    /**
+     * Custom empty template.
+     */
+    empty(): TemplateRef<void>;
     /**
      * Custom clear icon template.
      */
-    clearicon(): TemplateRef<any>;
+    clearicon(): TemplateRef<void>;
     /**
      * Custom dropdown trigger icon template.
      */
-    triggericon(): TemplateRef<any>;
+    triggericon(): TemplateRef<void>;
+    /**
+     * Custom dropdown icon template.
+     */
+    dropdownicon(): TemplateRef<void>;
     /**
      * Custom filter icon template.
      */
-    filtericon(): TemplateRef<any>;
+    filtericon(): TemplateRef<void>;
     /**
      * Custom close icon template.
      */
-    closeicon(): TemplateRef<any>;
+    closeicon(): TemplateRef<void>;
     /**
-     * Custom node toggler template.
-     * @param {Object} context - toggler icon data.
+     * Custom item toggler icon template.
+     * @param {TreeSelectItemTogglerIconTemplateContext} context - toggler icon context.
      */
-    itemtogglericon(context: {
-        /**
-         * Expanded state of the node.
-         */
-        $implicit: boolean;
-    }): TemplateRef<{
-        $implicit: TreeNode<any> | null;
-    }>;
+    itemtogglericon(context: TreeSelectItemTogglerIconTemplateContext): TemplateRef<TreeSelectItemTogglerIconTemplateContext>;
     /**
-     * Custom node checkbox icon template.
+     * Custom item checkbox icon template.
+     * @param {TreeSelectItemCheckboxIconTemplateContext} context - checkbox icon context.
      */
-    itemcheckboxicon(): TemplateRef<any>;
+    itemcheckboxicon(context: TreeSelectItemCheckboxIconTemplateContext): TemplateRef<TreeSelectItemCheckboxIconTemplateContext>;
     /**
-     * Custom loading icon template.
+     * Custom item loading icon template.
      */
-    itemloadingicon(): TemplateRef<any>;
+    itemloadingicon(): TemplateRef<void>;
 }
 
-export type { TreeSelectNodeCollapseEvent, TreeSelectNodeExpandEvent, TreeSelectPassThrough, TreeSelectPassThroughOptions, TreeSelectTemplates };
+export type { TreeSelectHeaderTemplateContext, TreeSelectItemCheckboxIconTemplateContext, TreeSelectItemTogglerIconTemplateContext, TreeSelectNodeCollapseEvent, TreeSelectNodeExpandEvent, TreeSelectPassThrough, TreeSelectPassThroughOptions, TreeSelectTemplates, TreeSelectValueTemplateContext };