fix(jsx): refine jsx types (QwikDev#4402)

justoverclockl · Jun 5, 2023 · 1099a11 · 1099a11
1 parent 4ddb1f1
commit 1099a11
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 15 deletions.
diff --git a/packages/docs/src/routes/api/qwik/api.json b/packages/docs/src/routes/api/qwik/api.json
@@ -1100,7 +1100,7 @@
         }
       ],
       "kind": "Interface",
-      "content": "```typescript\nexport interface QwikKeyboardEvent<T = Element> extends SyntheticEvent<T, NativeKeyboardEvent> \n```\n**Extends:** SyntheticEvent&lt;T, [NativeKeyboardEvent](#nativekeyboardevent)<!-- -->&gt;\n\n\n|  Property | Modifiers | Type | Description |\n|  --- | --- | --- | --- |\n|  [altKey](#) |  | boolean |  |\n|  [charCode](#) |  | number |  |\n|  [ctrlKey](#) |  | boolean |  |\n|  [key](#) |  | string | See the \\[DOM Level 3 Events spec\\](https://www.w3.org/TR/uievents-key/\\#named-key-attribute-values). for possible values |\n|  [keyCode](#) |  | number |  |\n|  [locale](#) |  | string |  |\n|  [location](#) |  | number |  |\n|  [metaKey](#) |  | boolean |  |\n|  [repeat](#) |  | boolean |  |\n|  [shiftKey](#) |  | boolean |  |\n|  [which](#) |  | number |  |\n\n\n|  Method | Description |\n|  --- | --- |\n|  [getModifierState(key)](#qwikkeyboardevent-getmodifierstate) | See \\[DOM Level 3 Events spec\\](https://www.w3.org/TR/uievents-key/\\#keys-modifier). for a list of valid (case-sensitive) arguments to this method. |",
+      "content": "```typescript\nexport interface QwikKeyboardEvent<T = Element> extends SyntheticEvent<T, NativeKeyboardEvent> \n```\n**Extends:** SyntheticEvent&lt;T, [NativeKeyboardEvent](#nativekeyboardevent)<!-- -->&gt;\n\n\n|  Property | Modifiers | Type | Description |\n|  --- | --- | --- | --- |\n|  [altKey](#) |  | boolean |  |\n|  [charCode](#) |  | number |  |\n|  [ctrlKey](#) |  | boolean |  |\n|  [isComposing](#) |  | boolean |  |\n|  [key](#) |  | string | See the \\[DOM Level 3 Events spec\\](https://www.w3.org/TR/uievents-key/\\#named-key-attribute-values). for possible values |\n|  [keyCode](#) |  | number |  |\n|  [locale](#) |  | string |  |\n|  [location](#) |  | number |  |\n|  [metaKey](#) |  | boolean |  |\n|  [repeat](#) |  | boolean |  |\n|  [shiftKey](#) |  | boolean |  |\n|  [which](#) |  | number |  |\n\n\n|  Method | Description |\n|  --- | --- |\n|  [getModifierState(key)](#qwikkeyboardevent-getmodifierstate) | See \\[DOM Level 3 Events spec\\](https://www.w3.org/TR/uievents-key/\\#keys-modifier). for a list of valid (case-sensitive) arguments to this method. |",
       "editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts",
       "mdFile": "qwik.qwikkeyboardevent.md"
     },

diff --git a/packages/docs/src/routes/api/qwik/index.md b/packages/docs/src/routes/api/qwik/index.md
@@ -1281,19 +1281,20 @@ export interface QwikKeyboardEvent<T = Element> extends SyntheticEvent<T, Native
 
 **Extends:** SyntheticEvent&lt;T, [NativeKeyboardEvent](#nativekeyboardevent)&gt;
 
-| Property      | Modifiers | Type    | Description                                                                                                               |
-| ------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
-| [altKey](#)   |           | boolean |                                                                                                                           |
-| [charCode](#) |           | number  |                                                                                                                           |
-| [ctrlKey](#)  |           | boolean |                                                                                                                           |
-| [key](#)      |           | string  | See the \[DOM Level 3 Events spec\](https://www.w3.org/TR/uievents-key/\#named-key-attribute-values). for possible values |
-| [keyCode](#)  |           | number  |                                                                                                                           |
-| [locale](#)   |           | string  |                                                                                                                           |
-| [location](#) |           | number  |                                                                                                                           |
-| [metaKey](#)  |           | boolean |                                                                                                                           |
-| [repeat](#)   |           | boolean |                                                                                                                           |
-| [shiftKey](#) |           | boolean |                                                                                                                           |
-| [which](#)    |           | number  |                                                                                                                           |
+| Property         | Modifiers | Type    | Description                                                                                                               |
+| ---------------- | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
+| [altKey](#)      |           | boolean |                                                                                                                           |
+| [charCode](#)    |           | number  |                                                                                                                           |
+| [ctrlKey](#)     |           | boolean |                                                                                                                           |
+| [isComposing](#) |           | boolean |                                                                                                                           |
+| [key](#)         |           | string  | See the \[DOM Level 3 Events spec\](https://www.w3.org/TR/uievents-key/\#named-key-attribute-values). for possible values |
+| [keyCode](#)     |           | number  |                                                                                                                           |
+| [locale](#)      |           | string  |                                                                                                                           |
+| [location](#)    |           | number  |                                                                                                                           |
+| [metaKey](#)     |           | boolean |                                                                                                                           |
+| [repeat](#)      |           | boolean |                                                                                                                           |
+| [shiftKey](#)    |           | boolean |                                                                                                                           |
+| [which](#)       |           | number  |                                                                                                                           |
 
 | Method                                                       | Description                                                                                                                                         |
 | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |

diff --git a/packages/qwik/src/core/api.md b/packages/qwik/src/core/api.md
@@ -566,6 +566,8 @@ export interface QwikKeyboardEvent<T = Element> extends SyntheticEvent<T, Native
     // (undocumented)
     ctrlKey: boolean;
     getModifierState(key: string): boolean;
+    // (undocumented)
+    isComposing: boolean;
     key: string;
     // (undocumented)
     keyCode: number;

diff --git a/packages/qwik/src/core/render/jsx/types/jsx-generated.ts b/packages/qwik/src/core/render/jsx/types/jsx-generated.ts
@@ -821,6 +821,7 @@ export interface TextareaHTMLAttributes<T> extends HTMLAttributes<T> {
   cols?: number | undefined;
   dirName?: string | undefined;
   disabled?: boolean | undefined;
+  enterKeyHint?: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send' | undefined;
   form?: string | undefined;
   maxLength?: number | undefined;
   minLength?: number | undefined;

diff --git a/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts b/packages/qwik/src/core/render/jsx/types/jsx-qwik-events.ts
@@ -4,7 +4,7 @@ export interface SyntheticEvent<T = Element, E = Event>
   extends BaseSyntheticEvent<E, EventTarget & T, EventTarget> {}
 
 interface BaseSyntheticEvent<E = object, C = any, T = any> {
-  nativeEvent: E;
+  nativeEvent: E | undefined;
   target: T;
   bubbles: boolean;
   cancelable: boolean;
@@ -118,6 +118,7 @@ export interface QwikChangeEvent<T = Element> extends SyntheticEvent<T> {
  * @public
  */
 export interface QwikKeyboardEvent<T = Element> extends SyntheticEvent<T, NativeKeyboardEvent> {
+  isComposing: boolean;
   altKey: boolean;
   charCode: number;
   ctrlKey: boolean;