Vize
vize:croquis/cf/template-ref-timing
A template ref is read before the component is mounted.
Default severity: Not emitted
Applies to: Analyzed component graph and the supported facts described below
Automatic fix: None; review related files and apply the repair
Options: No per-code options; supported CLI findings accept severity overrides
This is a published diagnostic contract without a current producer. The Bad/Good scenario below explains the risk and repair; no flag currently makes this code trigger.
Shared project files
Use these unchanged files in both Bad and Good. Install the imported packages in the project: Vue, plus vue-router or Pinia where shown. Follow any version-specific support note. The entry root makes the component relationship explicit.
main.ts
import { createApp } from 'vue';
import App from './App.vue';
createApp(App).mount('#app');
index.html
<!doctype html>
<html lang="en"><head><meta charset="UTF-8"><title>Contract scenario</title></head>
<body><div id="app"></div><script type="module" src="/main.ts"></script></body></html>
focus-input.ts
export function focusInput(input: HTMLInputElement | null): void { input?.focus(); }
Bad
Setup reads the template ref before mounting, when its value is still null. The optional focus call therefore performs no focus action.
App.vue
<script setup lang="ts">
import { ref } from 'vue';
import { focusInput } from './focus-input';
const input = ref<HTMLInputElement | null>(null);
focusInput(input.value);
</script>
<template>
<input ref="input" aria-label="Name" />
</template>
Good
onMounted defers the read until Vue has assigned the input element to the template ref, allowing the focus helper to act on it.
App.vue
<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { focusInput } from './focus-input';
const input = ref<HTMLInputElement | null>(null);
onMounted(() => { focusInput(input.value); });
</script>
<template>
<input ref="input" aria-label="Name" />
</template>
The Good files demonstrate the change described above; other diagnostics can still apply to the complete project.