feat: mark templateRef as deprecated (#4894)

ilyaliao · web-flow · commit 0271eef9db24 · 2025-07-27T07:14:31.000Z
diff --git a/packages/core/templateRef/index.md b/packages/core/templateRef/index.md
@@ -2,6 +2,12 @@
 category: Component
 ---
 
+::: info
+This function will be removed in future version.
+
+Vue 3.5 introduced the `useTemplateRef` API which can effectively replace the functionality of `templateRef`, therefore we recommend using the native approach.
+:::
+
 # templateRef
 
 Shorthand for binding ref to template element.
diff --git a/packages/core/templateRef/index.ts b/packages/core/templateRef/index.ts
@@ -3,6 +3,8 @@ import { tryOnMounted } from '@vueuse/shared'
 import { customRef, getCurrentInstance, onUpdated } from 'vue'
 
 /**
+ * @deprecated Use Vue's built-in `useTemplateRef` instead.
+ *
  * Shorthand for binding ref to template element.
  *
  * @see https://vueuse.org/templateRef

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@ import { tryOnMounted } from '@vueuse/shared'`
`3`	`3`	`import { customRef, getCurrentInstance, onUpdated } from 'vue'`
`4`	`4`
`5`	`5`	`/**`
	`6`	+ * @deprecated Use Vue's built-in `useTemplateRef` instead.
	`7`	`+ *`
`6`	`8`	`* Shorthand for binding ref to template element.`
`7`	`9`	`*`
`8`	`10`	`* @see https://vueuse.org/templateRef`