diff --git a/docs/02-app/02-api-reference/02-file-conventions/template.mdx b/docs/02-app/02-api-reference/02-file-conventions/template.mdx index cd0152d4dc99e..88e04e0bc860e 100644 --- a/docs/02-app/02-api-reference/02-file-conventions/template.mdx +++ b/docs/02-app/02-api-reference/02-file-conventions/template.mdx @@ -3,4 +3,53 @@ title: template.js description: API Reference for the template.js file. --- -This documentation is still being written. Please check back later. +A **template** file is similar to a [layout](/docs/app/building-your-application/routing/pages-and-layouts#layouts) in that it wraps each child layout or page. Unlike layouts that persist across routes and maintain state, templates create a new instance for each of their children on navigation. + +```tsx filename="app/template.tsx" switcher +export default function Template({ children }: { children: React.ReactNode }) { + return
{children}
+} +``` + +```jsx filename="app/template.jsx" switcher +export default function Template({ children }) { + return
{children}
+} +``` + +template.js special file + +While less common, you might choose a template over a layout if you want: + +- Features that rely on `useEffect` (e.g logging page views) and `useState` (e.g a per-page feedback form). +- To change the default framework behavior. For example, Suspense Boundaries inside layouts only show the fallback the first time the Layout is loaded and not when switching pages. For templates, the fallback is shown on each navigation. + +## Props + +### `children` (required) + +Template components should accept and use a `children` prop. `template` is rendered between a [layout](/docs/app/api-reference/file-conventions/layout) and its children. For example: + +```jsx filename="Output" + + {/* Note that the template is given a unique key. */} + + +``` + +> **Good to know**: +> +> - By default, `template` is a [Server Component](/docs/app/building-your-application/rendering/server-components), but can also be used as a [Client Component](/docs/app/building-your-application/rendering/client-components) through the `"use client"` directive. +> - When a user navigates between routes that share a `template`, a new instance of the component is mounted, DOM elements are recreated, state is **not** preserved, and effects are re-synchronized. + +## Version History + +| Version | Changes | +| --------- | ---------------------- | +| `v13.0.0` | `template` introduced. |