In-app feedback and bug reporting tool for React Native
Switch branches/tags
Clone or download

README.md

Instabug for React Native

npm npm npm Twitter Analytics

Upgrading? Check the Upgrade Guide before bumping to a new major version.

Instabug is an in-app feedback and bug reporting tool for mobile apps. With just a simple shake, your users or beta testers can report bugs or send in-app feedback and the SDK will capture an environment snapshot of your user's device including all console logs, server-side network requests and bug reproduction steps compiling all these details in one organised dashboard to help you debug and fix bugs faster.

Instabug also provides you with a reliable crash reporter that automatically captures a detailed report of the running environment, the different threads’ states, the steps to reproduce the crash, and the network request logs. All the data is captured automatically with no need for breadcrumbs, and you can always reply back to your users and they will receive your messages within the app.

For more info, visit Instabug.com.

Installation

  1. Open the terminal and navigate to your React Native Directory. Then run the following command.
npm install instabug-reactnative

or

yarn add instabug-reactnative
  1. Install Ruby. (You can skip this step if you're building for Android only)

  2. Install xcodeproj gem by running the following command. (You can also skip this step if you're building for Android only)

gem install xcodeproj
  1. Link the bridging files in the npm package to the ios project use the following command.
react-native link instabug-reactnative

Using Instabug

  1. To start using Instabug, import it into your index.ios.js and index.android.js file.
import Instabug from 'instabug-reactnative';
  1. Then initialize it in the constructor or componentWillMount. This line will let the Instabug SDK work with the default behavior. The SDK will be invoked when the device is shaken. You can customize this behavior through the APIs (You can skip this step if you are building an Android app only).
Instabug.startWithToken('IOS_APP_TOKEN', [Instabug.invocationEvent.shake]);
  1. Open android/app/src/main/java/[...]/MainApplication.java You should find the getPackages method looks like the following snippet. You just need to add your Android app token (You can skip this step if you are building an iOS app only). You can change the invocation event from here, simply by replacing the "shake" with any of the following "button", "none", "screenshot", or "swipe". You can change the primary color by replacing the "#1D82DC" with any colour of your choice. In the case that you are using the floating button as an invocation event, you can change the floating button edge and the floating button offset using the last two methods, by replacing "left" to "right", and by changing the offset number.
@Override
protected List<ReactPackage> getPackages() {
	return Arrays.<ReactPackage>asList(
	new MainReactPackage(),
	new RNInstabugReactnativePackage.Builder("YOUR_APP_TOKEN", MainApplication.this)
                            .setInvocationEvent("shake")
                            .setPrimaryColor("#1D82DC")
                            .setFloatingEdge("left")
                            .setFloatingButtonOffsetFromTop(250)
                            .build()
}

You can find your app token by selecting the SDK tab from your Instabug dashboard.

Upgrade Guide

Upgrading from 1.x.x

When upgrading from version 1.x.x, please make sure you do the following steps:

  1. Run
npm install instabug-reactnative
  1. Open your Pod file and delete this line pod 'Instabug', '~> 7.0'

  2. Run this command from inside the ios directory inside your root project's directory

pod install
  1. Run this command from your root project's directory. Make sure you have Ruby and xcodeproj gem installed before running this last command. (You can skip installing Ruby if you're building an Android app only)
react-native link instabug-reactnative

Upgrading from 8.0.3 to 8.x

When upgrading from 8.0.3 to 8.x, please make sure you do the following steps:

  1. Unlink the project before upgrading to the new version
react-native unlink instabug-reactnative
  1. Install the new version by running
npm install instabug-reactnative
  1. Link the project by running
react-native link instabug-reactnative

Microphone and Photo Library Usage Description (iOS Only)

Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.

For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:

  • NSMicrophoneUsageDescription
  • NSPhotoLibraryUsageDescription

If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:

  • "<app name> needs access to the microphone to be able to attach voice notes."
  • "<app name> needs access to your photo library for you to be able to attach images."

The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.

Documentation

For more details about the supported APIs and how to use them, check our Documentation.