README

sc-react-native-branch

Sevencooks Branch SDK for React Native

Installation

yarn add @sevencooks/react-native-branch

Linking

>= 0.60

Autolinking will just do the job.

< 0.60

Mostly automatic

react-native link @sevencooks/react-native-branch

Setup

Android

`android/app/src/main/.../MainApplication.java`

Add import com.sevencooks.rnbranch.*

Add RNBranchModule.initBranch(this) in your onCreate method.

@Override
public void onCreate() {
  super.onCreate();
  // Add this
  RNBranchModule.initBranch(this);
}

iOS

Add the upstream Branch iOS SDK pod 'Branch', :modular_headers => true to Podfile
Add the SCBranch.swift file from the ios folder of this repo to your app
Create a Swift bridging header when asked add the content of the bridging header of the iOS example app

// AppDelegate.m
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // Add this
  [[[SCBranch alloc] init] configureLaunchOptions:launchOptions];

  // ... other code
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
  // Add this if you want to support legacy URL schemes
  [[[SCBranch alloc] init] application:app url:url options:options];
  return YES;
}

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray * _Nullable))restorationHandler {
  // Add this to support universal links on resume
  return [[[SCBranch alloc] init] continueUserActivity:userActivity];
}

@end

Usage

import Branch from '@sevencooks/react-native-branch'

// Anywhere in your most top component e.g. App.js
React.useEffect(() => Branch.initSession(), [])

// Subscribe to events
Branch.subscribe(({ params, error }) => {
  console.log({ params, error })
})

// Get latest deep link params
const params = await Branch.getLatestReferringParams()

// create a new shortLink
const url = await Branch.generateShortUrl(
  branchUniversalOpjectData,
  linkProperties,
)
// See https://help.branch.io/developers-hub/docs/native-sdks-overview for further instructions.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Usage no npm install needed!