feat(types): add type TemplateRef

[Shinigami92]

This adds "just" a type-alias so we can reduce some code when defining a template-ref.

Right now we would need to write code like:

import { useTemplateRef, type ShallowRef } from 'vue'
const myRef: Readonly<ShallowRef<typeof MyComp>> = useTemplateRef('myRef')

With the change we can reduce that to:

import { useTemplateRef, type TemplateRef } from 'vue'
const myRef: TemplateRef<typeof MyComp> = useTemplateRef('myRef')

This makes the code also a little bit more easier to read for newcomers to the project.

I use lefthandside types very often because this ensures that what the developer is wanted to receive here instead of just type what is there. A bit like ts eslint explicit-module-boundary-types

[github-actions]

Size Report

Bundles

File	Size	Gzip	Brotli
runtime-dom.global.prod.js	100 kB	38.1 kB	34.3 kB
vue.global.prod.js	158 kB	58 kB	51.6 kB

Usages

Name	Size	Gzip	Brotli
createApp (CAPI only)	46.5 kB	18.2 kB	16.7 kB
createApp	54.5 kB	21.3 kB	19.5 kB
createSSRApp	58.7 kB	23 kB	21 kB
defineCustomElement	59.4 kB	22.9 kB	20.8 kB
overall	68.6 kB	26.4 kB	24 kB

[pkg-pr-new]

Open in Stackblitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@12645

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@12645

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@12645

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@12645

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@12645

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@12645

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@12645

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@12645

@vue/shared

npm i https://pkg.pr.new/@vue/shared@12645

vue

npm i https://pkg.pr.new/vue@12645

@vue/compat

npm i https://pkg.pr.new/@vue/compat@12645

commit: 2fd0e3d

[Shinigami92]

What's the status with this PR? Can anyone review it? Do I need to add anything?

[jh-leong]

Small nit: these can be simplified.

[Mrlilili]

This adds "just" a type-alias so we can reduce some code when defining a template-ref.

Right now we would need to write code like:

import { useTemplateRef, type ShallowRef } from 'vue'
const myRef: Readonly<ShallowRef<typeof MyComp>> = useTemplateRef('myRef')

With the change we can reduce that to:

import { useTemplateRef, type TemplateRef } from 'vue'
const myRef: TemplateRef<typeof MyComp> = useTemplateRef('myRef')

This makes the code also a little bit more easier to read for newcomers to the project.

I use lefthandside types very often because this ensures that what the developer is wanted to receive here instead of just type what is there. A bit like ts eslint explicit-module-boundary-types

@Shinigami92
Why not define the type of template refs using generic parameters?

like this:

const myRef = useTemplateRef<InstanceType<typeof MyComp>>('myRef')

The official documentation recommends implementing it this way.
https://vuejs.org/guide/typescript/composition-api.html#typing-component-template-refs

[Shinigami92]

@Mrlilili you literally quoted my post where I gave all the context. Why not just read it.