生命週期鉤子
Nuxt 提供強大的鉤子系統,幾乎可以使用鉤子擴展每個方面。
鉤子系統由 unjs/hookable 提供技術支持。
Nuxt 鉤子(建置時期)
這些鉤子適用於 Nuxt 模組和建置上下文。
在 nuxt.config.ts
中
nuxt.config.ts
export default defineNuxtConfig({
hooks: {
close: () => { }
}
})
在 Nuxt 模組中
import { defineNuxtModule } from '@nuxt/kit'
export default defineNuxtModule({
setup (options, nuxt) {
nuxt.hook('close', async () => { })
}
})
App 鉤子(運行時期)
App 鉤子主要可以被 Nuxt 插件用來鉤入渲染生命週期,但也可用於 Vue composable。
plugins/test.ts
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.hook('page:start', () => {
/* your code goes here */
})
})
伺服器鉤子(運行時期)
這些鉤子適用於伺服器插件,以鉤入 Nitro 的運行時行為。
~/server/plugins/test.ts
export default defineNitroPlugin((nitroApp) => {
nitroApp.hooks.hook('render:html', (html, { event }) => {
console.log('render:html', html)
html.bodyAppend.push('<hr>Appended by custom plugin')
})
nitroApp.hooks.hook('render:response', (response, { event }) => {
console.log('render:response', response)
})
})
額外鉤子
您可以通過擴展 Nuxt 提供的類型來添加額外的鉤子。這對於模組可能很有用。
import { HookResult } from "@nuxt/schema";
declare module '#app' {
interface RuntimeNuxtHooks {
'your-nuxt-runtime-hook': () => HookResult
}
interface NuxtHooks {
'your-nuxt-hook': () => HookResult
}
}
declare module 'nitropack' {
interface NitroRuntimeHooks {
'your-nitro-hook': () => void;
}
}