Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

types: Refine jsx types #4402

Merged
merged 3 commits into from
Jun 5, 2023
Merged

types: Refine jsx types #4402

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4523e3e
add isComposing & refine nativeEvent type
FlatMapIO Jun 3, 2023
566a76e
Add the enterKeyHint property for textarea
FlatMapIO Jun 3, 2023
eb07449
Add changes by pnpm api.update
FlatMapIO Jun 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add changes by pnpm api.update
  • Loading branch information
@FlatMapIO
FlatMapIO committed Jun 3, 2023
commit eb0744929cce96ac8a3adbcd97c31ebbfab573fc
2 changes: 1 addition & 1 deletion packages/docs/src/routes/api/qwik/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
27 changes: 14 additions & 13 deletions packages/docs/src/routes/api/qwik/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 2 additions & 0 deletions packages/qwik/src/core/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down