Skip to content

added export in EventHandlers type #12586

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.

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

YanGer-kz
Copy link

@YanGer-kz YanGer-kz commented Dec 20, 2024

-> export type EventHandlers = {

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.

@edison1105
Copy link
Member

Could you please provide more information?

@edison1105 edison1105 added the need more info Further information is requested label Dec 23, 2024
@YanGer-kz
Copy link
Author

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

@edison1105 edison1105 added ready to merge The PR is ready to be merged. 🧹 p1-chore Priority 1: this doesn't change code behavior. and removed need more info Further information is requested labels Dec 23, 2024
Copy link

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)

Copy link

pkg-pr-new bot commented Dec 23, 2024

Open in Stackblitz

@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

Copy link

coderabbitai bot commented May 26, 2025

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 c017c7b and 41746e5.

📒 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.

❤️ Share
🪧 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in 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 pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧹 p1-chore Priority 1: this doesn't change code behavior. ready to merge The PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants