From 387f86d0bb14bb14f31f4cad3f0a0377e76206ee Mon Sep 17 00:00:00 2001
From: Mert Sincan <sincan.mert@gmail.com>
Date: Mon, 21 Oct 2024 14:25:46 +0100
Subject: [PATCH] Add form support to `Knob`

---
 packages/primevue/src/knob/BaseKnob.vue       | 12 ++-----
 packages/primevue/src/knob/Knob.d.ts          | 26 ++++++++++++--
 packages/primevue/src/knob/Knob.vue           | 34 +++++++++++--------
 packages/primevue/src/knob/style/KnobStyle.js |  8 ++++-
 4 files changed, 52 insertions(+), 28 deletions(-)

diff --git a/packages/primevue/src/knob/BaseKnob.vue b/packages/primevue/src/knob/BaseKnob.vue
index 8a859a2d6..c53d2284f 100644
--- a/packages/primevue/src/knob/BaseKnob.vue
+++ b/packages/primevue/src/knob/BaseKnob.vue
@@ -1,24 +1,16 @@
 <script>
-import BaseComponent from '@primevue/core/basecomponent';
 import { $dt } from '@primeuix/styled';
+import BaseEditableHolder from '@primevue/core/baseeditableholder';
 import KnobStyle from 'primevue/knob/style';
 
 export default {
     name: 'BaseKnob',
-    extends: BaseComponent,
+    extends: BaseEditableHolder,
     props: {
-        modelValue: {
-            type: Number,
-            default: null
-        },
         size: {
             type: Number,
             default: 100
         },
-        disabled: {
-            type: Boolean,
-            default: false
-        },
         readonly: {
             type: Boolean,
             default: false
diff --git a/packages/primevue/src/knob/Knob.d.ts b/packages/primevue/src/knob/Knob.d.ts
index 1a8c5e7c9..29dc85fd6 100644
--- a/packages/primevue/src/knob/Knob.d.ts
+++ b/packages/primevue/src/knob/Knob.d.ts
@@ -119,11 +119,24 @@ export interface KnobProps {
      * Value of the component.
      */
     modelValue?: number | undefined;
+    /**
+     * The default value for the input when not controlled by `modelValue`.
+     */
+    defaultValue?: any;
+    /**
+     * The name attribute for the element, typically used in form submissions.
+     */
+    name?: string | undefined;
     /**
      * Size of the component in pixels.
      * @defaultValue 100
      */
     size?: number | undefined;
+    /**
+     * When present, it specifies that the component should have invalid state style.
+     * @defaultValue false
+     */
+    invalid?: boolean | undefined;
     /**
      * When present, it specifies that the component should be disabled.
      * @defaultValue false
@@ -192,6 +205,10 @@ export interface KnobProps {
      * Used to define a string that labels the element.
      */
     ariaLabel?: string | undefined;
+    /**
+     * Form control object, typically used for handling validation and form state.
+     */
+    formControl?: Record<string, any> | undefined;
     /**
      * It generates scoped CSS variables using design tokens for the component.
      */
@@ -224,12 +241,17 @@ export interface KnobSlots {}
 export interface KnobEmitsOptions {
     /**
      * Emitted when the value changes.
-     * @param {number} event - New value.
+     * @param {number} value - New value.
      */
     'update:modelValue'(value: number): void;
+    /**
+     * Emitted when the value changes in uncontrolled mode.
+     * @param {number} value - New value.
+     */
+    'value-change'(value: number): void;
     /**
      * Callback to invoke when the value changes.
-     * @param {number} event - New value
+     * @param {number} value - New value
      */
     change(value: number): void;
 }
diff --git a/packages/primevue/src/knob/Knob.vue b/packages/primevue/src/knob/Knob.vue
index 257fa784c..f5ed9cffd 100644
--- a/packages/primevue/src/knob/Knob.vue
+++ b/packages/primevue/src/knob/Knob.vue
@@ -8,10 +8,11 @@
             :tabindex="readonly || disabled ? -1 : tabindex"
             :aria-valuemin="min"
             :aria-valuemax="max"
-            :aria-valuenow="modelValue"
+            :aria-valuenow="d_value"
             :aria-labelledby="ariaLabelledby"
             :aria-label="ariaLabel"
             @click="onClick"
+            @blur="onBlur"
             @keydown="onKeyDown"
             @mousedown="onMouseDown"
             @mouseup="onMouseUp"
@@ -36,7 +37,7 @@ export default {
     name: 'Knob',
     extends: BaseKnob,
     inheritAttrs: false,
-    emits: ['update:modelValue', 'change'],
+    emits: ['change'],
     data() {
         return {
             radius: 40,
@@ -64,13 +65,13 @@ export default {
 
             let newValue = Math.round((mappedValue - this.min) / this.step) * this.step + this.min;
 
-            this.$emit('update:modelValue', newValue);
+            this.updateValue(newValue);
             this.$emit('change', newValue);
         },
         updateModelValue(newValue) {
-            if (newValue > this.max) this.$emit('update:modelValue', this.max);
-            else if (newValue < this.min) this.$emit('update:modelValue', this.min);
-            else this.$emit('update:modelValue', newValue);
+            if (newValue > this.max) this.updateValue(this.max);
+            else if (newValue < this.min) this.updateValue(this.min);
+            else this.updateValue(newValue);
         },
         mapRange(x, inMin, inMax, outMin, outMax) {
             return ((x - inMin) * (outMax - outMin)) / (inMax - inMin) + outMin;
@@ -80,6 +81,9 @@ export default {
                 this.updateValue(event.offsetX, event.offsetY);
             }
         },
+        onBlur(event) {
+            this.formField.onBlur?.(event);
+        },
         onMouseDown(event) {
             if (!this.disabled && !this.readonly) {
                 window.addEventListener('mousemove', this.onMouseMove);
@@ -131,7 +135,7 @@ export default {
 
                     case 'ArrowUp': {
                         event.preventDefault();
-                        this.updateModelValue(this.modelValue + this.step);
+                        this.updateModelValue(this.d_value + this.step);
                         break;
                     }
 
@@ -139,31 +143,31 @@ export default {
 
                     case 'ArrowDown': {
                         event.preventDefault();
-                        this.updateModelValue(this.modelValue - this.step);
+                        this.updateModelValue(this.d_value - this.step);
                         break;
                     }
 
                     case 'Home': {
                         event.preventDefault();
-                        this.$emit('update:modelValue', this.min);
+                        this.updateValue(this.min);
                         break;
                     }
 
                     case 'End': {
                         event.preventDefault();
-                        this.$emit('update:modelValue', this.max);
+                        this.updateValue(this.max);
                         break;
                     }
 
                     case 'PageUp': {
                         event.preventDefault();
-                        this.updateModelValue(this.modelValue + 10);
+                        this.updateModelValue(this.d_value + 10);
                         break;
                     }
 
                     case 'PageDown': {
                         event.preventDefault();
-                        this.updateModelValue(this.modelValue - 10);
+                        this.updateModelValue(this.d_value - 10);
                         break;
                     }
                 }
@@ -182,7 +186,7 @@ export default {
             else return this.mapRange(0, this.min, this.max, this.minRadians, this.maxRadians);
         },
         valueRadians() {
-            return this.mapRange(this.modelValue, this.min, this.max, this.minRadians, this.maxRadians);
+            return this.mapRange(this.d_value, this.min, this.max, this.minRadians, this.maxRadians);
         },
         minX() {
             return this.midX + Math.cos(this.minRadians) * this.radius;
@@ -216,9 +220,9 @@ export default {
         },
         valueToDisplay() {
             if (typeof this.valueTemplate === 'string') {
-                return this.valueTemplate.replace(/{value}/g, this.modelValue);
+                return this.valueTemplate.replace(/{value}/g, this.d_value);
             } else {
-                return this.valueTemplate(this.modelValue);
+                return this.valueTemplate(this.d_value);
             }
         }
     }
diff --git a/packages/primevue/src/knob/style/KnobStyle.js b/packages/primevue/src/knob/style/KnobStyle.js
index efdbce440..8263ef839 100644
--- a/packages/primevue/src/knob/style/KnobStyle.js
+++ b/packages/primevue/src/knob/style/KnobStyle.js
@@ -37,7 +37,13 @@ const theme = ({ dt }) => `
 `;
 
 const classes = {
-    root: ({ props }) => ['p-knob p-component', { 'p-disabled': props.disabled }],
+    root: ({ instance, props }) => [
+        'p-knob p-component',
+        {
+            'p-disabled': props.disabled,
+            'p-invalid': instance.$invalid
+        }
+    ],
     range: 'p-knob-range',
     value: 'p-knob-value',
     text: 'p-knob-text'