Mobile: How To Integrate the WalkMe Mobile Android SDK with React Native

Last Updated September 14, 2022

Brief Overview

The Android WalkMe Mobile SDK supports integration with all web-view based hybrid apps. WalkMe provides its logic and user interface at the native level, so there's no risk of performance issues or need for code changes in the host app.

This article explains how to integrate the Android WalkMe Mobile SDK with a hybrid app.

Automatic Installation

npm install react-native-walkme-sdk --save

Manual Installation

Open up android/app/src/main/java/[...]/MainActivity.java
1. Add import com.walkme.RNWalkMeSdkPackage; to the imports at the top of the file
2. Add new RNWalkMeSdkPackage() to the list returned by the getPackages() method
Append the following lines to android/settings.gradle

include ':react-native-walkme-sdk'

project(':react-native-walkme-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-walkme-sdk/android')
Insert the following lines inside the dependencies block in android/app/build.gradle :

compile project(':react-native-walkme-sdk')

Complete the integration by entering Power Mode in the app:

Launch the app with WalkMe SDK integrated and press and hold 5 fingers on the screen for 5 seconds until the login popup displays. This is the default setting and can be configured at any time in the console.

Log in to Power Mode with your mobile console credentials to complete the sync.

Usage

import RNWalkmeSdk from 'react-native-walkme-sdk'; 
... 
RNWalkmeSdk.start(key, secret);

Verify the integration by looking for this line in your logs: ABBI SDK

There you should find the current version of the SDK and the app ID you are using.

Was this article helpful?

Yes No

Yes

Thanks for your feedback!