From 133f9e2e5a5c93e4b5347c4919b6999c5eaf9c99 Mon Sep 17 00:00:00 2001
From: mertsincan <sincan.mert@gmail.com>
Date: Wed, 10 May 2023 12:49:54 +0100
Subject: [PATCH 1/2] Refactor on default pt option

---
 .../lib/basecomponent/BaseComponent.vue       |  24 ++-
 components/lib/config/PrimeVue.d.ts           | 165 +++++++++---------
 components/lib/ts-helpers.d.ts                |   4 +-
 3 files changed, 105 insertions(+), 88 deletions(-)

diff --git a/components/lib/basecomponent/BaseComponent.vue b/components/lib/basecomponent/BaseComponent.vue
index 9e6852891..639711ae0 100644
--- a/components/lib/basecomponent/BaseComponent.vue
+++ b/components/lib/basecomponent/BaseComponent.vue
@@ -1,5 +1,6 @@
 <script>
 import { ObjectUtils } from 'primevue/utils';
+import { mergeProps } from 'vue';
 
 export default {
     name: 'BaseComponent',
@@ -10,17 +11,22 @@ export default {
         }
     },
     methods: {
-        getPTItem(obj = {}, key = '') {
+        getOption(obj = {}, key = '') {
             const fKey = ObjectUtils.convertToFlatCase(key);
 
             return obj[Object.keys(obj).find((k) => ObjectUtils.convertToFlatCase(k) === fKey) || ''];
         },
         getPTValue(obj = {}, key = '', params = {}) {
-            const self = ObjectUtils.getItemValue(this.getPTItem(obj, key), params);
-            const globalComponentPT = this.getPTItem(this.$primevue.config.pt, this.$.type.name);
-            const global = ObjectUtils.getItemValue(this.getPTItem(globalComponentPT, key), params);
+            const self = ObjectUtils.getItemValue(this.getOption(obj, key), params);
+            const globalPT = ObjectUtils.getItemValue(this.getOption(this.defaultPT, key), params);
+            const merged = mergeProps(self, globalPT);
 
-            return { ...global, ...self };
+            return merged;
+            /*
+             * @todo: The 'class' option in self can always be more powerful to style the component easily.
+             *
+             * return self && self['class'] ? { ...merged, ...{ class: self['class'] } } : merged;
+             */
         },
         ptm(key = '', params = {}) {
             return this.getPTValue(this.pt, key, { props: this.$props, state: this.$data, ...params });
@@ -28,6 +34,14 @@ export default {
         ptmo(obj = {}, key = '', params = {}) {
             return this.getPTValue(obj, key, params);
         }
+    },
+    computed: {
+        defaultPT() {
+            return ObjectUtils.getItemValue(this.getOption(this.$primevue.config.pt, this.$.type.name), this.defaultsParams);
+        },
+        defaultsParams() {
+            return { instance: this.$ };
+        }
     }
 };
 </script>
diff --git a/components/lib/config/PrimeVue.d.ts b/components/lib/config/PrimeVue.d.ts
index ad029aa56..b96be7d79 100644
--- a/components/lib/config/PrimeVue.d.ts
+++ b/components/lib/config/PrimeVue.d.ts
@@ -78,6 +78,7 @@ import { ToastPassThroughOptions } from '../toast';
 import { ToolbarPassThroughOptions } from '../toolbar';
 import { TreePassThroughOptions } from '../tree';
 import { TreeSelectPassThroughOptions } from '../treeselect';
+import { DefaultPTOptions } from '../ts-helpers';
 import { VirtualScrollerPassThroughOptions } from '../virtualscroller';
 
 interface PrimeVueConfiguration {
@@ -97,88 +98,88 @@ interface PrimeVueZIndexOptions {
 }
 
 interface PrimeVuePTOptions {
-    accordion?: AccordionPassThroughOptions;
-    accordiontab?: AccordionTabPassThroughOptions;
-    autocomplete?: AutoCompletePassThroughOptions;
-    avatar?: AvatarPassThroughOptions;
-    badge?: BadgePassThroughOptions;
-    blockui?: BlockUIPassThroughOptions;
-    breadcrumb?: BreadcrumbPassThroughOptions;
-    button?: ButtonPassThroughOptions;
-    calendar?: CalendarPassThroughOptions;
-    card?: CardPassThroughOptions;
-    carousel?: CarouselPassThroughOptions;
-    cascadeselect?: CascadeSelectPassThroughOptions;
-    chart?: ChartPassThroughOptions;
-    checkbox?: CheckboxPassThroughOptions;
-    chip?: ChipPassThroughOptions;
-    chips?: ChipsPassThroughOptions;
-    colorpicker?: ColorPickerPassThroughOptions;
-    columngroup?: ColumnGroupPassThroughOptions;
-    confirmdialog?: ConfirmDialogPassThroughOptions;
-    confirmpopup?: ConfirmPopupPassThroughOptions;
-    contextmenu?: ContextMenuPassThroughOptions;
-    datatable?: DataTablePassThroughOptions;
-    dataview?: DataViewPassThroughOptions;
-    dataviewlayoutoptions?: DataViewLayoutOptionsPassThroughOptions;
-    deferredcontent?: DeferredContentPassThroughOptions;
-    divider?: DividerPassThroughOptions;
-    dialog?: DialogPassThroughOptions;
-    dock?: DockPassThroughOptions;
-    dropdown?: DropdownPassThroughOptions;
-    dynamicdialog?: DialogPassThroughOptions;
-    editor?: EditorPassThroughOptions;
-    fieldset?: FieldsetPassThroughOptions;
-    fileupload?: FileUploadPassThroughOptions;
-    galleria?: GalleriaPassThroughOptions;
-    image?: ImagePassThroughOptions;
-    inlinemessage?: InlineMessagePassThroughOptions;
-    inplace?: InplacePassThroughOptions;
-    inputmask?: InputMaskPassThroughOptions;
-    inputnumber?: InputNumberPassThroughOptions;
-    inputswitch?: InputSwitchPassThroughOptions;
-    inputtext?: InputTextPassThroughOptions;
-    knob?: KnobPassThroughOptions;
-    listbox?: ListboxPassThroughOptions;
-    megamenu?: MegaMenuPassThroughOptions;
-    menu?: MenuPassThroughOptions;
-    menubar?: MenubarPassThroughOptions;
-    message?: MessagePassThroughOptions;
-    multiselect?: MultiSelectPassThroughOptions;
-    orderlist?: OrderListPassThroughOptions;
-    organizationchart?: OrganizationChartPassThroughOptions;
-    overlaypanel?: OverlayPanelPassThroughOptions;
-    paginator?: PaginatorPassThroughOptions;
-    panel?: PanelPassThroughOptions;
-    panelmenu?: PanelMenuPassThroughOptions;
-    password?: PasswordPassThroughOptions;
-    picklist?: PickListPassThroughOptions;
-    progressbar?: ProgressBarPassThroughOptions;
-    progressspinner?: ProgressSpinnerPassThroughOptions;
-    radiobutton?: RadioButtonPassThroughOptions;
-    row?: RowPassThroughOptions;
-    scrollpanel?: ScrollPanelPassThroughOptions;
-    scrolltop?: ScrollTopPassThroughOptions;
-    sidebar?: SidebarPassThroughOptions;
-    skeleton?: SkeletonPassThroughOptions;
-    speeddial?: SpeedDialPassThroughOptions;
-    selectbutton?: SelectButtonPassThroughOptions;
-    splitbutton?: SplitButtonPassThroughOptions;
-    splitter?: SplitterPassThroughOptions;
-    steps?: PanelMenuPassThroughOptions;
-    tabmenu?: TabMenuPassThroughOptions;
-    tabpanel?: TabPanelPassThroughOptions;
-    tabview?: TabViewPassThroughOptions;
-    tag?: TagPassThroughOptions;
-    terminal?: TerminalPassThroughOptions;
-    textarea?: TextareaPassThroughOptions;
-    tieredmenu?: TieredMenuPassThroughOptions;
-    timeline?: TimelinePassThroughOptions;
-    toast?: ToastPassThroughOptions;
-    toolbar?: ToolbarPassThroughOptions;
-    tree?: TreePassThroughOptions;
-    treeselect?: TreeSelectPassThroughOptions;
-    virtualscroller?: VirtualScrollerPassThroughOptions;
+    accordion?: DefaultPTOptions<AccordionPassThroughOptions>;
+    accordiontab?: DefaultPTOptions<AccordionTabPassThroughOptions>;
+    autocomplete?: DefaultPTOptions<AutoCompletePassThroughOptions>;
+    avatar?: DefaultPTOptions<AvatarPassThroughOptions>;
+    badge?: DefaultPTOptions<BadgePassThroughOptions>;
+    blockui?: DefaultPTOptions<BlockUIPassThroughOptions>;
+    breadcrumb?: DefaultPTOptions<BreadcrumbPassThroughOptions>;
+    button?: DefaultPTOptions<ButtonPassThroughOptions>;
+    calendar?: DefaultPTOptions<CalendarPassThroughOptions>;
+    card?: DefaultPTOptions<CardPassThroughOptions>;
+    carousel?: DefaultPTOptions<CarouselPassThroughOptions>;
+    cascadeselect?: DefaultPTOptions<CascadeSelectPassThroughOptions>;
+    chart?: DefaultPTOptions<ChartPassThroughOptions>;
+    checkbox?: DefaultPTOptions<CheckboxPassThroughOptions>;
+    chip?: DefaultPTOptions<ChipPassThroughOptions>;
+    chips?: DefaultPTOptions<ChipsPassThroughOptions>;
+    colorpicker?: DefaultPTOptions<ColorPickerPassThroughOptions>;
+    columngroup?: DefaultPTOptions<ColumnGroupPassThroughOptions>;
+    confirmdialog?: DefaultPTOptions<ConfirmDialogPassThroughOptions>;
+    confirmpopup?: DefaultPTOptions<ConfirmPopupPassThroughOptions>;
+    contextmenu?: DefaultPTOptions<ContextMenuPassThroughOptions>;
+    datatable?: DefaultPTOptions<DataTablePassThroughOptions>;
+    dataview?: DefaultPTOptions<DataViewPassThroughOptions>;
+    dataviewlayoutoptions?: DefaultPTOptions<DataViewLayoutOptionsPassThroughOptions>;
+    deferredcontent?: DefaultPTOptions<DeferredContentPassThroughOptions>;
+    divider?: DefaultPTOptions<DividerPassThroughOptions>;
+    dialog?: DefaultPTOptions<DialogPassThroughOptions>;
+    dock?: DefaultPTOptions<DockPassThroughOptions>;
+    dropdown?: DefaultPTOptions<DropdownPassThroughOptions>;
+    dynamicdialog?: DefaultPTOptions<DialogPassThroughOptions>;
+    editor?: DefaultPTOptions<EditorPassThroughOptions>;
+    fieldset?: DefaultPTOptions<FieldsetPassThroughOptions>;
+    fileupload?: DefaultPTOptions<FileUploadPassThroughOptions>;
+    galleria?: DefaultPTOptions<GalleriaPassThroughOptions>;
+    image?: DefaultPTOptions<ImagePassThroughOptions>;
+    inlinemessage?: DefaultPTOptions<InlineMessagePassThroughOptions>;
+    inplace?: DefaultPTOptions<InplacePassThroughOptions>;
+    inputmask?: DefaultPTOptions<InputMaskPassThroughOptions>;
+    inputnumber?: DefaultPTOptions<InputNumberPassThroughOptions>;
+    inputswitch?: DefaultPTOptions<InputSwitchPassThroughOptions>;
+    inputtext?: DefaultPTOptions<InputTextPassThroughOptions>;
+    knob?: DefaultPTOptions<KnobPassThroughOptions>;
+    listbox?: DefaultPTOptions<ListboxPassThroughOptions>;
+    megamenu?: DefaultPTOptions<MegaMenuPassThroughOptions>;
+    menu?: DefaultPTOptions<MenuPassThroughOptions>;
+    menubar?: DefaultPTOptions<MenubarPassThroughOptions>;
+    message?: DefaultPTOptions<MessagePassThroughOptions>;
+    multiselect?: DefaultPTOptions<MultiSelectPassThroughOptions>;
+    orderlist?: DefaultPTOptions<OrderListPassThroughOptions>;
+    organizationchart?: DefaultPTOptions<OrganizationChartPassThroughOptions>;
+    overlaypanel?: DefaultPTOptions<OverlayPanelPassThroughOptions>;
+    paginator?: DefaultPTOptions<PaginatorPassThroughOptions>;
+    panel?: DefaultPTOptions<PanelPassThroughOptions>;
+    panelmenu?: DefaultPTOptions<PanelMenuPassThroughOptions>;
+    password?: DefaultPTOptions<PasswordPassThroughOptions>;
+    picklist?: DefaultPTOptions<PickListPassThroughOptions>;
+    progressbar?: DefaultPTOptions<ProgressBarPassThroughOptions>;
+    progressspinner?: DefaultPTOptions<ProgressSpinnerPassThroughOptions>;
+    radiobutton?: DefaultPTOptions<RadioButtonPassThroughOptions>;
+    row?: DefaultPTOptions<RowPassThroughOptions>;
+    scrollpanel?: DefaultPTOptions<ScrollPanelPassThroughOptions>;
+    scrolltop?: DefaultPTOptions<ScrollTopPassThroughOptions>;
+    sidebar?: DefaultPTOptions<SidebarPassThroughOptions>;
+    skeleton?: DefaultPTOptions<SkeletonPassThroughOptions>;
+    speeddial?: DefaultPTOptions<SpeedDialPassThroughOptions>;
+    selectbutton?: DefaultPTOptions<SelectButtonPassThroughOptions>;
+    splitbutton?: DefaultPTOptions<SplitButtonPassThroughOptions>;
+    splitter?: DefaultPTOptions<SplitterPassThroughOptions>;
+    steps?: DefaultPTOptions<PanelMenuPassThroughOptions>;
+    tabmenu?: DefaultPTOptions<TabMenuPassThroughOptions>;
+    tabpanel?: DefaultPTOptions<TabPanelPassThroughOptions>;
+    tabview?: DefaultPTOptions<TabViewPassThroughOptions>;
+    tag?: DefaultPTOptions<TagPassThroughOptions>;
+    terminal?: DefaultPTOptions<TerminalPassThroughOptions>;
+    textarea?: DefaultPTOptions<TextareaPassThroughOptions>;
+    tieredmenu?: DefaultPTOptions<TieredMenuPassThroughOptions>;
+    timeline?: DefaultPTOptions<TimelinePassThroughOptions>;
+    toast?: DefaultPTOptions<ToastPassThroughOptions>;
+    toolbar?: DefaultPTOptions<ToolbarPassThroughOptions>;
+    tree?: DefaultPTOptions<TreePassThroughOptions>;
+    treeselect?: DefaultPTOptions<TreeSelectPassThroughOptions>;
+    virtualscroller?: DefaultPTOptions<VirtualScrollerPassThroughOptions>;
 }
 
 interface PrimeVueLocaleAriaOptions {
diff --git a/components/lib/ts-helpers.d.ts b/components/lib/ts-helpers.d.ts
index 4c407beed..a2e9f13b9 100644
--- a/components/lib/ts-helpers.d.ts
+++ b/components/lib/ts-helpers.d.ts
@@ -1,4 +1,4 @@
-import { AllowedComponentProps, ComponentCustomProps, ObjectEmitsOptions, VNodeProps } from 'vue';
+import { AllowedComponentProps, ComponentCustomProps, ObjectEmitsOptions, VNode, VNodeProps } from 'vue';
 
 declare type PublicProps = VNodeProps & AllowedComponentProps & ComponentCustomProps;
 
@@ -32,3 +32,5 @@ export declare type Booleanish = boolean | 'true' | 'false';
 export declare type Numberish = number | string;
 
 export declare type Nullable<T = void> = T | null | undefined;
+
+export declare type DefaultPTOptions<T = void> = T | ((instance?: VNode) => T | undefined) | undefined;

From 52e592363b88eda7128c23a84f7b25652b947f48 Mon Sep 17 00:00:00 2001
From: GitHub Actions Bot <>
Date: Wed, 10 May 2023 11:50:43 +0000
Subject: [PATCH 2/2] Update API doc

---
 doc/common/apidoc/index.json | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json
index 8aef540b3..0fe614b98 100644
--- a/doc/common/apidoc/index.json
+++ b/doc/common/apidoc/index.json
@@ -39674,6 +39674,9 @@
                 },
                 "Nullable": {
                     "values": "T | null | undefined"
+                },
+                "DefaultPTOptions": {
+                    "values": "T | (instance: VNode) => undefined | undefined"
                 }
             }
         }