@shakebugs/react-native-shake-uat v9.0.0

Shake SDK

Requirements

Android API version should be at least 17.

Update minSdkVersion in project level build.gradle

ext {
    buildToolsVersion = "28.0.3"
    minSdkVersion = 17
    compileSdkVersion = 28
    targetSdkVersion = 28
}

Getting started

React native >= 0.60

$ npm install @shakebugs/react-native-shake --save
$ react-native add-shake
$ cd ios && pod install && cd ..

React native <= 0.59

$ npm install @shakebugs/react-native-shake --save
$ react-native link @shakebugs/react-native-shake
$ cd ios && pod install && cd ..

Manual linking

Skip this step if library is linked using autolinking or using react-native link command.

Android

Open settings.gradle and add following lines

include ':@shakebugs_react-native-shake'
project(':@shakebugs_react-native-shake').projectDir = new File(rootProject.projectDir, '../node_modules/@shakebugs/react-native-shake/android')

Add dependency to app level build.gradle

dependencies {
    implementation project(':@shakebugs_react-native-shake')
    implementation fileTree(dir: "libs", include: ["*.jar"])
    implementation "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
    implementation "com.facebook.react:react-native:+"  // From node_modules
}

Update getPackages() method in MainApplication:

@Override protected List<ReactPackage> getPackages() {
    @SuppressWarnings("UnnecessaryLocalVariable")
    List<ReactPackage> packages = new PackageList(this).getPackages();
    // Packages that cannot be autolinked yet can be added manually here, for example:
    // packages.add(new MyReactNativePackage());
    packages.add(new ShakePackage());
    return packages;
 }

iOS

Add Shake.xcodeproj to Libraries in Xcode.

Go to Build Phases, and add libShake.a from the Products folder inside the Library you are importing to Link Binary With Libraries

Initialization

Skip this step if library is initialized using react-native add-shake or react-native link commands.

Android

Add maven repository to your project level build.gradle file

allprojects {
   repositories {
       mavenLocal()
       maven {
           // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
           url("$rootDir/../node_modules/react-native/android")
       }
       maven {
           // Android JSC is installed from npm
           url("$rootDir/../node_modules/jsc-android/dist")
       }

       google()
       jcenter()
       maven { url 'https://www.jitpack.io' }
       maven { url 'https://dl.bintray.com/shake/shake' }
   }
}

Add dependency to your app level build.gradle file

dependencies {
    implementation 'com.shakebugs.android:shake:9.0.+'
}

Update MainApplication.java file

import com.shakebugs.shake.Shake;
import com.shakebugs.shake.ShakeInvocationEvent;

@Override
public void onCreate() {
 super.onCreate();
 SoLoader.init(this, /* native exopackage */ false);
 initializeFlipper(this, getReactNativeHost().getReactInstanceManager());
 Shake.setInvocationEvents(ShakeInvocationEvent.BUTTON);
 Shake.start(this);
}

If you do not have multiDexEnabled, update app level build.gradle

  defaultConfig {
        applicationId "com.shakebugs.react.example"
        minSdkVersion rootProject.ext.minSdkVersion
        targetSdkVersion rootProject.ext.targetSdkVersion
        versionCode 6
        versionName "2.3.2"
        multiDexEnabled true
    }

Add following code into the MainActivity.java

package com.example;

import android.os.Bundle;
import android.view.MotionEvent;

import com.facebook.react.ReactActivity;
import com.shakebugs.react.TouchTracker;

public class MainActivity extends ReactActivity {
    private TouchTracker touchTracker;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        touchTracker = new TouchTracker(getApplicationContext());
    }

    @Override
    public boolean dispatchTouchEvent(MotionEvent ev) {
        touchTracker.handleTouchEvent(ev, this);

        return super.dispatchTouchEvent(ev);
    }

    @Override
    protected String getMainComponentName() {
        return "example";
    }
}

iOS

No initialization needed

Adjust keys

Android

Adjust client id and client secret for your account in AndroidManifest.xml

<meta-data
       android:name="com.shakebugs.APIClientID"
       android:value="your-api-client-id" />
<meta-data
       android:name="com.shakebugs.APIClientSecret"
       android:value="your-api-client-secret" />

iOS

Add client id and client secret for your account in Info.plist

<?xml version="1.0" encoding="utf-8" ?>
<plist version="1.0">
  <dict>
      <key>Shake</key>
        <dict>
          <key>APIClientID</key>
          <string>your-api-client-id</string>
          <key>APIClientSecret</key>
          <string>your-api-client-secret</string>
        </dict>
  </dict>
</plist>

Usage

Import

import Shake, {ShakeInvocationEvent} from '@shakebugs/react-native-shake';

Start shake

Shake.start();

Stop shake

Shake.stop();

Set invocation events

Shake.setInvocationEvents([
    ShakeInvocationEvent.BUTTON,
    ShakeInvocationEvent.SHAKE,
    ShakeInvocationEvent.SCREENSHOT])

Blackbox

Shake.setBlackBoxEnabled(false);
Shake.setBlackBoxEnabled(true);

Quick facts

Shake.setQuickFacts('Sample quick facts');

Attaching files

Attach files with default names

Shake.attachFiles([filePath]);

Attach files with custom names

Shake.attachFilesWithName({
  "file1": filePath1,
  "file2": filePath2
});

Network tracking

import {NetworkTracker} from '@shakebugs/react-native-shake';

NetworkTracker.enable();
NetworkTracker.disable();

Touch tracking

Android

If you initialized SDK using react-native add-shake or react-native link commands, touch tracking is enabled by default.

iOS

Touch tracking is enabled by default