From 5bc8c10a3b7e4301cee3d4110316aef59a3e91c4 Mon Sep 17 00:00:00 2001 From: Dawid Stefanko <34492112+mitow7821@users.noreply.github.com> Date: Wed, 26 Oct 2022 12:50:40 +0200 Subject: [PATCH] docs: mention use case for `` in `definePageMeta` (#8491) --- docs/content/2.guide/2.directory-structure/1.pages.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/content/2.guide/2.directory-structure/1.pages.md b/docs/content/2.guide/2.directory-structure/1.pages.md index a90ace6d0f9..669245b66d3 100644 --- a/docs/content/2.guide/2.directory-structure/1.pages.md +++ b/docs/content/2.guide/2.directory-structure/1.pages.md @@ -268,7 +268,9 @@ Of course, you are welcome to define metadata for your own use throughout your a #### `keepalive` -Nuxt will automatically wrap your page in [the Vue `` component](https://vuejs.org/guide/built-ins/keep-alive.html#keepalive) if you set `keepalive: true` in your `definePageMeta`. This might be useful to do, for example, in a parent route that has dynamic child routes, if you want to preserve page state across route changes. You can also set props to be passed to `` (see a full list [here](https://vuejs.org/api/built-in-components.html#keepalive)). +Nuxt will automatically wrap your page in [the Vue `` component](https://vuejs.org/guide/built-ins/keep-alive.html#keepalive) if you set `keepalive: true` in your `definePageMeta`. This might be useful to do, for example, in a parent route that has dynamic child routes, if you want to preserve page state across route changes. + +When your goal is to preserve state for parent routes use this syntax: ``. You can also set props to be passed to `` (see a full list [here](https://vuejs.org/api/built-in-components.html#keepalive)). You can set a default value for this property [in your `nuxt.config`](/api/configuration/nuxt-config#keepalive).