Skip to content

fix(types): allow narrower HTMLElement types in function refs #14529

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

Open
7inspire wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(types): allow narrower HTMLElement types in function refs #14529

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
1 change: 1 addition & 0 deletions packages-private/dts-test/tsx.test-d.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ expectType<JSX.Element>(<div style={false} />)
// allow key/ref on arbitrary element
expectType<JSX.Element>(<div key="foo" />)
expectType<JSX.Element>(<div ref="bar" />)
expectType<JSX.Element>(<form ref={(el: HTMLFormElement | null) => {}} />)

expectType<JSX.Element>(
<input
Expand Down
14 changes: 10 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 @@ -86,10 +86,16 @@ export type VNodeTypes =
export type VNodeRef =
| string
| Ref
| ((
ref: Element | ComponentPublicInstance | null,
refs: Record<string, any>,
) => void)
| {
/**
* Make function refs bivariant so callbacks can accept
* narrower element types (e.g. HTMLFormElement).
*/
bivarianceHack(
ref: Element | ComponentPublicInstance | null,
refs: Record<string, any>,
): void
}['bivarianceHack']

export type VNodeNormalizedRefAtom = {
/**
Expand Down