Skip to content

Error boundary example fix #166

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
merged 5 commits into from
Apr 28, 2019
Merged

Error boundary example fix #166

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
928be8e
Updated error boundary example with working code
mathiassoeholm Apr 24, 2019
bb7b889
Merge branch 'master' into error-boundary-example-fix
mathiassoeholm Apr 28, 2019
81840f7
Updates based on review
mathiassoeholm Apr 28, 2019
34db7ac
Updated example in readme
mathiassoeholm Apr 28, 2019
6da1bbb
Some white space change
mathiassoeholm Apr 28, 2019
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
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,18 +624,35 @@ export const withErrorBoundary = <BaseProps extends InjectedProps>(

```tsx
import * as React from 'react';
import {useState} from 'react';

import { withErrorBoundary } from '../hoc';
import { ErrorMessage } from '../components';

const ErrorMessageWithErrorBoundary =
withErrorBoundary(ErrorMessage);

const BrokenButton = () => (
<button type="button" onClick={() => { throw new Error(`Catch me!`); }}>
{`Throw nasty error`}
</button >
);
const BrokenButton = () => {
const [throwError, setThrowError] = useState(false);

if (throwError) {
throw new Error('Catch me!');
}

return (
<button
type="button"
onClick={() => {
// We don't just throw the error here, because error boundaries
// only catch errors thrown by render and lifecycle methods. Read more:
// https://reactjs.org/docs/error-boundaries.html#how-about-event-handlers
setThrowError(true);
}}
>
{`Throw nasty error`}
</button>
);
};

export default () => (
<ErrorMessageWithErrorBoundary>
Expand Down
27 changes: 22 additions & 5 deletions playground/src/hoc/with-error-boundary.usage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
import * as React from 'react';
import {useState} from 'react';

import { withErrorBoundary } from '../hoc';
import { ErrorMessage } from '../components';

const ErrorMessageWithErrorBoundary =
withErrorBoundary(ErrorMessage);

const BrokenButton = () => (
<button type="button" onClick={() => { throw new Error(`Catch me!`); }}>
{`Throw nasty error`}
</button >
);
const BrokenButton = () => {
const [throwError, setThrowError] = useState(false);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename throwError to shouldRenderBrokenComponent

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line became quite long because of [shouldRenderBrokenComponent, setShouldRenderBrokenComponent]
so I think setShouldBreak would be a better name.


if (throwError) {
throw new Error('Catch me!');
}

return (
<button
type="button"
onClick={() => {
// We don't just throw the error here, because error boundaries
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer just:

Error boundaries catch errors during rendering and do not work inside event handlers:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tbh, I think that comment will just confuse whoever is reading through the example. I removed the comment altogether now.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's fine 👍

// only catch errors thrown by render and lifecycle methods. Read more:
// https://reactjs.org/docs/error-boundaries.html#how-about-event-handlers
setThrowError(true);
}}
>
{`Throw nasty error`}
</button>
);
};

export default () => (
<ErrorMessageWithErrorBoundary>
Expand Down