Skip to content

Latest commit

 

History

History
208 lines (153 loc) · 7.59 KB

rnn-ios.md

File metadata and controls

208 lines (153 loc) · 7.59 KB
Raw

React Native iOS using React Native Navigation

Note

Expo SDK 41-49 using React Native Navigation 6+ is supported. See dedicated Expo integration instructions.

Important

We support a codeless solution for React Native 0.6-0.74 using react-native-navigation 6+.

Important

Requirements:

  • Deployment target of iOS 11 or higher
  • Swift Compatibility 5.7 or higher
  • Xcode 14 or higher

Step 1. Install the Pendo SDK

  1. In the root folder of your project, add Pendo using one of your package managers:

    #example with npm
npm install --save rn-pendo-sdk

#example with yarn
yarn add rn-pendo-sdk

  2. In the iOS folder, run the following command:

    pod install

  3. Modify Javascript minification

    When bundling for production, React Native minifies class and function names to reduce the size of the bundle. This means that there is no access to the original component names that are used for the codeless solution.

    In the application metro.config.js, add the following statements in the transformer:

    module.exports = {
    transformer: {
    // ...
    minifierConfig: {
        keep_classnames: true, // Preserve class names
        keep_fnames: true, // Preserve function names
        mangle: {
            keep_classnames: true, // Preserve class names
            keep_fnames: true, // Preserve function names
        }
    }
    }
}

Step 2. Pendo SDK integration

Note

The API Key can be found in your Pendo Subscription Settings in App Details.

  1. In the application main file (App.js/.ts/.tsx), add the following code:

    import { PendoSDK, NavigationLibraryType } from 'rn-pendo-sdk';
import { Navigation } from "react-native-navigation";

function initPendo() {
    const navigationOptions = {library: NavigationLibraryType.ReactNativeNavigation, navigation: Navigation};
    const pendoKey = 'YOUR_API_KEY_HERE';
    //note the following API will only setup initial configuration, to start collect analytics use startSession
    PendoSDK.setup(pendoKey, navigationOptions);
}
initPendo();

  2. Initialize Pendo where your visitor is being identified (e.g. login, register, etc.).

    const visitorId = 'VISITOR-UNIQUE-ID';
const accountId = 'ACCOUNT-UNIQUE-ID';
const visitorData = {'Age': '25', 'Country': 'USA'};
const accountData = {'Tier': '1', 'Size': 'Enterprise'};

PendoSDK.startSession(visitorId, accountId, visitorData, accountData);

    Notes:
    visitorId: a user identifier (e.g. John Smith)
    visitorData: the user metadata (e.g. email, phone, country, etc.)
    accountId: an affiliation of the user to a specific company or group (e.g. Acme inc.)
    accountData: the account metadata (e.g. tier, level, ARR, etc.)

Tip

To begin a session for an anonymous visitor, pass null or an empty string '' as the visitor id. You can call the startSession API more than once and transition from an anonymous session to an identified session (or even switch between multiple identified sessions).

Step 3. Mobile device connectivity for tagging and testing

Note

The Scheme ID can be found in your Pendo Subscription Settings in App Details.

These steps enable page tagging and guide testing capabilities.

  1. Add Pendo URL scheme to info.plist file:

    Under App Target > Info > URL Types, create a new URL by clicking the + button.
    Set Identifier to pendo-pairing or any name of your choosing.
    Set URL Scheme to YOUR_SCHEME_ID.

    Mobile Tagging

  2. To enable pairing from the device:

    a. If using AppDelegate, add or modify the openURL function:

    Swift Instructions - Click to expand or collapse 
    import Pendo

...

func application(_ app: UIApplication,open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if url.scheme?.range(of: "pendo") != nil {
        PendoManager.shared().initWith(url)
        return true
    }
    // your code here...
    return true
}
    Objective-C Instructions - Click to expand or collapse 
    @import Pendo;

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
        if ([[url scheme] containsString:@"pendo"]) {
            [[PendoManager sharedManager] initWithUrl:url];
            return YES;
        }
        //  your code here ...
        return YES;
}

    b. If using SceneDelegate, add or modify the openURLContexts function:

    Swift Instructions - Click to expand or collapse 
    import Pendo

...

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    if let url = URLContexts.first?.url, url.scheme?.range(of: "pendo") != nil {
        PendoManager.shared().initWith(url)
    }
}
    Objective-C Instructions - Click to expand or collapse 
    - (void)scene:(UIScene *)scene openURLContexts:(nonnull NSSet<UIOpenURLContext *> *)URLContexts {
    NSURL *url = [[URLContexts allObjects] firstObject].URL;
    if ([[url scheme] containsString:@"pendo"]) {
        [[PendoManager sharedManager] initWithUrl:url];
    }
    //  your code here ...
}

Step 4. Verify installation

  1. Test using Xcode:
    Run the app while attached to Xcode.
    Review the Xcode console and look for the following message:
    Pendo Mobile SDK was successfully integrated and connected to the server.
  2. In the Pendo UI, go to Settings>Subscription Settings.
  3. Select the Applications tab and then your application.
  4. Select the Install Settings tab and follow the instructions under Verify Your Installation to ensure you have successfully integrated the Pendo SDK.
  5. Confirm that you can see your app as Integrated under subscription settings.

Developer documentation

  • API documentation available here.
  • Sample app with Pendo SDK integrated available here..

Troubleshooting