fix(checkbox, radio): change event interfaces correctly use TypeScrip…

…t generics for value (#23044) Co-authored-by: Liam DeBeasi <liamdebeasi@icloud.com>
ionic-team · Aug 3, 2021 · 8a941fd · 8a941fd
1 parent fbe6484
commit 8a941fd
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/core/api.txt b/core/api.txt
@@ -230,7 +230,7 @@ ion-checkbox,prop,mode,"ios" | "md",undefined,false,false
 ion-checkbox,prop,name,string,this.inputId,false,false
 ion-checkbox,prop,value,string,'on',false,false
 ion-checkbox,event,ionBlur,void,true
-ion-checkbox,event,ionChange,CheckboxChangeEventDetail,true
+ion-checkbox,event,ionChange,CheckboxChangeEventDetail<any>,true
 ion-checkbox,event,ionFocus,void,true
 ion-checkbox,css-prop,--background
 ion-checkbox,css-prop,--background-checked
@@ -867,7 +867,7 @@ ion-radio-group,none
 ion-radio-group,prop,allowEmptySelection,boolean,false,false,false
 ion-radio-group,prop,name,string,this.inputId,false,false
 ion-radio-group,prop,value,any,undefined,false,false
-ion-radio-group,event,ionChange,RadioGroupChangeEventDetail,true
+ion-radio-group,event,ionChange,RadioGroupChangeEventDetail<any>,true
 
 ion-range,shadow
 ion-range,prop,color,string | undefined,undefined,false,true

diff --git a/core/src/components/checkbox/checkbox-interface.ts b/core/src/components/checkbox/checkbox-interface.ts
@@ -1,5 +1,5 @@
 
-export interface CheckboxChangeEventDetail {
-  value: any;
+export interface CheckboxChangeEventDetail<T = any> {
+  value: T;
   checked: boolean;
 }
diff --git a/core/src/components/checkbox/readme.md b/core/src/components/checkbox/readme.md
@@ -271,11 +271,11 @@ export default defineComponent({
 
 ## Events
 
-| Event       | Description                                    | Type                                     |
-| ----------- | ---------------------------------------------- | ---------------------------------------- |
-| `ionBlur`   | Emitted when the checkbox loses focus.         | `CustomEvent<void>`                      |
-| `ionChange` | Emitted when the checked property has changed. | `CustomEvent<CheckboxChangeEventDetail>` |
-| `ionFocus`  | Emitted when the checkbox has focus.           | `CustomEvent<void>`                      |
+| Event       | Description                                    | Type                                          |
+| ----------- | ---------------------------------------------- | --------------------------------------------- |
+| `ionBlur`   | Emitted when the checkbox loses focus.         | `CustomEvent<void>`                           |
+| `ionChange` | Emitted when the checked property has changed. | `CustomEvent<CheckboxChangeEventDetail<any>>` |
+| `ionFocus`  | Emitted when the checkbox has focus.           | `CustomEvent<void>`                           |
 
 
 ## Shadow Parts

diff --git a/core/src/components/radio-group/radio-group-interface.ts b/core/src/components/radio-group/radio-group-interface.ts
@@ -1,9 +1,9 @@
 
-export interface RadioGroupChangeEventDetail {
-  value: any;
+export interface RadioGroupChangeEventDetail<T = any> {
+  value: T;
 }
 
-export interface RadioChangeEventDetail {
-  value: any;
+export interface RadioChangeEventDetail<T = any> {
+  value: T;
   checked: boolean;
 }
diff --git a/core/src/components/radio-group/readme.md b/core/src/components/radio-group/readme.md
@@ -229,9 +229,9 @@ export default defineComponent({
 
 ## Events
 
-| Event       | Description                         | Type                                       |
-| ----------- | ----------------------------------- | ------------------------------------------ |
-| `ionChange` | Emitted when the value has changed. | `CustomEvent<RadioGroupChangeEventDetail>` |
+| Event       | Description                         | Type                                            |
+| ----------- | ----------------------------------- | ----------------------------------------------- |
+| `ionChange` | Emitted when the value has changed. | `CustomEvent<RadioGroupChangeEventDetail<any>>` |
 
 
 ## Dependencies