Fixed #4929 - Add parent param to all pt method options

primefaces · Dec 5, 2023 · eb00b8e · eb00b8e
1 parent 1a4bba8
commit eb00b8e
Show file tree

Hide file tree

Showing 104 changed files with 399 additions and 158 deletions.
diff --git a/components/lib/accordion/Accordion.d.ts b/components/lib/accordion/Accordion.d.ts
@@ -31,6 +31,10 @@ export interface AccordionPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: AccordionState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/accordion/Accordion.vue b/components/lib/accordion/Accordion.vue
@@ -106,6 +106,7 @@ export default {
             const tabMetaData = {
                 props: tab.props || {},
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },

diff --git a/components/lib/accordiontab/AccordionTab.d.ts b/components/lib/accordiontab/AccordionTab.d.ts
@@ -8,7 +8,6 @@
  *
  */
 import { AnchorHTMLAttributes, HTMLAttributes, TransitionProps, VNode } from 'vue';
-import { AccordionPassThroughOptions } from '../accordion';
 import { PassThroughOptions } from '../passthrough';
 import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
 
@@ -29,9 +28,9 @@ export interface AccordionTabPassThroughMethodOptions {
      */
     props: AccordionTabProps;
     /**
-     * Defines parent instance.
+     * Defines parent options.
      */
-    parent: AccordionPassThroughOptions;
+    parent: any;
     /**
      * Defines current options.
      */

diff --git a/components/lib/autocomplete/AutoComplete.d.ts b/components/lib/autocomplete/AutoComplete.d.ts
@@ -38,6 +38,10 @@ export interface AutoCompletePassThroughMethodOptions {
      * Defines current options.
      */
     context: AutoCompleteContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/avatar/Avatar.d.ts b/components/lib/avatar/Avatar.d.ts
@@ -7,7 +7,6 @@
  * @module avatar
  */
 import { VNode } from 'vue';
-import { AvatarGroupPassThroughOptions } from '../avatargroup';
 import { ComponentHooks } from '../basecomponent';
 import { PassThroughOptions } from '../passthrough';
 import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
@@ -27,9 +26,9 @@ export interface AvatarPassThroughMethodOptions {
      */
     props: AvatarProps;
     /**
-     * Defines parent instance.
+     * Defines parent options.
      */
-    parent: AvatarGroupPassThroughOptions;
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/avatar/Avatar.vue b/components/lib/avatar/Avatar.vue
@@ -1,10 +1,10 @@
 <template>
-    <div :class="cx('root')" :aria-labelledby="ariaLabelledby" :aria-label="ariaLabel" v-bind="getPTOptions('root')" data-pc-name="avatar">
+    <div :class="cx('root')" :aria-labelledby="ariaLabelledby" :aria-label="ariaLabel" v-bind="ptm('root')" data-pc-name="avatar">
         <slot>
-            <span v-if="label" :class="cx('label')" v-bind="getPTOptions('label')">{{ label }}</span>
+            <span v-if="label" :class="cx('label')" v-bind="ptm('label')">{{ label }}</span>
             <component v-else-if="$slots.icon" :is="$slots.icon" :class="cx('icon')" />
-            <span v-else-if="icon" :class="[cx('icon'), icon]" v-bind="getPTOptions('icon')" />
-            <img v-else-if="image" :src="image" :alt="ariaLabel" @error="onError" v-bind="getPTOptions('image')" />
+            <span v-else-if="icon" :class="[cx('icon'), icon]" v-bind="ptm('icon')" />
+            <img v-else-if="image" :src="image" :alt="ariaLabel" @error="onError" v-bind="ptm('image')" />
         </slot>
     </div>
 </template>
@@ -19,13 +19,6 @@ export default {
     methods: {
         onError(event) {
             this.$emit('error', event);
-        },
-        getPTOptions(key) {
-            return this.ptm(key, {
-                parent: {
-                    instance: this.$parent
-                }
-            });
         }
     }
 };

diff --git a/components/lib/badge/Badge.vue b/components/lib/badge/Badge.vue
@@ -1,5 +1,5 @@
 <template>
-    <span :class="cx('root')" v-bind="getPTOptions('root')" data-pc-name="badge">
+    <span :class="cx('root')" v-bind="ptm('root')" data-pc-name="badge">
         <slot>{{ value }}</slot>
     </span>
 </template>
@@ -9,16 +9,6 @@ import BaseBadge from './BaseBadge.vue';
 
 export default {
     name: 'Badge',
-    extends: BaseBadge,
-    methods: {
-        getPTOptions(key) {
-            return this.ptm(key, {
-                parent: {
-                    props: this.$parent?.$props,
-                    state: this.$parent?.$data
-                }
-            });
-        }
-    }
+    extends: BaseBadge
 };
 </script>
diff --git a/components/lib/badgedirective/BadgeDirective.d.ts b/components/lib/badgedirective/BadgeDirective.d.ts
@@ -18,6 +18,10 @@ export declare type BadgeDirectivePassThroughOptionType = BadgeDirectivePassThro
  */
 export interface BadgePassThroughMethodOptions {
     context: BadgeContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/basecomponent/BaseComponent.vue b/components/lib/basecomponent/BaseComponent.vue
@@ -202,7 +202,20 @@ export default {
             return this.unstyled !== undefined ? this.unstyled : this.$config?.unstyled;
         },
         $params() {
-            return { instance: this, props: this.$props, state: this.$data, parentInstance: this.$parentInstance };
+            const parentInstance = this.$parentInstance || this.$parent;
+
+            return {
+                instance: this,
+                props: this.$props,
+                state: this.$data,
+                parent: {
+                    instance: parentInstance,
+                    props: parentInstance?.$props,
+                    state: parentInstance?.$data
+                },
+                /* @deprecated since v3.43.0. Use the `parent.instance` instead of the `parentInstance`.*/
+                parentInstance
+            };
         },
         $style() {
             return { classes: undefined, inlineStyles: undefined, loadStyle: () => {}, loadCustomStyle: () => {}, ...(this._getHostInstance(this) || {}).$style, ...this.$options.style };

diff --git a/components/lib/blockui/BlockUI.d.ts b/components/lib/blockui/BlockUI.d.ts
@@ -30,6 +30,10 @@ export interface BlockUIPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: BlockUIState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/breadcrumb/Breadcrumb.d.ts b/components/lib/breadcrumb/Breadcrumb.d.ts
@@ -31,6 +31,10 @@ export interface BreadcrumbPassThroughMethodOptions {
      * Defines current options.
      */
     context: BreadcrumbContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/button/Button.vue b/components/lib/button/Button.vue
@@ -26,10 +26,6 @@ export default {
     methods: {
         getPTOptions(key) {
             return this.ptm(key, {
-                parent: {
-                    props: this.$parent?.$props,
-                    state: this.$parent?.$data
-                },
                 context: {
                     disabled: this.disabled
                 }

diff --git a/components/lib/calendar/Calendar.d.ts b/components/lib/calendar/Calendar.d.ts
@@ -37,6 +37,10 @@ export interface CalendarPassThroughMethodOptions {
      * Defines current options.
      */
     context: CalendarContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/carousel/Carousel.d.ts b/components/lib/carousel/Carousel.d.ts
@@ -34,6 +34,10 @@ export interface CarouselPassThroughMethodOptions {
      * Defines current options.
      */
     context: CarouselContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/cascadeselect/CascadeSelect.d.ts b/components/lib/cascadeselect/CascadeSelect.d.ts
@@ -32,6 +32,10 @@ export interface CascadeSelectPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: CascadeSelectState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/chart/Chart.d.ts b/components/lib/chart/Chart.d.ts
@@ -26,6 +26,10 @@ export interface ChartPassThroughMethodOptions {
      * Defines valid properties.
      */
     props: ChartProps;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/checkbox/Checkbox.d.ts b/components/lib/checkbox/Checkbox.d.ts
@@ -34,6 +34,10 @@ export interface CheckboxPassThroughMethodOptions {
      * Defines current options.
      */
     context: CheckboxContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/chip/Chip.d.ts b/components/lib/chip/Chip.d.ts
@@ -30,6 +30,10 @@ export interface ChipPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: ChipState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/chips/Chips.d.ts b/components/lib/chips/Chips.d.ts
@@ -30,6 +30,10 @@ export interface ChipsPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: ChipsState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/colorpicker/ColorPicker.d.ts b/components/lib/colorpicker/ColorPicker.d.ts
@@ -32,6 +32,10 @@ export interface ColorPickerPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: ColorPickerState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/column/Column.d.ts b/components/lib/column/Column.d.ts
@@ -33,9 +33,9 @@ export interface ColumnPassThroughMethodOptions {
      */
     props: ColumnProps;
     /**
-     * Defines parent instance.
+     * Defines parent options.
      */
-    parent: DataTablePassThroughOptions;
+    parent: any;
     /**
      * Defines current options.
      */

diff --git a/components/lib/columngroup/ColumnGroup.d.ts b/components/lib/columngroup/ColumnGroup.d.ts
@@ -6,7 +6,6 @@
  * @module columngroup
  */
 import { ComponentHooks } from '../basecomponent';
-import { DataTablePassThroughOptions } from '../datatable';
 import { PassThroughOptions } from '../passthrough';
 import { ClassComponent, GlobalComponentConstructor, PassThrough } from '../ts-helpers';
 
@@ -25,9 +24,9 @@ export interface ColumnGroupPassThroughMethodOptions {
      */
     props: ColumnGroupProps;
     /**
-     * Defines parent instance.
+     * Defines parent options.
      */
-    parent: DataTablePassThroughOptions;
+    parent: any;
     /**
      * Defines current options.
      */

diff --git a/components/lib/confirmdialog/ConfirmDialog.d.ts b/components/lib/confirmdialog/ConfirmDialog.d.ts
@@ -32,6 +32,10 @@ export interface ConfirmDialogPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: ConfirmDialogState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/confirmpopup/ConfirmPopup.d.ts b/components/lib/confirmpopup/ConfirmPopup.d.ts
@@ -34,6 +34,10 @@ export interface ConfirmPopupPassThroughMethodOptions {
      * Defines current inline state.
      */
     state: ConfirmPopupState;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/contextmenu/ContextMenu.d.ts b/components/lib/contextmenu/ContextMenu.d.ts
@@ -38,6 +38,10 @@ export interface ContextMenuPassThroughMethodOptions {
      * Defines current options.
      */
     context: ContextMenuContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/datatable/BodyCell.vue b/components/lib/datatable/BodyCell.vue
@@ -222,6 +222,7 @@ export default {
             const columnMetaData = {
                 props: this.column.props,
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },

diff --git a/components/lib/datatable/ColumnFilter.vue b/components/lib/datatable/ColumnFilter.vue
@@ -330,6 +330,7 @@ export default {
             const columnMetaData = {
                 props: this.column.props,
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },

diff --git a/components/lib/datatable/DataTable.d.ts b/components/lib/datatable/DataTable.d.ts
@@ -41,6 +41,10 @@ export interface DataTablePassThroughMethodOptions {
      * Defines current options.
      */
     context: DataTableContext;
+    /**
+     * Defines parent options.
+     */
+    parent: any;
     /**
      * Defines passthrough(pt) options in global config.
      */

diff --git a/components/lib/datatable/FooterCell.vue b/components/lib/datatable/FooterCell.vue
@@ -47,6 +47,7 @@ export default {
             const columnMetaData = {
                 props: this.column.props,
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },

diff --git a/components/lib/datatable/HeaderCell.vue b/components/lib/datatable/HeaderCell.vue
@@ -206,6 +206,7 @@ export default {
             const columnMetaData = {
                 props: this.column.props,
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },

diff --git a/components/lib/datatable/HeaderCheckbox.vue b/components/lib/datatable/HeaderCheckbox.vue
@@ -50,6 +50,7 @@ export default {
             const columnMetaData = {
                 props: this.column.props,
                 parent: {
+                    instance: this,
                     props: this.$props,
                     state: this.$data
                 },