Api
useTinaBridge()
Referensi API buat composable useTinaBridge(): akses postMessage low-level.
Akses langsung ke bridge postMessage TinaCMS di baliknya. Kebanyakan komponen sebaiknya pakai useTina() aja. Ini buat kasus di mana kamu butuh kirim atau dengar custom message yang nggak dikirim Tina Admin secara default.
Type signature
function useTinaBridge(): {
isInIframe: Ref<boolean>
sendToAdmin: (type: string, payload?: unknown) => void
onAdminMessage: <T = unknown>(type: string, callback: (payload: T) => void) => () => void
bridgeError: Ref<Error | null>
}
Return value
| Properti | Tipe | Deskripsi |
|---|---|---|
isInIframe | Ref<boolean> | true pas halamannya dimuat di dalam iframe Tina Admin. |
sendToAdmin | (type, payload?) => void | Kirim message { type, payload, source: 'nuxt-tina' } ke parent window. Nggak ngapa-ngapain kalau bukan di dalam iframe. |
onAdminMessage | (type, callback) => () => void | Subscribe ke message dengan type tertentu dari parent window. Balikin fungsi unsubscribe; juga otomatis dibersihkan pas unmount. |
bridgeError | Ref<Error | null> | Error terakhir yang ketangkep pas ngirim message ke Tina Admin, atau null. Sama-sama dipakai dengan useTina(): dua composable ini baca value yang sama. |
Contoh
<script setup lang="ts">
const { isInIframe, sendToAdmin, onAdminMessage } = useTinaBridge()
onAdminMessage<{ value: boolean }>('quickEditEnabled', (payload) => {
console.log('Quick edit toggled:', payload.value)
})
function notifyAdmin() {
sendToAdmin('my-custom-event', { foo: 'bar' })
}
</script>