helpshift-react-native
** UNOFFICIAL, OPEN SOURCE **
This package is experimental and not officially supported by Helpshift
Getting started
$ yarn add helpshift-react-native
Mostly automatic installation
$ react-native link helpshift-react-native
Manual installation
iOS
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜helpshift-react-native
and addRNHelpshift.xcodeproj
- In XCode, in the project navigator, select your project. Add
libRNHelpshift.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Run your project (
Cmd+R
)<
Android
- Open up
android/app/src/main/java/[...]/MainActivity.java
- Add
import com.helpshift.reactlibrary.RNHelpshiftPackage;
to the imports at the top of the file - Add
new RNHelpshiftPackage()
to the list returned by thegetPackages()
method
- Append the following lines to
android/settings.gradle
:include ':helpshift-react-native' project(':helpshift-react-native').projectDir = new File(rootProject.projectDir, '../node_modules/helpshift-react-native/android')
- Insert the following lines inside the dependencies block in
android/app/build.gradle
:compile project(':helpshift-react-native')
API Usage
Initialize
;; const apiKey = 'HELPSHIFT_API_KEY';const domain = 'HELPSHIFT_DOMAIN';const iosAppId = 'HELPSHIFT_IOS_APP_ID';const androidAppId = 'HELPSHIFT_ANDROID_APP_ID'; const appId = PlatformHelpshift;
Login
const user = identifier: 'YOUR_UNIQUE_ID' // required if no email email: 'jane@doe.com' // required if no identifier name: 'Jane Doe' // optional authToken: 'XXXXXXXX=' // required if User Identity Verification is enabledHelpshift
Logout
Helpshift
Show Conversation
Helpshift
Show FAQs
Helpshift
Documentation)
With Custom Issue Fields (CIFs) (const cifs = // 'key': ['type', 'value'] 'number_of_rides': 'n' '12' 'street': 'sl' '343 sansome' 'new_customer': 'b' 'true' // Where data types are mapped like so:// singleline => sl// multiline => ml// number => n// date => dt// dropdown => dd// checkbox => b Helpshift// ORHelpshift