@appsignal/react

• AppSignal.com website
• Documentation
• Support

The @appsignal/javascript integration for React v15+.

See also the mono repo README for more information.

Installation

Add the @appsignal/react and @appsignal/javascript packages to your package.json. Then, run yarn install/npm install.

You can also add these packages to your package.json on the command line:

yarn add @appsignal/javascript @appsignal/react
npm install --save @appsignal/javascript @appsignal/react

Usage

Error Boundary

If you are using React v16 or higher, you can use the ErrorBoundary component to catch errors from anywhere in the child component tree.

import React from "react"
import ReactDOM from "react-dom"
import Appsignal from "@appsignal/javascript"
import { ErrorBoundary } from "@appsignal/react"

const appsignal = new Appsignal({
  key: "YOUR FRONTEND API KEY"
})

const FallbackComponent = () => (
  <div>Uh oh! There was an error :(</div>
)

const App = () => (
  <ErrorBoundary instance={appsignal} fallback={(error) => <FallbackComponent />}>
    { /** Child components here **/}
  </ErrorBoundary>
)

ReactDOM.render(<App />, document.getElementById("root"))

Legacy Boundary

⚠️ WARNING: The API that this component uses is unstable at this point in React's development. We offer this component as a means to support those running React v15, but do not guarantee its reliablity. You are encouraged to use the ErrorBoundary whenever possible.

The LegacyBoundary works in almost exactly the same way as the ErrorBoundary:

import React from "react"
import ReactDOM from "react-dom"
import Appsignal from "@appsignal/javascript"
import { LegacyBoundary } from "@appsignal/react"

const appsignal = new Appsignal({ 
  key: "YOUR FRONTEND API KEY"
})

const FallbackComponent = () => (
  <div>Uh oh! There was an error :(</div>
)

const App = () => (
  <LegacyBoundary instance={appsignal} fallback={(error) => <FallbackComponent />}>
    { /** Child components here **/}
  </LegacyBoundary>
)

ReactDOM.render(<App />, document.getElementById("root"))

Development

Installation

Make sure mono is installed and bootstrapped, see the project README's development section for more information.

You can then run the following to start the compiler in watch mode. This automatically compiles both the ES Module and CommonJS variants:

yarn build:watch

You can also build the library without watching the directory:

yarn build        # build both CJS and ESM
yarn build:cjs    # just CJS
yarn build:esm    # just ESM

Testing

The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

yarn test

Versioning

This repo uses Semantic Versioning (often referred to as semver). Each package in the repository is versioned independently from one another.

@TODO: define how this works once we know more about releasing

Contributing

Thinking of contributing to this repo? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.