Skip to content

Commit

Permalink
fix(core): make error boundary fallback a component instead of a call…
Browse files Browse the repository at this point in the history
…back (#7368)
  • Loading branch information
Josh-Cena authored May 7, 2022
1 parent 77fa3d1 commit f29bb73
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 18 deletions.
20 changes: 13 additions & 7 deletions packages/docusaurus-module-type-aliases/src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,14 @@ declare module '@theme-original/*';
declare module '@theme-init/*';

declare module '@theme/Error' {
export interface Props {
readonly error: Error;
readonly tryAgain: () => void;
}
import type {ComponentProps} from 'react';
import type ErrorBoundary from '@docusaurus/ErrorBoundary';

type ErrorProps = ComponentProps<
NonNullable<ComponentProps<typeof ErrorBoundary>['fallback']>
>;

export interface Props extends ErrorProps {}
export default function Error(props: Props): JSX.Element;
}

Expand Down Expand Up @@ -119,11 +123,13 @@ declare module '@docusaurus/constants' {
}

declare module '@docusaurus/ErrorBoundary' {
import type {ReactNode} from 'react';
import type ErrorComponent from '@theme/Error';
import type {ReactNode, ComponentType} from 'react';

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;
Expand Down
16 changes: 6 additions & 10 deletions packages/docusaurus/src/client/exports/ErrorBoundary.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
return fallback({
error,
tryAgain: () => this.setState({error: null}),
});
const Fallback = this.props.fallback ?? DefaultFallback;
return (
<Fallback error={error} tryAgain={() => this.setState({error: null})} />
);
}

return (
children ??
// See https://github.com/facebook/docusaurus/issues/6337#issuecomment-1012913647
null
);
// See https://github.com/facebook/docusaurus/issues/6337#issuecomment-1012913647
return children ?? null;
}
}
2 changes: 1 addition & 1 deletion website/docs/docusaurus-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down

0 comments on commit f29bb73

Please sign in to comment.