1.2.4 • Published 3 years ago

react-err-boundary v1.2.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

react-err-boundry

A straight-forward light weight error boundary for React components

This easy to implement error boundary component isolates errors to the child component that throws them so your entire react app doesn't crash on error.

Features

  • A simple component which catches errors thrown in child component tree, logs the error and displays a fallback UI
  • The Error Boundary catches errors during rendering, in lifecycle methods, and in constructors of the whole tree below them.

Installation

Installation is as simple as running the following command in your project's root directory

npm i --save react-err-boundary

Usage

Usage is very straight-forward! Simply wrap your component in the Error Boundary component to create an error boundary

import ErrorBoundary from 'react-err-boundary';

...

<ErrorBoundary>
  <MyComponent />
</ErrorBoundary>

Props

ErrorBoundary.propTypes = {
  // Children nodes to be rendered
  children: PropTypes.node,
  // UI to be displayed in case of error
  displayError: PropTypes.node,
  // Error handling function
  onError: PropTypes.func,
  // Optional logger
  logger: PropTypes.object,
};

ErrorBoundary.defaultProps = {
  onError: () => {},
};

License

MIT Free Software, Hell Yeah!