Skip to content

fix(type): provide the additional parsing method for $emit parameter to correct the type parser error when using useTemplateRef with component. fixes #5072 #5087

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(type): provide the additional parsing method for $emit parameter to correct the type parser error when using useTemplateRef with component. fixes #5072 #5087

wants to merge 2 commits into from

Conversation

@Stan-BK
Copy link

@Stan-BK Stan-BK commented Oct 3, 2025 •
edited
Loading

Before submitting the PR, please make sure you do the following

  • [ ✅ ] Read the Contributing Guidelines.
  • [ ✅ ] Read the Pull Request Guidelines.
  • [ ✅ ] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • [ ✅ ] Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • [ ✅ ] Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

That pr resolve the type error when sub component have defineEmits. See the problem at #5072.

Additional context

Thats a quick view of the solution, you can copy the following code into the script block of reproduction provided by the issue submitter, and then run npm run type-check to see that problem is resolve.

<script setup lang="ts">
import { useTemplateRef } from 'vue';
import { useElementSize } from '@vueuse/core';
import type { ComponentPublicInstance } from 'vue';
import Component from './Component.vue';

type EmitFuncs<T> = T extends (event: infer J, ...args: any[]) => void & infer K
  ? (event: J extends string ? any : J, ...args: any[]) => void & EmitFuncs<K>
  : void;
type VueInstance = {
  [key in keyof ComponentPublicInstance]: key extends '$emit'
    ? EmitFuncs<ComponentPublicInstance[key]>
    : ComponentPublicInstance[key];
};

const componentRef = useTemplateRef<VueInstance>('componentRef');
const { width } = useElementSize(componentRef);

const componentConsumeEmitRef = useTemplateRef<VueInstance>(
  'componentConsumeEmitRef'
);
function onComponentMounted() {}
const { width: widthTwo } = useElementSize(componentConsumeEmitRef);
</script>

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Oct 3, 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

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Stan-BK