fix(core): make error boundary fallback a component instead of a callback (#7368)

packages/docusaurus-module-type-aliases/src/index.d.ts

@@ -75,10 +75,14 @@ declare module '@theme-original/*';
 declare module '@theme-init/*';
 
 declare module '@theme/Error' {
-  export interface Props {
+  import type {ComponentProps} from 'react';
-    readonly error: Error;
+  import type ErrorBoundary from '@docusaurus/ErrorBoundary';
-    readonly tryAgain: () => void;
+
-  }
+  type ErrorProps = ComponentProps<
+    NonNullable<ComponentProps<typeof ErrorBoundary>['fallback']>
+  >;
+
+  export interface Props extends ErrorProps {}
   export default function Error(props: Props): JSX.Element;
 }
 
@@ -119,11 +123,13 @@ declare module '@docusaurus/constants' {
 }
 
 declare module '@docusaurus/ErrorBoundary' {
-  import type {ReactNode} from 'react';
+  import type {ReactNode, ComponentType} from 'react';
-  import type ErrorComponent from '@theme/Error';
 
   export interface Props {
-    readonly fallback?: typeof ErrorComponent;
+    readonly fallback?: ComponentType<{
+      readonly error: Error;
+      readonly tryAgain: () => void;
+    }>;
     readonly children: ReactNode;
   }
   export default function ErrorBoundary(props: Props): JSX.Element;

packages/docusaurus/src/client/exports/ErrorBoundary.tsx

@@ -33,17 +33,13 @@ export default class ErrorBoundary extends React.Component<Props, State> {
     const {error} = this.state;
 
     if (error) {
-      const fallback = this.props.fallback ?? DefaultFallback;
+      const Fallback = this.props.fallback ?? DefaultFallback;
-      return fallback({
-        error,
-        tryAgain: () => this.setState({error: null}),
-      });
-    }
-
       return (
-      children ??
+        <Fallback error={error} tryAgain={() => this.setState({error: null})} />
-      // See https://github.com/facebook/docusaurus/issues/6337#issuecomment-1012913647
-      null
       );
     }
+
+    // See https://github.com/facebook/docusaurus/issues/6337#issuecomment-1012913647
+    return children ?? null;
+  }
 }

website/docs/docusaurus-core.md

@@ -55,7 +55,7 @@ This component doesn't catch build-time errors and only protects against client-
 
 #### Props {#errorboundary-props}
 
-- `fallback`: an optional callback returning a JSX element. It will receive two props: `error`, the error that was caught, and `tryAgain`, a function (`() => void`) callback to reset the error in the component and try rendering it again.
+- `fallback`: a React component. The error boundary will render the component with two props: `error`, the error that was caught, and `tryAgain`, a function (`() => void`) callback to reset the error in the component and try rendering it again.
 
 ### `<Head/>` {#head}