added export in EventHandlers type
-> export type EventHandlers<E> = {
When developing my own component, I wanted to use custom props as onClick, onFocus.
I noticed that they are not in runtime or I did not find them, I thought it would be better to add export for the type that will allow me to use for my components
Summary by CodeRabbit
- Documentation
- Improved type export visibility for event handlers, enhancing integration with external TypeScript tooling.
Could you please provide more information?
Could you please provide more information?
When developing my own component, I wanted to use custom props as onClick, onFocus.
I noticed that they are not in runtime or I did not find them, I thought it would be better to add export for the type that will allow me to use for my components
Size Report
Bundles
| File | Size | Gzip | Brotli |
|---|---|---|---|
| runtime-dom.global.prod.js | 100 kB | 37.9 kB | 34.2 kB |
| vue.global.prod.js | 158 kB (+15 B) | 57.8 kB (+6 B) | 51.4 kB (+26 B) |
Usages
| Name | Size | Gzip | Brotli |
|---|---|---|---|
| createApp (CAPI only) | 46.6 kB (+350 B) | 18.3 kB (+116 B) | 16.7 kB (+105 B) |
| createApp | 54.6 kB (+366 B) | 21.3 kB (+136 B) | 19.4 kB (+153 B) |
| createSSRApp | 58.7 kB (+253 B) | 23 kB (+118 B) | 20.9 kB (+87 B) |
| defineCustomElement | 59.4 kB (+368 B) | 22.8 kB (+138 B) | 20.8 kB (+111 B) |
| overall | 68.4 kB (+132 B) | 26.4 kB (+59 B) | 24 kB (+116 B) |
@vue/compiler-core
npm i https://pkg.pr.new/@vue/compiler-core@12586
@vue/compiler-sfc
npm i https://pkg.pr.new/@vue/compiler-sfc@12586
@vue/compiler-dom
npm i https://pkg.pr.new/@vue/compiler-dom@12586
@vue/compiler-ssr
npm i https://pkg.pr.new/@vue/compiler-ssr@12586
@vue/reactivity
npm i https://pkg.pr.new/@vue/reactivity@12586
@vue/runtime-core
npm i https://pkg.pr.new/@vue/runtime-core@12586
@vue/server-renderer
npm i https://pkg.pr.new/@vue/server-renderer@12586
@vue/runtime-dom
npm i https://pkg.pr.new/@vue/runtime-dom@12586
@vue/shared
npm i https://pkg.pr.new/@vue/shared@12586
vue
npm i https://pkg.pr.new/vue@12586
@vue/compat
npm i https://pkg.pr.new/@vue/compat@12586
commit: 86800e3
Walkthrough
The change updates the EventHandlers type alias in packages/runtime-dom/src/jsx.ts by adding the export keyword, making it publicly accessible. The internal structure and logic of the type remain unchanged.
Changes
| File | Change Summary |
|---|---|
| packages/runtime-dom/src/jsx.ts | Made EventHandlers type alias explicitly exported |
Poem
A hop to the fields of export land,
Where types now reach out, lending a hand.
EventHandlers leap from private to seen,
In the garden of code, theyβre crisp and clean.
πβ¨
π Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
π₯ Commits
Reviewing files that changed from the base of the PR and between c017c7b8d3bd4bd138dda2ce50b13fd75d2d75f6 and 41746e58c021fd0f2495d4d93f5ef4cd372497df.
π Files selected for processing (1)
packages/runtime-dom/src/jsx.ts(1 hunks)
π Additional comments (1)
packages/runtime-dom/src/jsx.ts (1)
1387-1391: LGTM! Great addition for custom component development.Exporting the
EventHandlers<E>type is a valuable enhancement that addresses a real developer need. This well-designed mapped type will enable custom component authors to leverage the same robust event handler typing that Vue's built-in components use.The type definition is elegant:
- Preserves existing function signatures when applicable
- Wraps non-function event types in proper handler functions
- Makes all handlers optional as expected in Vue components
Since this type is now part of the public API, consider adding JSDoc documentation to help developers understand its usage and the generic parameter
E.
β¨ Finishing Touches
- [ ] π Generate Docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
πͺ§ Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.