Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

zendesk/react-native-sunshine-conversations

Repository files navigation

⚠️ NOTICE: The repo is no longer maintained.

react-native-smooch

React Native wrapper for Smooch.io. Based off of smooch-cordova

This React Native module was built and tested with version 0.57.7 of React Native. Since React Native is not mature yet, there might be some breaking changes which will break our module. Therefore, if you find a problem, please open an issue.

At the moment, this wrapper only covers the most commonly used features of the Smooch SDK. We encourage you to add to this wrapper or make any feature requests you need. Pull requests most definitely welcome!

Please contact Smooch for any questions.

Installing Smooch on React Native

First, make sure you've signed up for Smooch

If you don't already have a React Native application setup, follow the instructions here to create one.

Next, grab this React Native module with npm install react-native-smooch

Link it! react-native link react-native-smooch

iOS

  • With CococaPods, you can add the react-native-smooch Pod in your Podfile like so:
pod 'react-native-smooch',
    :path => '../node_modules/react-native-smooch'
  • You must also have your React dependencies defined in your Podfile as described here, for example:
target 'myapp' do

   pod 'react-native-smooch',
       :path => '../node_modules/react-native-smooch'

   pod 'React',
       :subspecs => [
           'Core',
           'RCTImage',
           'RCTNetwork',
           'RCTPushNotification',
           'RCTText',
       ], :path => '../node_modules/react-native'

   pod 'yoga',
       path: '../node_modules/react-native/ReactCommon/yoga/yoga.podspec'

end
  • Install pods by running pod install.

  • Without CocoaPods, you can add Smooch by navigating to your React Native project's ios directory and following the manual steps here.

  • Open your project's .xcworkspace file in XCode and initialize Smooch with your app id inside of applicationDidFinishLaunchingWithOptions.

#import <Smooch/Smooch.h>

...

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Initialize Smooch - these instructions are also available on [app.smooch.io](https://app.smooch.io)
    [Smooch initWithSettings:[SKTSettings settingsWithAppId:@"YOUR_APP_ID"] completionHandler:^(NSError * _Nullable error, NSDictionary * _Nullable userInfo) {
        // Your code after init is complete
    }];
}

You're now ready to start interacting with Smooch in your React Native app.

Android

You can easily add a binding to the Smooch Android SDK in your React Native application by following the instructions below.

  • Add the ReactNativeSmoochPackage to the list of packages in your ReactApplication
@Override
protected List<ReactPackage> getPackages() {
    return Arrays.<ReactPackage>asList(
            new MainReactPackage(),
            new ReactNativeSmoochPackage()
    );
}
  • Add Smooch.init to the onCreate method of your Application class.
import io.smooch.core.Settings;
import io.smooch.core.Smooch;
import io.smooch.core.SmoochCallback;
import com.facebook.soloader.SoLoader;

public class MainApplication extends Application implements ReactApplication {
    ...
    @Override
    public void onCreate() {
        super.onCreate();
        SoLoader.init(this, /* native exopackage */ false);
        Smooch.init(this, new Settings("YOUR_APP_ID"), new SmoochCallback() {
            @Override
            public void run(Response response) {
                // Your code after init is complete
            }
        });
    }
    ...
}

You're now ready to start interacting with Smooch in your React Native app.

Using Smooch in your React Native App

Require the module

const Smooch = require('react-native-smooch');

Show the conversation screen

Smooch.show();

Set the user's first name

Smooch.setFirstName("Kurt");

Set the user's last name

Smooch.setLastName("Osiander");

Set the user's email address

Smooch.setEmail("[email protected]");

Set the user's sign up date

Smooch.setSignedUpAt((new Date).getTime());

Associate key/value pairs with the user

Smooch.setUserProperties({"whenDidYouFsckUp": "aLongTimeAgo"});