Refactor #3924 - For Paginator

api-generator/components/paginator.js

@@ -46,6 +46,12 @@ const PaginatorProps = [
         type: 'boolean',
         default: 'true',
         description: 'Whether to show the paginator even there is only one page.'
+    },
+    {
+        name: 'pt',
+        type: 'any',
+        default: 'null',
+        description: 'Uses to pass attributes to DOM elements inside the component.'
     }
 ];
 

components/lib/config/PrimeVue.d.ts

@@ -43,6 +43,7 @@ import { MenubarPassThroughOptions } from '../menubar';
 import { MessagePassThroughOptions } from '../message';
 import { MultiSelectPassThroughOptions } from '../multiselect';
 import { OverlayPanelPassThroughOptions } from '../overlaypanel';
+import { PaginatorPassThroughOptions } from '../paginator';
 import { PanelPassThroughOptions } from '../panel';
 import { PanelMenuPassThroughOptions } from '../panelmenu';
 import { PasswordPassThroughOptions } from '../password';
@@ -132,6 +133,7 @@ interface PrimeVuePTOptions {
     message?: MessagePassThroughOptions;
     multiselect?: MultiSelectPassThroughOptions;
     overlaypanel?: OverlayPanelPassThroughOptions;
+    paginator?: PaginatorPassThroughOptions;
     panel?: PanelPassThroughOptions;
     panelmenu?: PanelMenuPassThroughOptions;
     password?: PasswordPassThroughOptions;

components/lib/paginator/CurrentPageReport.vue

@@ -1,9 +1,13 @@
 <template>
-    <span class="p-paginator-current">{{ text }}</span>
+    <span class="p-paginator-current" v-bind="ptm('current')">{{ text }}</span>
 </template>
+
 <script>
+import BaseComponent from 'primevue/basecomponent';
+
 export default {
     name: 'CurrentPageReport',
+    extends: BaseComponent,
     props: {
         pageCount: {
             type: Number,

components/lib/paginator/FirstPageLink.vue

@@ -1,21 +1,32 @@
 <template>
-    <button v-ripple :class="containerClass" type="button">
+    <button v-ripple :class="containerClass" type="button" v-bind="getPTOptions('firstPageButton')">
-        <component :is="template || 'AngleDoubleLeftIcon'" class="p-paginator-icon" />
+        <component :is="template || 'AngleDoubleLeftIcon'" class="p-paginator-icon" v-bind="getPTOptions('firstPageIcon')" />
     </button>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import AngleDoubleLeftIcon from 'primevue/icons/angledoubleleft';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'FirstPageLink',
+    extends: BaseComponent,
     props: {
         template: {
             type: Function,
             default: null
         }
     },
+    methods: {
+        getPTOptions(key) {
+            return this.ptm(key, {
+                context: {
+                    disabled: this.$attrs.disabled
+                }
+            });
+        }
+    },
     computed: {
         containerClass() {
             return [

components/lib/paginator/JumpToPageDropdown.vue

@@ -1,12 +1,14 @@
 <template>
-    <JTPDropdown :modelValue="page" :options="pageOptions" optionLabel="label" optionValue="value" @update:modelValue="onChange($event)" class="p-paginator-page-options" :disabled="disabled"></JTPDropdown>
+    <JTPDropdown :modelValue="page" :options="pageOptions" optionLabel="label" optionValue="value" @update:modelValue="onChange($event)" class="p-paginator-page-options" :disabled="disabled" :pt="ptm('JTPDropdown')"></JTPDropdown>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import Dropdown from 'primevue/dropdown';
 
 export default {
     name: 'JumpToPageDropdown',
+    extends: BaseComponent,
     emits: ['page-change'],
     props: {
         page: Number,

components/lib/paginator/JumpToPageInput.vue

@@ -1,12 +1,14 @@
 <template>
-    <JTPInput ref="jtpInput" :modelValue="d_page" class="p-paginator-page-input" :aria-label="inputArialabel" :disabled="disabled" @update:modelValue="onChange"></JTPInput>
+    <JTPInput ref="jtpInput" :modelValue="d_page" class="p-paginator-page-input" :aria-label="inputArialabel" :disabled="disabled" @update:modelValue="onChange" :pt="ptm('JTPInput')"></JTPInput>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import InputNumber from 'primevue/inputnumber';
 
 export default {
     name: 'JumpToPageInput',
+    extends: BaseComponent,
     inheritAttrs: false,
     emits: ['page-change'],
     props: {

components/lib/paginator/LastPageLink.vue

@@ -1,21 +1,32 @@
 <template>
-    <button v-ripple :class="containerClass" type="button">
+    <button v-ripple :class="containerClass" type="button" v-bind="getPTOptions('lastPageButton')">
-        <component :is="template || 'AngleDoubleRightIcon'" class="p-paginator-icon" />
+        <component :is="template || 'AngleDoubleRightIcon'" class="p-paginator-icon" v-bind="getPTOptions('lastPageIcon')" />
     </button>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import AngleDoubleRightIcon from 'primevue/icons/angledoubleright';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'LastPageLink',
+    extends: BaseComponent,
     props: {
         template: {
             type: Function,
             default: null
         }
     },
+    methods: {
+        getPTOptions(key) {
+            return this.ptm(key, {
+                context: {
+                    disabled: this.$attrs.disabled
+                }
+            });
+        }
+    },
     computed: {
         containerClass() {
             return [

components/lib/paginator/NextPageLink.vue

@@ -1,21 +1,32 @@
 <template>
-    <button v-ripple :class="containerClass" type="button">
+    <button v-ripple :class="containerClass" type="button" v-bind="getPTOptions('nextPageButton')">
-        <component :is="template || 'AngleRightIcon'" class="p-paginator-icon" />
+        <component :is="template || 'AngleRightIcon'" class="p-paginator-icon" v-bind="getPTOptions('nextPageIcon')" />
     </button>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import AngleRightIcon from 'primevue/icons/angleright';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'NextPageLink',
+    extends: BaseComponent,
     props: {
         template: {
             type: Function,
             default: null
         }
     },
+    methods: {
+        getPTOptions(key) {
+            return this.ptm(key, {
+                context: {
+                    disabled: this.$attrs.disabled
+                }
+            });
+        }
+    },
     computed: {
         containerClass() {
             return [

components/lib/paginator/PageLinks.vue

@@ -1,5 +1,5 @@
 <template>
-    <span class="p-paginator-pages">
+    <span class="p-paginator-pages" v-bind="ptm('pages')">
         <button
             v-for="pageLink of value"
             :key="pageLink"
@@ -9,16 +9,20 @@
             :aria-label="ariaPageLabel(pageLink)"
             :aria-current="pageLink - 1 === page ? 'page' : undefined"
             @click="onPageLinkClick($event, pageLink)"
+            v-bind="getPTOptions(pageLink - 1, 'pageButton')"
         >
             {{ pageLink }}
         </button>
     </span>
 </template>
+
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'PageLinks',
+    extends: BaseComponent,
     inheritAttrs: false,
     emits: ['click'],
     props: {
@@ -26,6 +30,13 @@ export default {
         page: Number
     },
     methods: {
+        getPTOptions(pageLink, key) {
+            return this.ptm(key, {
+                context: {
+                    active: pageLink === this.page
+                }
+            });
+        },
         onPageLinkClick(event, pageLink) {
             this.$emit('click', {
                 originalEvent: event,
@@ -36,7 +47,6 @@ export default {
             return this.$primevue.config.locale.aria ? this.$primevue.config.locale.aria.pageLabel.replace(/{page}/g, value) : undefined;
         }
     },
-    computed: {},
     directives: {
         ripple: Ripple
     }

components/lib/paginator/Paginator.d.ts

@@ -8,8 +8,136 @@
  *
  */
 import { VNode } from 'vue';
+import { DropdownPassThroughOptionType } from '../dropdown';
+import { InputNumberPassThroughOptionType } from '../inputnumber';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+export declare type PaginatorPassThroughOptionType = PaginatorPassThroughAttributes | ((options: PaginatorPassThroughMethodOptions) => PaginatorPassThroughAttributes) | null | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface PaginatorPassThroughMethodOptions {
+    props: PaginatorProps;
+    state: PaginatorState;
+    context: PaginatorContext;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link PaginatorProps.pt}
+ */
+export interface PaginatorPassThroughOptions {
+    /**
+     * Uses to pass attributes to the root's DOM element.
+     */
+    root?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the left's DOM element.
+     */
+    left?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the first page button's DOM element.
+     */
+    firstPageButton?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the first page icon's DOM element.
+     */
+    firstPageIcon?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the prev page button's DOM element.
+     */
+    prevPageButton?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the prev page icon's DOM element.
+     */
+    prevPageIcon?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the next page button's DOM element.
+     */
+    nextPageButton?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the next page icon's DOM element.
+     */
+    nextPageIcon?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the last page button's DOM element.
+     */
+    lastPageButton?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the last page icon's DOM element.
+     */
+    lastPageIcon?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the pages's DOM element.
+     */
+    pages?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the page button's DOM element.
+     */
+    pageButton?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the current's DOM element.
+     */
+    current?: PaginatorPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the Dropdown component.
+     * @see {@link DropdownPassThroughOptionType}
+     */
+    RPPDropdown?: DropdownPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the Dropdown component.
+     * @see {@link DropdownPassThroughOptionType}
+     */
+    JTPDropdown?: DropdownPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the Dropdown component.
+     * @see {@link InputNumberPassThroughOptionType}
+     */
+    JTPInput?: InputNumberPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the end's DOM element.
+     */
+    end?: PaginatorPassThroughOptionType;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface PaginatorPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines current inline state in Paginator component.
+ */
+export interface PaginatorState {
+    /**
+     * Current index of first record as a number.
+     */
+    d_first: number;
+    /**
+     * Current number of rows to display in new page as a number.
+     */
+    d_rows: number;
+}
+
+/**
+ * Defines current options in Paginator component.
+ */
+export interface PaginatorContext {
+    /**
+     * Current active state as a boolean.
+     * @defaultValue false
+     */
+    active: boolean;
+    /**
+     * Current disabled state of the button as a boolean.
+     * @defaultValue false
+     */
+    disabled: boolean;
+}
+
 /**
  * Paginator page state metadata.
  */
@@ -92,6 +220,11 @@ export interface PaginatorProps {
      * @defaultValue true
      */
     alwaysShow?: boolean | undefined;
+    /**
+     * Uses to pass attributes to DOM elements inside the component.
+     * @type {PaginatorPassThroughOptions}
+     */
+    pt?: PaginatorPassThroughOptions;
 }
 
 /**

components/lib/paginator/Paginator.vue

@@ -1,15 +1,15 @@
 <template>
-    <nav v-if="alwaysShow ? true : pageLinks && pageLinks.length > 1">
+    <nav v-if="alwaysShow ? true : pageLinks && pageLinks.length > 1" v-bind="ptm('root')">
-        <div v-for="(value, key) in templateItems" :key="key" ref="paginator" class="p-paginator p-component" :class="getPaginatorClasses(key)">
+        <div v-for="(value, key) in templateItems" :key="key" ref="paginator" class="p-paginator p-component" :class="getPaginatorClasses(key)" v-bind="ptm('paginator')">
-            <div v-if="$slots.start" class="p-paginator-left-content">
+            <div v-if="$slots.start" class="p-paginator-left-content" v-bind="ptm('left')">
                 <slot name="start" :state="currentState"></slot>
             </div>
             <template v-for="item in value" :key="item">
-                <FirstPageLink v-if="item === 'FirstPageLink'" :aria-label="getAriaLabel('firstPageLabel')" :template="$slots.firstpagelinkicon" @click="changePageToFirst($event)" :disabled="isFirstPage || empty" />
+                <FirstPageLink v-if="item === 'FirstPageLink'" :aria-label="getAriaLabel('firstPageLabel')" :template="$slots.firstpagelinkicon" @click="changePageToFirst($event)" :disabled="isFirstPage || empty" :pt="pt" />
-                <PrevPageLink v-else-if="item === 'PrevPageLink'" :aria-label="getAriaLabel('prevPageLabel')" :template="$slots.prevpagelinkicon" @click="changePageToPrev($event)" :disabled="isFirstPage || empty" />
+                <PrevPageLink v-else-if="item === 'PrevPageLink'" :aria-label="getAriaLabel('prevPageLabel')" :template="$slots.prevpagelinkicon" @click="changePageToPrev($event)" :disabled="isFirstPage || empty" :pt="pt" />
-                <NextPageLink v-else-if="item === 'NextPageLink'" :aria-label="getAriaLabel('nextPageLabel')" :template="$slots.nextpagelinkicon" @click="changePageToNext($event)" :disabled="isLastPage || empty" />
+                <NextPageLink v-else-if="item === 'NextPageLink'" :aria-label="getAriaLabel('nextPageLabel')" :template="$slots.nextpagelinkicon" @click="changePageToNext($event)" :disabled="isLastPage || empty" :pt="pt" />
-                <LastPageLink v-else-if="item === 'LastPageLink'" :aria-label="getAriaLabel('lastPageLabel')" :template="$slots.lastpagelinkicon" @click="changePageToLast($event)" :disabled="isLastPage || empty" />
+                <LastPageLink v-else-if="item === 'LastPageLink'" :aria-label="getAriaLabel('lastPageLabel')" :template="$slots.lastpagelinkicon" @click="changePageToLast($event)" :disabled="isLastPage || empty" :pt="pt" />
-                <PageLinks v-else-if="item === 'PageLinks'" :aria-label="getAriaLabel('pageLabel')" :value="pageLinks" :page="page" @click="changePageLink($event)" />
+                <PageLinks v-else-if="item === 'PageLinks'" :aria-label="getAriaLabel('pageLabel')" :value="pageLinks" :page="page" @click="changePageLink($event)" :pt="pt" />
                 <CurrentPageReport
                     v-else-if="item === 'CurrentPageReport'"
                     aria-live="polite"
@@ -20,12 +20,21 @@
                     :first="d_first"
                     :rows="d_rows"
                     :totalRecords="totalRecords"
+                    :pt="pt"
                 />
-                <RowsPerPageDropdown v-else-if="item === 'RowsPerPageDropdown' && rowsPerPageOptions" :aria-label="getAriaLabel('rowsPerPageLabel')" :rows="d_rows" :options="rowsPerPageOptions" @rows-change="onRowChange($event)" :disabled="empty" />
+                <RowsPerPageDropdown
-                <JumpToPageDropdown v-else-if="item === 'JumpToPageDropdown'" :aria-label="getAriaLabel('jumpToPageDropdownLabel')" :page="page" :pageCount="pageCount" @page-change="changePage($event)" :disabled="empty" />
+                    v-else-if="item === 'RowsPerPageDropdown' && rowsPerPageOptions"
-                <JumpToPageInput v-else-if="item === 'JumpToPageInput'" :page="currentPage" @page-change="changePage($event)" :disabled="empty" />
+                    :aria-label="getAriaLabel('rowsPerPageLabel')"
+                    :rows="d_rows"
+                    :options="rowsPerPageOptions"
+                    @rows-change="onRowChange($event)"
+                    :disabled="empty"
+                    :pt="pt"
+                />
+                <JumpToPageDropdown v-else-if="item === 'JumpToPageDropdown'" :aria-label="getAriaLabel('jumpToPageDropdownLabel')" :page="page" :pageCount="pageCount" @page-change="changePage($event)" :disabled="empty" :pt="pt" />
+                <JumpToPageInput v-else-if="item === 'JumpToPageInput'" :page="currentPage" @page-change="changePage($event)" :disabled="empty" :pt="pt" />
             </template>
-            <div v-if="$slots.end" class="p-paginator-right-content">
+            <div v-if="$slots.end" class="p-paginator-right-content" v-bind="ptm('end')">
                 <slot name="end" :state="currentState"></slot>
             </div>
         </div>
@@ -33,6 +42,7 @@
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import { UniqueComponentId } from 'primevue/utils';
 import CurrrentPageReport from './CurrentPageReport.vue';
 import FirstPageLink from './FirstPageLink.vue';
@@ -46,6 +56,7 @@ import RowsPerPageDropdown from './RowsPerPageDropdown.vue';
 
 export default {
     name: 'Paginator',
+    extends: BaseComponent,
     emits: ['update:first', 'update:rows', 'page'],
     props: {
         totalRecords: {

components/lib/paginator/PrevPageLink.vue

@@ -1,21 +1,32 @@
 <template>
-    <button v-ripple :class="containerClass" type="button">
+    <button v-ripple :class="containerClass" type="button" v-bind="getPTOptions('prevPageButton')">
-        <component :is="template || 'AngleLeftIcon'" class="p-paginator-icon" />
+        <component :is="template || 'AngleLeftIcon'" class="p-paginator-icon" v-bind="getPTOptions('prevPageIcon')" />
     </button>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import AngleLeftIcon from 'primevue/icons/angleleft';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'PrevPageLink',
+    extends: BaseComponent,
     props: {
         template: {
             type: Function,
             default: null
         }
     },
+    methods: {
+        getPTOptions(key) {
+            return this.ptm(key, {
+                context: {
+                    disabled: this.$attrs.disabled
+                }
+            });
+        }
+    },
     computed: {
         containerClass() {
             return [

components/lib/paginator/RowsPerPageDropdown.vue

@@ -1,12 +1,14 @@
 <template>
-    <RPPDropdown :modelValue="rows" :options="rowsOptions" optionLabel="label" optionValue="value" @update:modelValue="onChange($event)" class="p-paginator-rpp-options" :disabled="disabled"></RPPDropdown>
+    <RPPDropdown :modelValue="rows" :options="rowsOptions" optionLabel="label" optionValue="value" @update:modelValue="onChange($event)" class="p-paginator-rpp-options" :disabled="disabled" :pt="ptm('RPPDropdown')"></RPPDropdown>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import Dropdown from 'primevue/dropdown';
 
 export default {
     name: 'RowsPerPageDropdown',
+    extends: BaseComponent,
     emits: ['rows-change'],
     props: {
         options: Array,