diff --git a/docs/content/3.api/2.components/2.nuxt-layout.md b/docs/content/3.api/2.components/2.nuxt-layout.md index e32f5b6d00f..1c94d7dc59c 100644 --- a/docs/content/3.api/2.components/2.nuxt-layout.md +++ b/docs/content/3.api/2.components/2.nuxt-layout.md @@ -1,7 +1,61 @@ # `` -::ReadMore{link="/guide/directory-structure/app"} +You can use `` component to activate `default` layout on `app.vue` or `error.vue`. + +```vue [/app.vue] + +``` + +`` can be used to override `default` layout on `app.vue`, `error.vue` or even page components found in the `/pages` directory. + +## `name` prop + +`` component accepts the `name` prop, which you can pass to use a non-default layout, where `name` can be a static string, reactive reference or a computed property. It **must** match the name of the corresponding layout file in the `/layouts` directory. + +### Examples + +```vue [pages/index.vue] + + + +``` + +::alert{icon=👉} +Please note the layout name is normalized to kebab-case, so if your layout file is named `errorLayout.vue`, it will become `error-layout` when passed as a `name` property to ``. :: -::NeedContribution +```vue [/error.vue] + +``` + +## Layout and transition + +`` renders incoming content via ``, which is then wrapped around Vue’s `` component to activate layout transition. For this to work as expected, it is recommended that `` is **not** the root element of the page component. + +```vue [pages/index.vue] + +``` + +::ReadMore{link="/guide/directory-structure/layouts"} ::