close
Rspress
  • 中文

      • Root

      Warning

      该组件主要配合 自定义主题 中的 wrap/eject 使用 ，与 MDX 里直接导入使用的组件不同，你可以通过传递组件 props 或直接覆盖该组件达到修改样式和功能的目的。如果通过 eject 覆盖整个组件，需注意组件对应配置项的读取会失效，需要自行控制。

      Root 是整个应用的包装组件，包裹所有内容（包括 Layout 和全局 UI 组件）。

      它的源代码如下：

      export function Root({ children }: RootProps) {
  return <>{children}</>;
}

      用法

      通过 eject 来使用它，用于包裹自定义的 Provider：

      theme/components/Root/index.tsx
      import type { RootProps } from '@rspress/core/theme';

export function Root({ children }: RootProps) {
  return <YourProvider>{children}</YourProvider>;
}

      Props

      children

      • 类型： ReactNode
      • 必填： 是

      需要渲染的子元素，包含整个应用的内容。