Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

docs(api): add missing hooks and environment column #6329

Merged
merged 5 commits into from
Aug 4, 2022
Merged

docs(api): add missing hooks and environment column #6329

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6cd6725
docs(api): Add environment column on hooks
atinux Aug 3, 2022
f7c860e
Update docs/content/3.api/4.advanced/1.hooks.md
pi0 Aug 3, 2022
f225018
Update docs/content/3.api/4.advanced/1.hooks.md
pi0 Aug 3, 2022
f9c5bbb
Update docs/content/3.api/4.advanced/1.hooks.md
pi0 Aug 3, 2022
41b4f71
update table
pi0 Aug 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions docs/content/3.api/4.advanced/1.hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
pi0 marked this conversation as resolved.
Show resolved Hide resolved
`app:mounted` | `vueApp` | Client | When Vue app is initialized and mounted in browser |
pi0 marked this conversation as resolved.
Show resolved Hide resolved
`app:rendered` | - | Server | When SSR rendering is done |
pi0 marked this conversation as resolved.
Show resolved Hide resolved
pi0 marked this conversation as resolved.
Show resolved Hide resolved
`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 |
pi0 marked this conversation as resolved.
Show resolved Hide resolved
`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