@rudderstack/rudder-sdk-react-native
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.0 • Public • Published

    What is RudderStack?

    RudderStack is a customer data pipeline tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse.

    More information on RudderStack can be found here.

    RudderStack React Native SDK

    The RudderStack React Native SDK allows you to track event data from your app. It can be easily integrated into your React Native application. After integrating this SDK, you will also send the event data to your preferred analytics destination/s, such as Google Analytics, Amplitude, and more.

    Getting Started with React Native SDK

    1. Add the SDK to your React Native application with the following command:
    yarn add @rudderstack/rudder-sdk-react-native
    
    1. For Android: Make sure you have added mavenCentral() as a repository in your project level build.gradle file, as shown below:
    buildscript {
        repositories {
            mavenCentral()
        }
    }
    allprojects {
        repositories {
            mavenCentral()
        }
    }
    
    1. For iOS: Navigate to the ios folder of your application and install all the dependencies with:
    pod install
    

    Import RudderClient

    Add the below line to import the rudderClient.

    import rudderClient, { RUDDER_LOG_LEVEL } from '@rudderstack/rudder-sdk-react-native';
    

    Initialize RudderClient

    Add the following code in your application:

    const config = {
      dataPlaneUrl: <DATA_PLANE_URL>,
      trackAppLifecycleEvents: true,
      logLevel: RUDDER_LOG_LEVEL.DEBUG
    };
    await rudderClient.setup(<WRITE_KEY>, config);
    

    Send Events

    rudderClient.track("simple_track_event", {
      "key1":"val1",
      "key2":{
        "child_key1":"child_val1"
      }
    });
    

    Device Tokens

    You can use the putDeviceToken method to pass your Android and iOS device tokens.

    putDeviceToken accepts two string arguments :

    • androidToken : Your Android device token
    • iOSToken : Your iOS device token

    An example usage is as shown below:

    rudderClient.putDeviceToken("<Your Android device token>", "<Your iOS device token>");
    

    AdvertisingId

    You can use the setAdvertisingId method to pass your Android and iOS AAID and IDFA respectively. setAdvertisingId accepts two string arguments :

    • androidId : Your Android advertisingId (AAID)
    • iOSId : Your iOS advertisingId (IDFA)

    Example Usage:

    rudderClient.setAdvertisingId(AAID, IDFA);
    

    AnonymousId

    You can use the setAnonymousId method to pass your anonymousId and the SDK will use that instead of the deviceId. setAnonymousId accepts one string argument:

    • id : Your anonymousId

    Example Usage:

    rudderClient.setAnonymousId(ANONYMOUS_ID);
    

    For more details, check out our documentation.

    Contact Us

    If you come across any issues while configuring or using RudderStack React Native SDK, please feel free to start a conversation on our Slack channel. We will be happy to help you.

    Install

    npm i @rudderstack/rudder-sdk-react-native

    DownloadsWeekly Downloads

    4,391

    Version

    1.6.0

    License

    MIT

    Unpacked Size

    209 kB

    Total Files

    38

    Last publish

    Collaborators

    • rudderstack