fix(input): ionInput event type

Fixes the emitted event type for input and textarea to use InputEvent.
ionic-team · Nov 8, 2021 · d811907 · d811907
1 parent da339a8
commit d811907
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/angular/src/directives/proxies.ts b/angular/src/directives/proxies.ts
@@ -680,7 +680,7 @@ export declare interface IonInput extends Components.IonInput {}
 })
 export class IonInput {
   /** Emitted when a keyboard input occurred. */
-  ionInput!: EventEmitter<CustomEvent<KeyboardEvent>>;
+  ionInput!: EventEmitter<CustomEvent<InputEvent>>;
   /** Emitted when the value has changed. */
   ionChange!: EventEmitter<CustomEvent<IInputInputChangeEventDetail>>;
   /** Emitted when the input loses focus. */
@@ -1558,7 +1558,7 @@ export class IonTextarea {
   /** Emitted when the input value has changed. */
   ionChange!: EventEmitter<CustomEvent<ITextareaTextareaChangeEventDetail>>;
   /** Emitted when a keyboard input occurred. */
-  ionInput!: EventEmitter<CustomEvent<KeyboardEvent>>;
+  ionInput!: EventEmitter<CustomEvent<InputEvent>>;
   /** Emitted when the input loses focus. */
   ionBlur!: EventEmitter<CustomEvent<FocusEvent>>;
   /** Emitted when the input has focus. */

diff --git a/core/api.txt b/core/api.txt
@@ -540,7 +540,7 @@ ion-input,method,setFocus,setFocus() => Promise<void>
 ion-input,event,ionBlur,FocusEvent,true
 ion-input,event,ionChange,InputChangeEventDetail,true
 ion-input,event,ionFocus,FocusEvent,true
-ion-input,event,ionInput,KeyboardEvent,true
+ion-input,event,ionInput,InputEvent,true
 ion-input,css-prop,--background
 ion-input,css-prop,--color
 ion-input,css-prop,--padding-bottom
@@ -1331,7 +1331,7 @@ ion-textarea,method,setFocus,setFocus() => Promise<void>
 ion-textarea,event,ionBlur,FocusEvent,true
 ion-textarea,event,ionChange,TextareaChangeEventDetail,true
 ion-textarea,event,ionFocus,FocusEvent,true
-ion-textarea,event,ionInput,KeyboardEvent,true
+ion-textarea,event,ionInput,InputEvent,true
 ion-textarea,css-prop,--background
 ion-textarea,css-prop,--border-radius
 ion-textarea,css-prop,--color

diff --git a/core/src/components.d.ts b/core/src/components.d.ts
@@ -4791,7 +4791,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when a keyboard input occurred.
          */
-        "onIonInput"?: (event: CustomEvent<KeyboardEvent>) => void;
+        "onIonInput"?: (event: CustomEvent<InputEvent>) => void;
         /**
           * Emitted when the styles change.
          */
@@ -6498,7 +6498,7 @@ declare namespace LocalJSX {
         /**
           * Emitted when a keyboard input occurred.
          */
-        "onIonInput"?: (event: CustomEvent<KeyboardEvent>) => void;
+        "onIonInput"?: (event: CustomEvent<InputEvent>) => void;
         /**
           * Emitted when the styles change.
          */

diff --git a/core/src/components/input/input.tsx b/core/src/components/input/input.tsx
@@ -193,7 +193,7 @@ export class Input implements ComponentInterface {
   /**
    * Emitted when a keyboard input occurred.
    */
-  @Event() ionInput!: EventEmitter<KeyboardEvent>;
+  @Event() ionInput!: EventEmitter<InputEvent>;
 
   /**
    * Emitted when the value has changed.
@@ -314,7 +314,7 @@ export class Input implements ComponentInterface {
     if (input) {
       this.value = input.value || '';
     }
-    this.ionInput.emit(ev as KeyboardEvent);
+    this.ionInput.emit(ev as InputEvent);
   }
 
   private onBlur = (ev: FocusEvent) => {

diff --git a/core/src/components/input/readme.md b/core/src/components/input/readme.md
@@ -357,7 +357,7 @@ export default defineComponent({
 | `ionBlur`   | Emitted when the input loses focus.     | `CustomEvent<FocusEvent>`             |
 | `ionChange` | Emitted when the value has changed.     | `CustomEvent<InputChangeEventDetail>` |
 | `ionFocus`  | Emitted when the input has focus.       | `CustomEvent<FocusEvent>`             |
-| `ionInput`  | Emitted when a keyboard input occurred. | `CustomEvent<KeyboardEvent>`          |
+| `ionInput`  | Emitted when a keyboard input occurred. | `CustomEvent<InputEvent>`             |
 
 
 ## Methods

diff --git a/core/src/components/textarea/readme.md b/core/src/components/textarea/readme.md
@@ -317,7 +317,7 @@ export default defineComponent({
 | `ionBlur`   | Emitted when the input loses focus.       | `CustomEvent<FocusEvent>`                |
 | `ionChange` | Emitted when the input value has changed. | `CustomEvent<TextareaChangeEventDetail>` |
 | `ionFocus`  | Emitted when the input has focus.         | `CustomEvent<FocusEvent>`                |
-| `ionInput`  | Emitted when a keyboard input occurred.   | `CustomEvent<KeyboardEvent>`             |
+| `ionInput`  | Emitted when a keyboard input occurred.   | `CustomEvent<InputEvent>`                |
 
 
 ## Methods

diff --git a/core/src/components/textarea/textarea.tsx b/core/src/components/textarea/textarea.tsx
@@ -177,7 +177,7 @@ export class Textarea implements ComponentInterface {
   /**
    * Emitted when a keyboard input occurred.
    */
-  @Event() ionInput!: EventEmitter<KeyboardEvent>;
+  @Event() ionInput!: EventEmitter<InputEvent>;
 
   /**
    * Emitted when the styles change.
@@ -316,7 +316,7 @@ export class Textarea implements ComponentInterface {
       this.value = this.nativeInput.value;
     }
     this.emitStyle();
-    this.ionInput.emit(ev as KeyboardEvent);
+    this.ionInput.emit(ev as InputEvent);
   }
 
   private onFocus = (ev: FocusEvent) => {