245- Add @types/react as an optional peer dependency

README and doc comment updates

• Fixed a problem with project logo not displaying correctly in the README for the Firefox browser.

• #235: Fix error type (Error -> unknown)
• Export getErrorMessage helper method

• Removed react-dom from peer dependencies list; it was accidentally added during a previous internal refactor

Updated README and generated TS docs

Updated README and generated docs

Module is ESM-only in order to better work with modern tooling.

Update withErrorBoundary types to be compatible with the latest forwardRef types

For more background see PR #211

• Remove engines field from Package JSON entirely

• Remove node constraint from engines

• Relax fallback prop to support broader ReactNode type

Removed references to ESLint config kcd-scripts from package.json

• Support null fallback prop (#169)

• Re-throw original error in the event that no fallback is specified (#160)
• Improved exported prop types def (#152)
• Bundle built with Preconstruct (#144, #149, 9b7b15bc29829b2a145c047ef188fecb90c9894e)

• Target Safari 12+ compatibility (by removing optional chaining operator and default parameters)

• 145: Removed explicit ErrorBoundary.render return type to avoid TypeScript error:

'ErrorBoundary' cannot be used as a JSX component.

• 144: Build release bundle with Preconstruct

*Replaced post-processing "use client" insertion step with a custom Parcel plug-in. This should hopefully produce better source maps.

• Removed arrow function syntax to support older versions of Safari

Move "use client" directive to top of the bundled file.

• withErrorBoundary forwards refs
• Add "use client" directive

Fix broken TypeScript definitions file (#133, https://github.com/parcel-bundler/parcel/issues/8908)

• Render ErrorBoundaryContext around fallback UI as well, so the useErrorBoundary hook could be used within the fallback component to reset the boundary.

For example:

import { useErrorBoundary } from "react-error-boundary";

function ErrorFallback({ error }) {
  const { resetBoundary } = useErrorBoundary();

  return (
    <div role="alert">
      <p>Something went wrong:</p>
      <pre style={{ color: "red" }}>{error.message}</pre>
      <button onClick={resetBoundary}>Try again</button>
    </div>
  );
}

See this demo: https://codesandbox.io/s/nostalgic-browser-e9lpmf

• Replace useErrorHandler hook with useErrorBoundary; can be used to trigger an error boundary or dismiss one
• Merge onReset and onResetKeys props; pass "details" object explaining the cause of the reset

Why did the useErrorHandler hook change?

The old hook had two design flaws, both related to the givenError parameter:

1. All the hook did was throw this value. This seemed unnecessary, because if a component already has a reference to an error during render, it can just throw the value itself.

• It would not properly re-throw null or undefined values. (Although an edge case, JavaScript enables throwing any values/types.)

If you were using the givenError functionality– you can now just throw the value directly instead.

// Before
function Greeting() {
  const [name, setName] = React.useState('')
  const {greeting, error} = useGreeting(name)
  useErrorHandler(error)

// After
function Greeting() {
  const [name, setName] = React.useState('')
  const {greeting, error} = useGreeting(name)
  if (error) {
    throw error;
  }

How can I use the new useErrorHandler hook?

Show the nearest error boundary from an event handler

React only handles errors thrown during render or during component lifecycle methods (e.g. effects and did-mount/did-update). Errors thrown in event handlers, or after async code has run, will not be caught.

This hook can be used to pass those errors to the nearest error boundary:

import { useErrorBoundary } from "react-error-boundary";

function Example() {
  const { showBoundary } = useErrorBoundary();

  useEffect(() => {
    fetchGreeting(name).then(
      response => {
        // Set data in state and re-render
      },
      error => {
        // Show error boundary
        showBoundary(error);
      }
    );
  });

  // Render ...
}

Dismiss the nearest error boundary

A fallback component can use this hook to request the nearest error boundary retry the render that original failed.

import { useErrorBoundary } from "react-error-boundary";

function ErrorFallback({ error }) {
  const { resetBoundary } = useErrorBoundary();

  return (
    <div role="alert">
      <p>Something went wrong:</p>
      <pre style={{ color: "red" }}>{error.message}</pre>
      <button onClick={resetBoundary}>Try again</button>
    </div>
  );
}

3.1.4 (2021-10-29)

Bug Fixes

• remove class instance property (#98) (a0a370c)

3.1.3 (2021-05-05)

Bug Fixes

• useErrorHandler: use unknown instead of Error (#89) (ec81d61), closes #83

3.1.2 (2021-05-05)

Bug Fixes

• TS: help typescript to find his way for the ErrorBoundaryProps union (#90) (fb0b859)

3.1.1 (2021-03-02)

Bug Fixes

• ignored update after error triggered on component mount (#85) (125d9e9), closes #74 #84

3.1.0 (2020-11-30)

Features

• TS: migrate to TypeScript (#76) (947035a)

3.0.2 (2020-09-15)

Bug Fixes

• TS: TypeScript types for onError (#70) (c8272e2)

3.0.1 (2020-09-12)

Bug Fixes

• TS: types for v3 breaking change (#69) (6810c4e)

3.0.0 (2020-09-11)

Bug Fixes

• avoid double-render (#68) (b2f82ce)

BREAKING CHANGES

• This removes the componentStack in the props given to the FallbackComponent and fallbackRender

2.3.2 (2020-09-10)

Bug Fixes

• switch to getDerivedStateFromError to avoid unnecessary rerender (#67) (463c62e), closes #66

2.3.1 (2020-07-23)

Bug Fixes

• FallbackComponent type (#62) (f75eda0), closes #61

2.3.0 (2020-07-20)

Features

• useErrorHandler: add new hook for handling errors (#59) (3c93397)

2.2.3 (2020-06-24)

Bug Fixes

• TS: point package.json types property to including type declarations (#58) (d6ed8db)

2.2.2 (2020-06-05)

Bug Fixes

• compare length of resetKeys when checking if resetKeys has changed (#56) (ab6e19f)

2.2.1 (2020-05-01)

Bug Fixes

• Publish types (#55) (56bf7d7)

2.2.0 (2020-05-01)

Features

• onResetKeysChange: handle when the reset keys change (#52) (dd6022e)
• pass arguments to onReset callback (#51) (c30eda2)

2.1.0 (2020-05-01)

Features

• reset: add onReset and resetKeys props (#50) (4e240df)

2.0.2 (2020-04-30)

Bug Fixes

• fix TS typings as they are now exported as named exports (#47) (b032513)

2.0.1 (2020-04-30)

Bug Fixes

• ensure the fallback props are the correct type (bdcb1f9)

2.0.0 (2020-04-30)

Features

• support resetting the error state (#46) (c38c84b), closes #26 #15 #34

BREAKING CHANGES

• No longer support default FallbackComponent.
• Codebase is no longer written in Flow so flowtypes are no longer available (currently).