@braze/react-native-sdk

Braze React Native SDK

Effective marketing automation is an essential part of successfully scaling and managing your business. Braze empowers you to build better customer relationships through a seamless, multi-channel approach that addresses all aspects of the user life cycle Braze helps you engage your users on an ongoing basis.

• Braze React Native npm package
• Braze User Guide
• Initial React Native SDK Setup

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

Changelog

16.0.0

Breaking

• Updates the native Android SDK version bindings from Braze Android SDK 36.0.0 to 37.0.0.
• Updates the native Swift SDK version bindings from Braze Swift SDK 12.0.0 to 13.0.0.
  • The "sdkAuthenticationError" event will now trigger for both "Required" and "Optional" authentication errors.

Added

• Updates the Braze sample app to use React Native version 0.80.0. This change validates SDK compatibility with the latest version of React Native.
• Adds ability to unset user first name, last name, phone number, email, gender, language, home city, and country by setting these values to null.

Fixed

• Fixes the iOS implementation of setDateOfBirth to correctly report dates using the Gregorian calendar instead of the user's device calendar.
  • Previously, the SDK would re-format the input date components with the device's calendar settings if they were non-Gregorian.