Framework integrations

If a framework you use is not yet supported, feel free to let us know, or write a custom integration for it yourself (we'll help you get it out there!).

React ^16.0.0

yarn add @flareapp/react
npm install @flareapp/react

React's error handling works similarly to how it works in vanilla JavaScript. You can wrap parts of your component tree in error boundary components, which can stop the error from bubbling further up the tree and crashing your entire application.

In your app's root file (/src/App.js for creact-react-app), wrap your entire component tree in the provided FlareErrorBoundary component:

import * as React from 'react';
import { render } from 'react-dom';
import { flare } from "@flareapp/js";
import { FlareErrorBoundary } from '@flareapp/react';

flare.light('your-project-key');

render(
    <FlareErrorBoundary>
        <Root />
    </FlareErrorBoundary>,
    document.getElementById('app')
)

Note: If you bundle React for development, you will see that many errors are reported twice. This is expected behaviour and will not occur in a production bundle (read more: https://github.com/facebook/react/issues/10474).

You should use a combination of Flare's and your own error boundaries, continue reading to find out how to report errors to Flare in your own error boundary components.

Reporting React errors in your own error boundaries

If you have your own error boundary components, e.g. for displaying a fallback component when something goes wrong, the error won't bubble up to Flare's error boundary and the error won't be reported to the Flare app automatically.

If you still want to know about these errors, you manually report it to Flare:

import { flare } from "@flareapp/js";
import { reportReactError } from "@flareapp/react";

export default class ErrorBoundary extends React.Component {
    componentDidCatch(error) {
        flare.report(error);
    }
}

Vue 2 / Vue 3

yarn add @flareapp/vue
npm install @flareapp/vue

Register the extension as a Vue plugin, you can do this in the same file where you create and mount your Vue instance:

Vue 3

import { flare } from "@flareapp/js";
import { flareVue } from "@flareapp/vue";

flare.light('your-project-key');

const app = createApp({ /* … */ });
app.use(flareVue);
app.mount('#app');

Vue 2

import { flare } from "@flareapp/js";
import { flareVue } from "@flareapp/vue";
import Vue from 'vue';

flare.light('your-project-key');

Vue.use(flareVue);

const app = new Vue({ el: "#app" });