@honeybadger-io/react

Honeybadger React.js Integration

React.js Integration for Honeybadger.io

Documentation and Support

For comprehensive documentation and support, check out our documentation site.

The documentation includes a detailed React integration guide

Project Goals

The goal is to provide an idiomatic, simple integration of Honeybadger's exception monitoring service with React.js applications.

Project Status

This version is considered suitable for preview.

Limitations

Honeybadger-react hooks in to the error handler in React. This means we only notify Honeybadger of React context for errors that React handles. Some errors inside React code may propagate to the window onerror handler instead.

In those cases, Honeybadger JavaScript's default error notifier is invoked, which will contain a stack trace but none of the React variables.

Key Assumptions

This project is built using create-react-library with rollup and generates artifacts in commonjs, esm and umd formats. It's possible your own build environment may be just different enough to require some adjustments. If you find that our artifacts don't quite meet your needs, please file an issue on GitHub.

Example apps

There are minimal implementations of a honeybadger-react integration in the ./examples folder. If you want to contribute a patch to @honeybadger-io/react, it can be useful to have the demo apps running.

To run the example app using React v19, issue these commands from your shell:

cd examples/react-19
npm install
REACT_APP_HONEYBADGER_API_KEY=b425b636 npm run start

This will start the demo app with hot reload enabled.

Development

# install dependencies
npm install

# build for production
npm run build

# run unit tests
npm test

# automatically continuously rebuild the dist/ artifacts with hot reload when developing
npm run start

License

This package is MIT licensed. See the MIT-LICENSE file in this folder for details.