Skip to content

fix(runtime-core): relax function ref callback variance #14658

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

Closed
Misrilal-Sah wants to merge 1 commit into from
Closed

fix(runtime-core): relax function ref callback variance #14658

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions packages-private/dts-test/h.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ describe('h inference w/ element', () => {
h('div', { ref: 'foo' })
h('div', { ref: ref(null) })
h('div', { ref: _el => {} })
h('form', { ref: (_el: HTMLFormElement | null) => {} })
h('div', { ref: (_el: HTMLDivElement | null) => {} })
// @ts-expect-error
h('div', { ref: [] })
// @ts-expect-error
Expand Down
12 changes: 8 additions & 4 deletions packages/runtime-core/src/vnode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,14 @@ export type VNodeTypes =
export type VNodeRef =
| string
| Ref
| ((
ref: Element | ComponentPublicInstance | null,
refs: Record<string, any>,
) => void)
| {
// Bivariant callback param allows assigning more specific element types,
// e.g. (el: HTMLFormElement | null) => void for <form ref="...">.
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example in the new comment is slightly misleading for function refs: <form ref="..."> reads like a string ref. Consider changing it to something like <form :ref="(el: HTMLFormElement | null) => {}"> (or otherwise clarify it’s a function ref) so the comment matches the feature being typed here.

Suggested change
// e.g. (el: HTMLFormElement | null) => void for <form ref="...">.
// e.g. (el: HTMLFormElement | null) => void for
// <form :ref="(el: HTMLFormElement | null) => {}">.

Copilot uses AI. Check for mistakes.
bivarianceHack(
ref: Element | ComponentPublicInstance | null,
refs: Record<string, any>,
): void
}['bivarianceHack']

export type VNodeNormalizedRefAtom = {
/**
Expand Down
Loading