🚧 Rspress 2.0 document is under development
close
Rspress
  • English

      • Root eject-only

      Warning

      This component is an eject-only component, specifically designed for wrap/eject, and it's not recommended to be used directly in MDX files.

      Root is a wrapper component for the entire application, wrapping all content including the Layout and global UI components.

      Its source code is as follows:

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

      Usage

      Eject this component to wrap custom providers:

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

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

      Props

      children

      • Type: ReactNode
      • Required: Yes

      The children elements to render, containing the entire application content.