Skip to content

fix(live-codeblock): add error boundary to live code preview #8015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 9 commits into from
Oct 13, 2022
Merged

fix(live-codeblock): add error boundary to live code preview #8015

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b97fe66
added error boundary to playground
Aug 27, 2022
9c553c3
using error boundary from core
Aug 27, 2022
ed6c9e0
undo changes
Aug 27, 2022
7606bb2
removed id and description from button label
Aug 27, 2022
d32c495
result header for error fallback
Sep 1, 2022
96c1942
duplication fix
Sep 1, 2022
c08c711
error boundary padding
Sep 2, 2022
ce08b83
Merge branch 'main' into playground-error-boundary
slorber Oct 13, 2022
fd54f12
improve tryAgain button integration
slorber Oct 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions packages/docusaurus-theme-live-codeblock/src/theme/Playground/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ import Translate from '@docusaurus/Translate';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import BrowserOnly from '@docusaurus/BrowserOnly';
import {usePrismTheme} from '@docusaurus/theme-common';
import ErrorBoundary from '@docusaurus/ErrorBoundary';

import type {Props} from '@theme/Playground';
import type {Props as ErrorProps} from '@theme/Error';
import type {ThemeConfig} from '@docusaurus/theme-live-codeblock';

import styles from './styles.module.css';
Expand Down Expand Up @@ -81,6 +83,17 @@ function EditorWithHeader() {
);
}

function ErrorFallback({error, tryAgain}: ErrorProps): JSX.Element {
return (
<div>
<p>{error.message}</p>
<button type="button" onClick={tryAgain}>
<Translate>Try Again!</Translate>
</button>
</div>
);
}

export default function Playground({
children,
transformCode,
Expand All @@ -107,13 +120,17 @@ export default function Playground({
{...props}>
{playgroundPosition === 'top' ? (
<>
<ResultWithHeader />
<ErrorBoundary fallback={ErrorFallback}>
<ResultWithHeader />
</ErrorBoundary>
<EditorWithHeader />
</>
) : (
<>
<EditorWithHeader />
<ResultWithHeader />
<ErrorBoundary fallback={ErrorFallback}>
<ResultWithHeader />
</ErrorBoundary>
</>
)}
</LiveProvider>
Expand Down