Refactor #3922 - For ToggleButton

primefaces · May 7, 2023 · 7a26836 · 7a26836
1 parent 8e281f2
commit 7a26836
Show file tree

Hide file tree

Showing 7 changed files with 170 additions and 9 deletions.
diff --git a/components/lib/togglebutton/ToggleButton.d.ts b/components/lib/togglebutton/ToggleButton.d.ts
@@ -10,6 +10,60 @@
 import { InputHTMLAttributes, VNode } from 'vue';
 import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
 
+export declare type ToggleButtonPassThroughOptionType = ToggleButtonPassThroughAttributes | ((options: ToggleButtonPassThroughMethodOptions) => ToggleButtonPassThroughAttributes) | null | undefined;
+
+/**
+ * Custom passthrough(pt) option method.
+ */
+export interface ToggleButtonPassThroughMethodOptions {
+    props: ToggleButtonProps;
+    state: ToggleButtonState;
+}
+
+/**
+ * Custom passthrough(pt) options.
+ * @see {@link ToggleButtonProps.pt}
+ */
+export interface ToggleButtonPassThroughOptions {
+    /**
+     * Uses to pass attributes to the root's DOM element.
+     */
+    root?: ToggleButtonPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the input aria's DOM element.
+     */
+    inputAria?: ToggleButtonPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the input's DOM element.
+     */
+    input?: ToggleButtonPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the icon's DOM element.
+     */
+    icon?: ToggleButtonPassThroughOptionType;
+    /**
+     * Uses to pass attributes to the label's DOM element.
+     */
+    label?: ToggleButtonPassThroughOptionType;
+}
+
+/**
+ * Custom passthrough attributes for each DOM elements
+ */
+export interface ToggleButtonPassThroughAttributes {
+    [key: string]: any;
+}
+
+/**
+ * Defines current inline state in ToggleButton component.
+ */
+export interface ToggleButtonState {
+    /**
+     * Focused state as a number.
+     */
+    focused: boolean;
+}
+
 /**
  * Defines valid properties in ToggleButton component.
  */
@@ -77,6 +131,11 @@ export interface ToggleButtonProps {
      * Establishes a string value that labels the component.
      */
     'aria-label'?: string | undefined;
+    /**
+     * Uses to pass attributes to DOM elements inside the component.
+     * @type {ToggleButtonPassThroughOptions}
+     */
+    pt?: ToggleButtonPassThroughOptions;
 }
 
 /**

diff --git a/components/lib/togglebutton/ToggleButton.vue b/components/lib/togglebutton/ToggleButton.vue
@@ -1,6 +1,6 @@
 <template>
-    <div ref="container" v-ripple :class="buttonClass" @click="onClick($event)">
-        <span class="p-hidden-accessible">
+    <div ref="container" v-ripple :class="buttonClass" @click="onClick($event)" v-bind="ptm('root')">
+        <span class="p-hidden-accessible" v-bind="ptm('inputAria')">
             <input
                 :id="inputId"
                 type="checkbox"
@@ -13,21 +13,23 @@
                 :aria-label="ariaLabel"
                 @focus="onFocus($event)"
                 @blur="onBlur($event)"
-                v-bind="inputProps"
+                v-bind="{ ...inputProps, ...ptm('input') }"
             />
         </span>
         <slot name="icon" :value="modelValue" :class="iconClass">
-            <span v-if="onIcon || offIcon" :class="iconClass" />
+            <span v-if="onIcon || offIcon" :class="iconClass" v-bind="ptm('icon')" />
         </slot>
-        <span class="p-button-label">{{ label }}</span>
+        <span class="p-button-label" v-bind="ptm('label')">{{ label }}</span>
     </div>
 </template>
 
 <script>
+import BaseComponent from 'primevue/basecomponent';
 import Ripple from 'primevue/ripple';
 
 export default {
     name: 'ToggleButton',
+    extends: BaseComponent,
     emits: ['update:modelValue', 'change', 'click', 'focus', 'blur'],
     props: {
         modelValue: Boolean,

diff --git a/doc/togglebutton/pt/PTDoc.vue b/doc/togglebutton/pt/PTDoc.vue
@@ -0,0 +1,49 @@
+<template>
+    <DocSectionText v-bind="$attrs"> </DocSectionText>
+    <div class="card flex justify-content-center">
+        <ToggleButton v-model="checked" class="w-8rem" />
+    </div>
+    <DocSectionCode :code="code" />
+</template>
+
+<script>
+export default {
+    data() {
+        return {
+            checked: false,
+            code: {
+                basic: `
+<ToggleButton v-model="checked" />`,
+                options: `
+<template>
+    <div class="card flex justify-content-center">
+        <ToggleButton v-model="checked" class="w-8rem" />
+    </div>
+</template>
+
+<script>
+export default {
+    data() {
+        return {
+            checked: false
+        }
+    }
+};
+<\/script>`,
+                composition: `
+<template>
+    <div class="card flex justify-content-center">
+        <ToggleButton v-model="checked" class="w-8rem" />
+    </div>
+</template>
+
+<script setup>
+import { ref } from 'vue';
+
+const checked = ref(false);
+<\/script>`
+            }
+        };
+    }
+};
+</script>
diff --git a/doc/togglebutton/pt/PTImage.vue b/doc/togglebutton/pt/PTImage.vue
@@ -0,0 +1,8 @@
+<template>
+    <DocSectionText v-bind="$attrs">
+        <p>{{ $attrs.description }}</p>
+    </DocSectionText>
+    <div class="card">
+        <img class="w-full" src="https://primefaces.org/cdn/primevue/images/pt/wireframe-placeholder.jpg" />
+    </div>
+</template>
diff --git a/doc/togglebutton/pt/index.vue b/doc/togglebutton/pt/index.vue
@@ -0,0 +1,41 @@
+<template>
+    <div class="doc-main">
+        <div class="doc-intro">
+            <h1>ToggleButton Pass Through</h1>
+        </div>
+        <DocSections :docs="docs" />
+    </div>
+    <DocSectionNav :docs="docs" />
+</template>
+
+<script>
+import DocApiTable from '@/components/doc/DocApiTable.vue';
+import { getPTOption } from '@/components/doc/helpers/PTHelper.js';
+import PtDoc from './PTDoc.vue';
+import PTImage from './PTImage.vue';
+
+export default {
+    data() {
+        return {
+            docs: [
+                {
+                    id: 'pt.image',
+                    label: 'Wireframe',
+                    component: PTImage
+                },
+                {
+                    id: 'pt.doc.steps',
+                    label: 'ToggleButton PT Options',
+                    component: DocApiTable,
+                    data: getPTOption('ToggleButton')
+                },
+                {
+                    id: 'pt.demo',
+                    label: 'Demo',
+                    component: PtDoc
+                }
+            ]
+        };
+    }
+};
+</script>
diff --git a/doc/tristatecheckbox/pt/index.vue b/doc/tristatecheckbox/pt/index.vue
@@ -1,7 +1,7 @@
 <template>
     <div class="doc-main">
         <div class="doc-intro">
-            <h1>Rating Pass Through</h1>
+            <h1>TriStateCheckbox Pass Through</h1>
         </div>
         <DocSections :docs="docs" />
     </div>
@@ -25,7 +25,7 @@ export default {
                 },
                 {
                     id: 'pt.doc.steps',
-                    label: 'Rating PT Options',
+                    label: 'TriStateCheckbox PT Options',
                     component: DocApiTable,
                     data: getPTOption('TriStateCheckbox')
                 },

diff --git a/pages/togglebutton/index.vue b/pages/togglebutton/index.vue
@@ -1,5 +1,5 @@
 <template>
-    <DocComponent title="Vue ToggleButton Component" header="ToggleButton" description="ToggleButton is used to select a boolean value using a button." :componentDocs="docs" :apiDocs="['ToggleButton']" />
+    <DocComponent title="Vue ToggleButton Component" header="ToggleButton" description="ToggleButton is used to select a boolean value using a button." :componentDocs="docs" :apiDocs="['ToggleButton']" :ptTabComponent="ptComponent" />
 </template>
 
 <script>
@@ -10,6 +10,7 @@ import DisabledDoc from '@/doc/togglebutton/DisabledDoc.vue';
 import VeeValidateDoc from '@/doc/togglebutton/form/VeeValidateDoc.vue';
 import ImportDoc from '@/doc/togglebutton/ImportDoc.vue';
 import StyleDoc from '@/doc/togglebutton/StyleDoc.vue';
+import PTComponent from '@/doc/togglebutton/pt/index.vue';
 
 export default {
     data() {
@@ -57,7 +58,8 @@ export default {
                     label: 'Accessibility',
                     component: AccessibilityDoc
                 }
-            ]
+            ],
+            ptComponent: PTComponent
         };
     }
 };