跳至内容

template.js

一个 **模板** 文件类似于 布局,因为它会包装布局或页面。与跨路由持续存在并保持状态的布局不同,模板具有唯一的键,这意味着子客户端组件在导航时会重置其状态。

app/template.tsx
export default function Template({ children }: { children: React.ReactNode }) {
  return <div>{children}</div>
}
template.js special file

虽然不太常见,但如果您想要使用模板而不是布局,您可以

  • 依赖于 useEffect(例如记录页面浏览量)和 useState(例如每个页面的反馈表单)的功能。
  • 更改默认框架行为。例如,布局内的 Suspense 边界仅在首次加载布局时显示回退,而不是在切换页面时显示。对于模板,在每次导航时都会显示回退。

属性

children(必需)

模板接受一个 children 属性。例如

输出
<Layout>
  {/* Note that the template is automatically given a unique key. */}
  <Template key={routeParam}>{children}</Template>
</Layout>

需要了解:

  • 默认情况下,template 是一个 服务器组件,但也可以通过 "use client" 指令用作 客户端组件
  • 当用户在共享 template 的路由之间导航时,会挂载组件的新实例,DOM 元素会被重新创建,客户端组件中的状态 **不会** 保留,并且效果会重新同步。

版本历史

版本更改
v13.0.0引入 template