From 6cd67258fb0fcaf4aca3cf8adc36693e744671ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Chopin?= Date: Wed, 3 Aug 2022 12:56:01 +0200 Subject: [PATCH 1/5] docs(api): Add environment column on hooks --- docs/content/3.api/4.advanced/1.hooks.md | 28 +++++++++++------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/content/3.api/4.advanced/1.hooks.md b/docs/content/3.api/4.advanced/1.hooks.md index 7bf7b028836..6824cbc37a3 100644 --- a/docs/content/3.api/4.advanced/1.hooks.md +++ b/docs/content/3.api/4.advanced/1.hooks.md @@ -1,27 +1,25 @@ # Lifecycle Hooks -::ReadMore{link="/guide/going-further/hooks"} -:: +:ReadMore{link="/guide/going-further/hooks"} # App Hooks (runtime) Check the [app source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L18) for all available hooks. -Hook | Arguments | Description ------------------------|-------------------|--------------- -`app:created` | `vueApp` | When initial `vueApp` instance is created -`app:beforeMount` | `vueApp` | Same as `app:created` -`app:mounted` | `vueApp` | When Vue app is initialized and mounted in browser -`app:rendered` | - | When SSR rendering is done -`app:suspense:resolve` | `appComponent` | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event -`page:start` | `pageComponent` | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event -`page:finish` | `pageComponent` | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event -`meta:register` | `metaRenderers` | (internal) -`vue:setup` | - | (internal) +Hook | Arguments | Environment | Description | +-----------------------|-------------------|--------------|-------------| +`app:created` | `vueApp` | Server & Client | When initial `vueApp` instance is created | +`app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client-side. | +`app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser | +`app:rendered` | - | Server | When SSR rendering is done | +`app:suspense:resolve` | `appComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | +`page:start` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event | +`page:finish` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | +`meta:register` | `metaRenderers` | Server & Client | (internal) | +`vue:setup` | - | Server & Client | (internal) | # Nuxt Hooks (build time) Check the [schema source code](https://github.com/nuxt/framework/blob/main/packages/schema/src/types/hooks.ts#L55) for all available hooks. -::NeedContribution -:: +:NeedContribution From f7c860e5aaec252640cd9abcefb4a9f5bc76fa57 Mon Sep 17 00:00:00 2001 From: pooya parsa Date: Wed, 3 Aug 2022 13:24:31 +0200 Subject: [PATCH 2/5] Update docs/content/3.api/4.advanced/1.hooks.md Co-authored-by: Daniel Roe --- docs/content/3.api/4.advanced/1.hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/3.api/4.advanced/1.hooks.md b/docs/content/3.api/4.advanced/1.hooks.md index 6824cbc37a3..aed1b70d07d 100644 --- a/docs/content/3.api/4.advanced/1.hooks.md +++ b/docs/content/3.api/4.advanced/1.hooks.md @@ -11,7 +11,7 @@ Hook | Arguments | Environment | Description | `app:created` | `vueApp` | Server & Client | When initial `vueApp` instance is created | `app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client-side. | `app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser | -`app:rendered` | - | Server | When SSR rendering is done | +`app:rendered` | `renderContext` | Server | When SSR rendering is done | `app:suspense:resolve` | `appComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | `page:start` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event | `page:finish` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | From f2250183128338913ad0829827b3e3abcda04d76 Mon Sep 17 00:00:00 2001 From: pooya parsa Date: Wed, 3 Aug 2022 13:24:46 +0200 Subject: [PATCH 3/5] Update docs/content/3.api/4.advanced/1.hooks.md Co-authored-by: Daniel Roe --- docs/content/3.api/4.advanced/1.hooks.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/3.api/4.advanced/1.hooks.md b/docs/content/3.api/4.advanced/1.hooks.md index aed1b70d07d..3a13cdbb792 100644 --- a/docs/content/3.api/4.advanced/1.hooks.md +++ b/docs/content/3.api/4.advanced/1.hooks.md @@ -12,9 +12,9 @@ Hook | Arguments | Environment | Description | `app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client-side. | `app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser | `app:rendered` | `renderContext` | Server | When SSR rendering is done | -`app:suspense:resolve` | `appComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | -`page:start` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event | -`page:finish` | `pageComponent` | Server & Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | +`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | +`page:start` | `pageComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event | +`page:finish` | `pageComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | `meta:register` | `metaRenderers` | Server & Client | (internal) | `vue:setup` | - | Server & Client | (internal) | From f9c5bbbe22686d6fb485f4b8581d49c7b5d19aaa Mon Sep 17 00:00:00 2001 From: pooya parsa Date: Wed, 3 Aug 2022 13:26:30 +0200 Subject: [PATCH 4/5] Update docs/content/3.api/4.advanced/1.hooks.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Damian Głowala <48835293+DamianGlowala@users.noreply.github.com> --- docs/content/3.api/4.advanced/1.hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/3.api/4.advanced/1.hooks.md b/docs/content/3.api/4.advanced/1.hooks.md index 3a13cdbb792..8e3db555de1 100644 --- a/docs/content/3.api/4.advanced/1.hooks.md +++ b/docs/content/3.api/4.advanced/1.hooks.md @@ -9,7 +9,7 @@ Check the [app source code](https://github.com/nuxt/framework/blob/main/packages Hook | Arguments | Environment | Description | -----------------------|-------------------|--------------|-------------| `app:created` | `vueApp` | Server & Client | When initial `vueApp` instance is created | -`app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client-side. | +`app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client side. | `app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser | `app:rendered` | `renderContext` | Server | When SSR rendering is done | `app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | From 41b4f71e4dcb89b54cb4c9028f734e58af5c9751 Mon Sep 17 00:00:00 2001 From: Pooya Parsa Date: Thu, 4 Aug 2022 13:11:26 +0200 Subject: [PATCH 5/5] update table --- docs/content/3.api/4.advanced/1.hooks.md | 29 ++++++++++++++---------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/docs/content/3.api/4.advanced/1.hooks.md b/docs/content/3.api/4.advanced/1.hooks.md index 8e3db555de1..cc8abdb4903 100644 --- a/docs/content/3.api/4.advanced/1.hooks.md +++ b/docs/content/3.api/4.advanced/1.hooks.md @@ -4,19 +4,24 @@ # App Hooks (runtime) -Check the [app source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L18) for all available hooks. +Check the [app source code](https://github.com/nuxt/framework/blob/main/packages/nuxt/src/app/nuxt.ts#L24) for all available hooks. -Hook | Arguments | Environment | Description | ------------------------|-------------------|--------------|-------------| -`app:created` | `vueApp` | Server & Client | When initial `vueApp` instance is created | -`app:beforeMount` | `vueApp` | Client | Before mounting the app, called only on client side. | -`app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser | -`app:rendered` | `renderContext` | Server | When SSR rendering is done | -`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | -`page:start` | `pageComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event | -`page:finish` | `pageComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event | -`meta:register` | `metaRenderers` | Server & Client | (internal) | -`vue:setup` | - | Server & Client | (internal) | +Hook | Arguments | Environment | Description +-----------------------|---------------------|-----------------|------------- +`app:created` | `vueApp` | Server & Client | Called when initial `vueApp` instance is created. +`app:error` | `err` | Server & Client | Called when a fatal error occurs. +`app:error:cleared` | `{ redirect? }` | Server & Client | Called when a fatal error occurs. +`app:data:refresh` | `keys?` | Server & Client | (internal) +`meta:register` | `metaRenderers` | Server & Client | (internal) +`vue:setup` | - | Server & Client | (internal) +`vue:error` | `err, target, info` | Server & Client | Called when a vue error propages to the root component. [Learn More](https://vuejs.org/api/composition-api-lifecycle.html#onerrorcaptured). +`app:rendered` | `renderContext` | Server | Called when SSR rendering is done. +`app:redirected` | - | Server | Called before SSR redirection. +`app:beforeMount` | `vueApp` | Client | Called before mounting the app, called only on client side. +`app:mounted` | `vueApp` | Client | Called when Vue app is initialized and mounted in browser. +`app:suspense:resolve` | `appComponent` | Client | On [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event +`page:start` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) pending event. +`page:finish` | `pageComponent?` | Client | Called on [Suspense](https://vuejs.org/guide/built-ins/suspense.html#suspense) resolved event. # Nuxt Hooks (build time)