Şablon Referansları
Vue’nun bildirimsel render modeli, doğrudan DOM işlemlerinin büyük kısmını sizin için soyutlar. Ancak bazı durumlarda alttaki DOM öğelerine doğrudan erişmemiz gerekebilir. Bunu sağlamak için özel ref niteliğini kullanabiliriz:
template
<input ref="input">ref, v-for bölümünde ele alınan key niteliğine benzer özel bir niteliktir. Belirli bir DOM öğesine veya alt bileşen örneğine, mount edildikten sonra doğrudan referans almamızı sağlar. Bu özellik, örneğin bir bileşen mount edildiğinde bir input öğesine programatik olarak odaklanmak veya bir öğe üzerinde üçüncü taraf bir kütüphaneyi başlatmak istediğiniz durumlarda faydalı olabilir.
Referanslara Erişim
Composition API ile referansı elde etmek için useTemplateRef() yardımcı fonksiyonunu kullanabiliriz:
vue
<script setup>
import { useTemplateRef, onMounted } from 'vue'
// ilk argüman, şablondaki ref değeriyle eşleşmelidir
const input = useTemplateRef('my-input')
onMounted(() => {
input.value.focus()
})
</script>
<template>
<input ref="my-input" />
</template>TypeScript kullanırken Vue'nun IDE desteği ve vue-tsc, eşleşen ref niteliğinin hangi öğe veya bileşen üzerinde kullanıldığına bağlı olarak input.value türünü otomatik olarak çıkarır.
3.5 öncesi kullanım
useTemplateRef() fonksiyonunun henüz sunulmadığı 3.5 öncesi sürümlerde, adı şablondaki ref niteliğinin değeriyle eşleşen bir ref tanımlamamız gerekir:
vue
<script setup>
import { ref, onMounted } from 'vue'
// öğe referansını tutacak bir ref tanımlayın
// ad, şablondaki ref değeriyle eşleşmelidir
const input = ref(null)
onMounted(() => {
input.value.focus()
})
</script>
<template>
<input ref="input" />
</template><script setup> kullanmıyorsanız, ref'i setup() içinden de döndürdüğünüzden emin olun:
js
export default {
setup() {
const input = ref(null)
// ...
return {
input
}
}
}Ref'e yalnızca bileşen mount edildikten sonra erişebileceğinizi unutmayın. input değerine bir şablon ifadesi içinde erişmeye çalışırsanız, ilk render sırasında null olur. Bunun nedeni, öğenin ilk render tamamlanana kadar var olmamasıdır.
Bir şablon ref'inin değişimlerini izlemeye çalışıyorsanız, ref'in null olduğu durumu da hesaba kattığınızdan emin olun:
js
watchEffect(() => {
if (input.value) {
input.value.focus()
} else {
// henüz mount edilmedi veya öğe unmount edildi (ör. v-if nedeniyle)
}
})Ayrıca bkz.: Şablon Referanslarını Türleme
Bileşen Üzerinde Ref
Bu bölüm, Bileşenler hakkında bilgi sahibi olduğunuzu varsayar. İsterseniz bu bölümü şimdilik atlayıp daha sonra geri dönebilirsiniz.
ref, bir alt bileşen üzerinde de kullanılabilir. Bu durumda referans, bileşen örneğine ait olur:
vue
<script setup>
import { useTemplateRef, onMounted } from 'vue'
import Child from './Child.vue'
const childRef = useTemplateRef('child')
onMounted(() => {
// childRef.value, <Child /> örneğini tutacaktır
})
</script>
<template>
<Child ref="child" />
</template>3.5 öncesi kullanım
vue
<script setup>
import { ref, onMounted } from 'vue'
import Child from './Child.vue'
const child = ref(null)
onMounted(() => {
// child.value, <Child /> örneğini tutacaktır
})
</script>
<template>
<Child ref="child" />
</template>Alt bileşen Options API kullanıyorsa veya <script setup> kullanmıyorsa, referans verilen örnek alt bileşenin this değeriyle aynı olacaktır. Bu da üst bileşenin, alt bileşenin tüm özellik ve metotlarına tam erişimi olacağı anlamına gelir. Bu durum, üst ve alt bileşenin uygulama ayrıntıları arasında sıkı bağlantılar oluşturabilir. Bu nedenle bileşen ref'leri yalnızca gerçekten gerektiğinde kullanılmalıdır. Çoğu durumda önce standart props ve emit arayüzleriyle üst / alt bileşen etkileşimlerini kurmayı denemelisiniz.
Buradaki istisna, <script setup> kullanan bileşenlerin varsayılan olarak dışarıya kapalı olmasıdır: <script setup> kullanan bir alt bileşene referans veren üst bileşen, alt bileşen defineExpose makrosunu kullanarak genel bir arayüz sunmayı seçmediği sürece hiçbir şeye erişemez:
vue
<script setup>
import { ref } from 'vue'
const a = 1
const b = ref(2)
// defineExpose gibi derleyici makrolarının import edilmesi gerekmez
defineExpose({
a,
b
})
</script>Üst bileşen, şablon referansları aracılığıyla bu bileşenin bir örneğini aldığında elde edilen örnek { a: number, b: number } biçiminde olur (ref'ler, normal örneklerde olduğu gibi otomatik olarak açılır).
defineExpose, herhangi bir await işleminden önce çağrılmalıdır. Aksi takdirde await işleminden sonra dışarıya açılan özellikler ve metotlara erişilemez.
Ayrıca bkz.: Bileşen Şablon Referanslarını Türleme
v-for İçindeki Ref'ler
v3.5 veya üzerini gerektirir
ref, v-for içinde kullanıldığında ilgili ref bir dizi değeri içermelidir. Bu dizi, mount işleminden sonra ilgili öğelerle doldurulur:
vue
<script setup>
import { ref, useTemplateRef, onMounted } from 'vue'
const list = ref([
/* ... */
])
const itemRefs = useTemplateRef('items')
onMounted(() => console.log(itemRefs.value))
</script>
<template>
<ul>
<li v-for="item in list" ref="items">
{{ item }}
</li>
</ul>
</template>3.5 öncesi kullanım
useTemplateRef() fonksiyonunun henüz sunulmadığı 3.5 öncesi sürümlerde, adı şablondaki ref niteliğinin değeriyle eşleşen bir ref tanımlamamız gerekir. Bu ref ayrıca bir dizi değeri de içermelidir:
vue
<script setup>
import { ref, onMounted } from 'vue'
const list = ref([
/* ... */
])
const itemRefs = ref([])
onMounted(() => console.log(itemRefs.value))
</script>
<template>
<ul>
<li v-for="item in list" ref="itemRefs">
{{ item }}
</li>
</ul>
</template>Ref dizisinin, kaynak diziyle aynı sırayı garanti etmediğini unutmayın.
Fonksiyon Ref'leri
Bir string anahtar yerine ref niteliği bir fonksiyona da bağlanabilir. Bu fonksiyon her bileşen güncellemesinde çağrılır ve referansı nasıl saklayacağınız konusunda tam esneklik sağlar. Fonksiyon, ilk argüman olarak öğe referansını alır:
template
<input :ref="(el) => { /* assign el to a property or ref */ }">Burada, ref adı olarak bir string yerine fonksiyon geçirebilmek için dinamik :ref bağlaması kullandığımıza dikkat edin. Öğe unmount edildiğinde argüman null olur. Elbette satır içi bir fonksiyon yerine bir metot da kullanabilirsiniz.