Braze React Native SDK

• Braze User Guide
• Braze Developer Guide

Quickstart

npm install @braze/react-native-sdk
// yarn add @braze/react-native-sdk

Android

// build.gradle
// ...
    dependencies {
        ...
        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.10")
    } 
// ...

<!-- res/values/braze.xml -->
<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">YOU_APP_IDENTIFIER_API_KEY</string>
  <string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_ENDPOINT_OR_CLUSTER</string>
</resources>

<!-- AndroidManifest.xml -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

iOS

cd ios && pod install

// AppDelegate.swift
import BrazeKit
import braze_react_native_sdk

class AppDelegate: UIResponder, UIApplicationDelegate {
  static var braze: Braze? = nil

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil
  ) -> Bool {
    // Setup Braze
    let configuration = Braze.Configuration(
      apiKey: "<BRAZE_API_KEY>",
      endpoint: "<BRAZE_ENDPOINT>"
    )
    // - Enable logging or customize configuration here
    configuration.logger.level = .info
    let braze = BrazeReactBridge.perform(
      #selector(BrazeReactBridge.initBraze(_:)),
      with: configuration
    ).takeUnretainedValue() as! Braze

    AppDelegate.braze = braze

    return true
  }
}

Typescript

import Braze from "@braze/react-native-sdk";

Braze.changeUser("Jane Doe")

See the Braze Developer Guide for advanced integration options.

Version Support

Note

This SDK has been tested with React Native version 0.80.0.

Braze Plugin	React Native	Supports New Architecture?
9.0.0+	>= 0.71	✅
6.0.0+	>= 0.68	✅ (>= 0.70.0)
2.0.0+	>= 0.68	✅
<= 1.41.0	<= 0.71	❌

This SDK additionally inherits the requirements of its underlying Braze native SDKs. Be sure to also adhere to the lists below:

• Android SDK requirements
• Swift SDK requirements

Braze Expo Plugin

If you're using Expo, you can install our plugin to integrate the React Native SDK without any native code. See the Braze Expo Plugin Github for more details.

Running the Sample App

• BrazeProject - Contains the BrazeProject sample app with integration examples for the React Native bridge. This sample app integrates the iOS bridge via manual linking, and the iOS SDK via Cocoapods. It can also optionally integrate the iOS bridge using Cocoapods via a local Podspec.

The following commands apply to both sample projects and use the BrazeProject directory as an example.

cd BrazeProject/
yarn install

# In a separate tab:
cd BrazeProject/
npx react-native start

iOS

Our sample app integrates the native Braze iOS SDK through Cocoapods.

From the BrazeProject directory:

sudo gem install cocoapods
cd ios/
pod install # If you are using the New Architecture, you need to run `RCT_NEW_ARCH_ENABLED=1 pod install` instead.
cd ../
npx react-native run-ios

Android

From the BrazeProject directory:

npx react-native run-android

Style

• Generally we try to mimic the Braze Web SDK's Javascript interface where appropriate.
• We use eslint as our linter. From the root directory, run npm run lint to list errors or npm run lint-fix to automatically fix errors. To override the rules in the standard-react config, add "rules" in .eslintrc.json.

Testing

• We use jest for testing the React Native SDK.
• Run the tests and code coverage report using npm test

Contact

If you have questions, please contact [email protected].