Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

feat(runtime-vapor): implement defineVaporComponent types #13831

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
zhiyuanzmj wants to merge 12 commits into vuejs:minor
base: minor
Choose a base branch
Loading
from zhiyuanzmj:define-vapor-type

Conversation

Copy link
Member

@zhiyuanzmj zhiyuanzmj commented Aug 30, 2025
edited
Loading

  1. defineVaporComponent types.
  • Functional defineVaporComponent
import { computed, type ComputedRef, type Block } from 'vue'
const Comp = defineVaporComponent(
 <T extends number>(
 props: { foo: T },
 {
 expose,
 slots,
 }: {
 slots: { default?: (props: { foo: T }) => Block }
 expose: (exposed: { double: ComputedRef<T> }) => void
 },
 ) => {
 const double = computed(() => (props.foo * 2) as T)
 expose({ double })
 return slots.default!({ foo: props.foo })
 },
)
const comp = new Comp<1>({ foo: 1 })
comp.props.foo === ({} as 1)
comp.exposeProxy?.double === ({} as 1)
comp.slots === ({} as { default?: (props: { foo: 1 }) => Block })
  • Optional defineVaporComponent
const Comp = defineVaporComponent({
 props: {
 foo: {
 type: Number,
 required: true,
 }
 },
 slots: {} as { default?: (props: { foo: number }) => Block }
 setup(props){
 const double = computed(() => props.foo * 2)
 return {
 double
 }
 },
 render(ctx, props, emit, attrs, slots){
 return slots.default?.({ foo: props.foo })
 }
})
const comp = new Comp({ foo: 1 })
comp.props.foo === {} as number
comp.exposeProxy?.double === {} as number
comp.slots === ({} as { default?: (props: { foo: number }) => Block })
  1. Remove JSX.ElementAttributesProperty and JSX.ElementClass to enable Vapor and VDom co-usage.
// jsx.d.ts
declare global {
 namespace JSX {
 export type Element = VNode | Block
 }
}

Using the constructor's first parameter as JSX props instead.

interface Constructor<P = any> {
 new (props?: P): { $props: P }
 // ^^^^^^^^^
}

c5n8, TiBianMod, edison1105, and zhiyuanzmj reacted with thumbs up emoji c5n8 reacted with heart emoji c5n8 reacted with rocket emoji
Copy link

coderabbitai bot commented Aug 30, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

Copy link

Size Report

Bundles

File Size Gzip Brotli
compiler-dom.global.prod.js 84 kB 29.8 kB 26.3 kB
runtime-dom.global.prod.js 104 kB 39.1 kB 35.3 kB
vue.global.prod.js 162 kB 59.3 kB 52.9 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 47.2 kB 18.4 kB 16.9 kB
createApp 56 kB 21.6 kB 19.7 kB
createApp + vaporInteropPlugin 68.7 kB (+123 B) 25.9 kB (+54 B) 23.7 kB (+78 B)
createVaporApp 21 kB (+123 B) 8.31 kB (+51 B) 7.62 kB (+51 B)
createSSRApp 60.3 kB 23.3 kB 21.3 kB
defineCustomElement 61 kB 23.1 kB 21.1 kB
overall 70.5 kB 26.8 kB 24.4 kB

Copy link

pkg-pr-new bot commented Aug 30, 2025
edited
Loading

Open in StackBlitz

@vue/compiler-core
npm i https://pkg.pr.new/@vue/compiler-core@13831
@vue/compiler-dom
npm i https://pkg.pr.new/@vue/compiler-dom@13831
@vue/compiler-sfc
npm i https://pkg.pr.new/@vue/compiler-sfc@13831
@vue/compiler-ssr
npm i https://pkg.pr.new/@vue/compiler-ssr@13831
@vue/compiler-vapor
npm i https://pkg.pr.new/@vue/compiler-vapor@13831
@vue/reactivity
npm i https://pkg.pr.new/@vue/reactivity@13831
@vue/runtime-core
npm i https://pkg.pr.new/@vue/runtime-core@13831
@vue/runtime-dom
npm i https://pkg.pr.new/@vue/runtime-dom@13831
@vue/runtime-vapor
npm i https://pkg.pr.new/@vue/runtime-vapor@13831
@vue/server-renderer
npm i https://pkg.pr.new/@vue/server-renderer@13831
@vue/shared
npm i https://pkg.pr.new/@vue/shared@13831
vue
npm i https://pkg.pr.new/vue@13831
@vue/compat
npm i https://pkg.pr.new/@vue/compat@13831

commit: 902e00b

Copy link

netlify bot commented Aug 30, 2025
edited
Loading

Deploy Preview for vue-sfc-playground failed. Why did it fail? →

Name Link
🔨 Latest commit 902e00b
🔍 Latest deploy log https://app.netlify.com/projects/vue-sfc-playground/deploys/68b90501a1c7d700084cd1ce

@zhiyuanzmj zhiyuanzmj added the scope: vapor related to vapor mode label Aug 31, 2025
@zhiyuanzmj zhiyuanzmj changed the title (削除) feat(vapor): implement defineVaporComponent types (削除ここまで) (追記) feat(runtime-vapor): implement defineVaporComponent types (追記ここまで) Aug 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: vapor related to vapor mode version: minor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /