Hooks de Ciclo de Vida
O Nuxt fornece um sistema de hooks poderoso para expandir quase todos os aspectos usando hooks.
Hooks de Aplicação (tempo de execução)
Verifique o código fonte do app para todos os hooks disponíveis.
Hook | Argumentos | Ambiente | Descrição |
---|---|---|---|
app:created | vueApp | Servidor & Cliente | Chamado quando a instância inicial de vueApp é criada. |
app:error | err | Servidor & Cliente | Chamado quando ocorre um erro fatal. |
app:error:cleared | { redirect? } | Servidor & Cliente | Chamado quando um erro fatal ocorre. |
vue:setup | - | Servidor & Cliente | Chamado quando a configuração da raiz do Nuxt é inicializada. Este callback deve ser síncrono. |
vue:error | err, target, info | Servidor & Cliente | Chamado quando um erro do Vue se propaga para o componente raiz. Saiba Mais. |
app:rendered | renderContext | Servidor | Chamado quando a renderização SSR é concluída. |
app:redirected | - | Servidor | Chamado antes da redireção SSR. |
app:beforeMount | vueApp | Cliente | Chamado antes de montar o app, chamado apenas no lado do cliente. |
app:mounted | vueApp | Cliente | Chamado quando o app Vue é inicializado e montado no navegador. |
app:suspense:resolve | appComponent | Cliente | No evento resolvido de Suspense. |
app:manifest:update | { id, timestamp } | Cliente | Chamado quando uma versão mais recente do seu app é detectada. |
app:data:refresh | keys? | Cliente | Chamado quando refreshNuxtData é chamado. |
link:prefetch | to | Cliente | Chamado quando um <NuxtLink> é observado para ser pré-carregado. |
page:start | pageComponent? | Cliente | Chamado em Suspense dentro do evento pendente de NuxtPage . |
page:finish | pageComponent? | Cliente | Chamado em Suspense dentro do evento resolvido de NuxtPage . |
page:loading:start | - | Cliente | Chamado quando o setup() da nova página está em execução. |
page:loading:end | - | Cliente | Chamado após page:finish |
page:transition:finish | pageComponent? | Cliente | Após o evento de transição de página onAfterLeave. |
dev:ssr-logs | logs | Cliente | Chamado com um array de logs do lado do servidor que foram passados para o cliente (se features.devLogs estiver habilitado). |
page:view-transition:start | transition | Cliente | Chamado após document.startViewTransition ser chamado quando suporte experimental a viewTransition estiver habilitado. |
Hooks do Nuxt (tempo de construção)
Verifique o código fonte do schema para todos os hooks disponíveis.
Hook | Argumentos | Descrição |
---|---|---|
kit:compatibility | compatibility, issues | Permite estender verificações de compatibilidade. |
ready | nuxt | Chamado após a inicialização do Nuxt, quando a instância do Nuxt está pronta para funcionar. |
close | nuxt | Chamado quando a instância do Nuxt está fechando graciosamente. |
restart | { hard?: boolean } | Para ser chamado para reiniciar a instância atual do Nuxt. |
modules:before | - | Chamado durante a inicialização do Nuxt, antes de instalar módulos do usuário. |
modules:done | - | Chamado durante a inicialização do Nuxt, após instalar módulos do usuário. |
app:resolve | app | Chamado após resolver a instância app . |
app:templates | app | Chamado durante a geração do NuxtApp , para permitir personalizar, modificar ou adicionar novos arquivos ao diretório de construção (seja virtualmente ou escrito em .nuxt ). |
app:templatesGenerated | app | Chamado após os templates serem compilados no sistema de arquivos virtual (vfs). |
build:before | - | Chamado antes do construtor de pacotes do Nuxt. |
build:done | - | Chamado após o construtor de pacotes do Nuxt estar completo. |
build:manifest | manifest | Chamado durante a construção do manifesto pelo Vite e webpack. Isso permite personalizar o manifesto que o Nitro usará para renderizar tags <script> e <link> no HTML final. |
builder:generateApp | options | Chamado antes de gerar o app. |
builder:watch | event, path | Chamado no tempo de construção em desenvolvimento quando o observador detecta uma alteração em um arquivo ou diretório no projeto. |
pages:extend | pages | Chamado após as rotas de página serem escaneadas do sistema de arquivos. |
pages:resolved | pages | Chamado após as rotas de página terem sido aumentadas com metadados escaneados. |
pages:routerOptions | { files: Array<{ path: string, optional?: boolean }> } | Chamado ao resolver arquivos router.options . Itens posteriores no array substituem os anteriores. |
server:devHandler | handler | Chamado quando o middleware de desenvolvimento está sendo registrado no servidor de desenvolvimento do Nitro. |
imports:sources | presets | Chamado na configuração permitindo que módulos estendam fontes. |
imports:extend | imports | Chamado na configuração permitindo que módulos estendam importações. |
imports:context | context | Chamado quando o contexto unimport é criado. |
imports:dirs | dirs | Permite estender diretórios de importação. |
components:dirs | dirs | Chamado dentro de app:resolve permitindo estender os diretórios que são escaneados para componentes auto-importáveis. |
components:extend | components | Permite estender novos componentes. |
nitro:config | nitroConfig | Chamado antes de inicializar o Nitro, permitindo a personalização da configuração do Nitro. |
nitro:init | nitro | Chamado após o Nitro ser inicializado, o que permite registrar hooks do Nitro e interagir diretamente com o Nitro. |
nitro:build:before | nitro | Chamado antes de construir a instância do Nitro. |
nitro:build:public-assets | nitro | Chamado após copiar ativos públicos. Permite modificar ativos públicos antes que o servidor Nitro seja construído. |
prerender:routes | ctx | Permite estender as rotas a serem pré-renderizadas. |
build:error | error | Chamado quando ocorre um erro no tempo de construção. |
prepare:types | options | Chamado antes de @nuxt/cli escrever .nuxt/tsconfig.json e .nuxt/nuxt.d.ts , permitindo a adição de referências e declarações personalizadas em nuxt.d.ts , ou modificar diretamente as opções em tsconfig.json |
listen | listenerServer, listener | Chamado quando o servidor de desenvolvimento está carregando. |
schema:extend | schemas | Permite estender schemas padrão. |
schema:resolved | schema | Permite estender o schema resolvido. |
schema:beforeWrite | schema | Chamado antes de escrever o schema dado. |
schema:written | - | Chamado após o schema ser escrito. |
vite:extend | viteBuildContext | Permite estender o contexto padrão do Vite. |
vite:extendConfig | viteInlineConfig, env | Permite estender a configuração padrão do Vite. |
vite:configResolved | viteInlineConfig, env | Permite ler a configuração resolvida do Vite. |
vite:serverCreated | viteServer, env | Chamado quando o servidor Vite é criado. |
vite:compiled | - | Chamado após o servidor Vite ser compilado. |
webpack:config | webpackConfigs | Chamado antes de configurar o compilador webpack. |
webpack:configResolved | webpackConfigs | Permite ler a configuração resolvida do webpack. |
webpack:compile | options | Chamado logo antes da compilação. |
webpack:compiled | options | Chamado após os recursos serem carregados. |
webpack:change | shortPath | Chamado em change no WebpackBar. |
webpack:error | - | Chamado em done se houver erros no WebpackBar. |
webpack:done | - | Chamado em allDone no WebpackBar. |
webpack:progress | statesArray | Chamado em progress no WebpackBar. |
Hooks de Aplicação Nitro (tempo de execução, lado do servidor)
Veja Nitro para todos os hooks disponíveis.
Hook | Argumentos | Descrição | Tipos |
---|---|---|---|
dev:ssr-logs | { path, logs } | Servidor | Chamado no final de um ciclo de requisição com um array de logs do lado do servidor. |
render:response | response, { event } | Chamado antes de enviar a resposta. | response, event |
render:html | html, { event } | Chamado antes de construir o HTML. | html, event |
render:island | islandResponse, { event, islandContext } | Chamado antes de construir o HTML da ilha. | islandResponse, event, islandContext |
close | - | Chamado quando o Nitro é fechado. | - |
error | error, { event? } | Chamado quando ocorre um erro. | error, event |
request | event | Chamado quando uma requisição é recebida. | event |
beforeResponse | event, { body } | Chamado antes de enviar a resposta. | event, desconhecido |
afterResponse | event, { body } | Chamado após enviar a resposta. | event, desconhecido |
※Esta página é uma tradução não oficial da documentação oficial do Nuxt.js.
A página correspondente na documentação oficial está aqui:
https://nuxt.com/docs/3.x/api/advanced/hooks