Refactor #3879 - For ScrollTop

api-generator/components/scrolltop.js

@@ -22,6 +22,12 @@ const ScrollTopProps = [
         type: 'string',
         default: 'smooth',
         description: 'Defines the scrolling behavi, "smooth" adds an animation and "auto" scrolls with a jump.'
+    },
+    {
+        name: 'pt',
+        type: 'any',
+        default: 'null',
+        description: 'Uses to pass attributes to DOM elements inside the component.'
     }
 ];
 

components/lib/scrolltop/ScrollTop.d.ts

@@ -10,6 +10,49 @@
 import { VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+export declare type ScrollTopPassThroughOptionType = ScrollTopPassThroughAttributes | ((options: ScrollTopPassThroughMethodOptions) => ScrollTopPassThroughAttributes) | null | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface ScrollTopPassThroughMethodOptions {
+    props: ScrollTopProps;
+    state: ScrollTopState;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link ScrollTopProps.pt}
+ */
+export interface ScrollTopPassThroughOptions {
+    /**
+     * Uses to pass attributes to the root's DOM element.
+     */
+    root?: ScrollTopPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the icon's DOM element.
+     */
+    icon?: ScrollTopPassThroughOptionType;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface ScrollTopPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines current inline state in ScrollTop component.
+ */
+export interface ScrollTopState {
+    /**
+     * Current visible state as a boolean.
+     * @defaultValue false
+     */
+    visible: boolean;
+}
+
 /**
  * Defines valid properties in ScrollTop component.
  */
@@ -34,6 +77,11 @@ export interface ScrollTopProps {
      * @defaultValue smooth
      */
     behavior?: string | undefined;
+    /**
+     * Uses to pass attributes to DOM elements inside the component.
+     * @type {ScrollTopPassThroughOptions}
+     */
+    pt?: ScrollTopPassThroughOptions;
 }
 
 /**

components/lib/scrolltop/ScrollTop.vue

@@ -1,18 +1,21 @@
 <template>
     <transition name="p-scrolltop" appear @enter="onEnter" @after-leave="onAfterLeave">
-        <button v-if="visible" :ref="containerRef" :class="containerClass" @click="onClick" type="button" :aria-label="scrollTopAriaLabel">
+        <button v-if="visible" :ref="containerRef" :class="containerClass" @click="onClick" type="button" :aria-label="scrollTopAriaLabel" v-bind="ptm('root')">
             <slot name="icon">
-                <component :is="icon ? 'span' : 'ChevronUpIcon'" :class="['p-scrolltop-icon', icon]"></component>
+                <component :is="icon ? 'span' : 'ChevronUpIcon'" :class="['p-scrolltop-icon', icon]" v-bind="ptm('icon')" />
             </slot>
         </button>
     </transition>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import ChevronUpIcon from 'primevue/icons/chevronup';
 import { DomHandler, ZIndexUtils } from 'primevue/utils';
+
 export default {
     name: 'ScrollTop',
+    extends: BaseComponent,
     scrollListener: null,
     container: null,
     props: {