Neptune: Planet or Myth?

    This package has been deprecated

    Author message:

    All projects should upgrade to our universal JS notifier: "@bugsnag/js" and the accompanying plugins, e.g. "@bugsnag/plugin-react". See https://github.com/bugsnag/bugsnag-js/blob/master/UPGRADING.md for more details.

    bugsnag-react

    1.1.1 • Public • Published

    Bugsnag: React

    Documentation Build status NPM

    NPM

    A bugsnag-js plugin for React. Learn more about error reporting for React applications with Bugsnag.

    This package enables you to integrate Bugsnag's error reporting with React's error boundaries. It creates and configures an <ErrorBoundary/> component which will capture and report unhandled errors in your component tree. You either use the <ErrorBoundary/> directly, or extend it to provide some fallback UI for your users.

    Reported errors will contain useful debugging info from Reacts's internals such as the component name where the error originated, and the component stack.

    Installation

    You can opt to install the package from npm, using the instructions below. Alternatively you can load the plugin from our CDN via a <script/> tag.

    CDN

    <script src="//d2wy8f7a9ursnm.cloudfront.net/v4/bugsnag.min.js"></script>
    <script src="//d2wy8f7a9ursnm.cloudfront.net/bugsnag-plugins/v1/bugsnag-react.min.js"></script>

    npm

    npm i --save bugsnag-js bugsnag-react
    # or 
    yarn add bugsnag-js bugsnag-react

    Usage

    Depending on how your application is structured, usage differs slightly:

    Inline script tag

    The script tag creates a global function called bugsnag__react which needs to be passed a reference to the React object. Ensure that React is defined before calling this function.

    <script>
      window.bugsnagClient = bugsnag('API_KEY')
    </script> 
    <script>
      // in your react app…
      var ErrorBoundary = bugsnagClient.use(bugsnag__react(React))
      ReactDOM.render(
        <ErrorBoundary>
          <YourApp />
        </ErrorBoundary>,
        document.getElementById('app')
      )
    </script> 

    See the example for more info.

    Bundled

    // initialize bugsnag ASAP, before other imports
    import bugsnag from 'bugsnag-js'
    const bugsnagClient = bugsnag('API_KEY')
     
    import ReactDOM from 'react-dom'
    import React from 'react'
    import createPlugin from 'bugsnag-react'
     
    // wrap your entire app tree in the ErrorBoundary provided
    const ErrorBoundary = bugsnagClient.use(createPlugin(React))
    ReactDOM.render(
      <ErrorBoundary>
        <YourApp />
      </ErrorBoundary>,
      document.getElementById('app')
    )

    Support

    License

    The Bugsnag JS library and official plugins are free software released under the MIT License. See LICENSE.txt for details.

    Keywords

    none

    Install

    npm i bugsnag-react

    DownloadsWeekly Downloads

    7,978

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    35.2 kB

    Total Files

    19

    Last publish

    Collaborators

    • bengourley
    • kattrali
    • snmaynard