Expo

Documentation

Branch

Expo includes alpha support for Branch attribution services on iOS.
Note: This API only works with standalone iOS builds created with expo build:ios.
Android Support: This module is currently not supported on standalone or ExpoKit Android builds. If you'd like to use Branch in your Android app, we recommend that you use the bare workflow and install the react-native-branch module separately. If you previously used Branch in a managed Expo Android app and would like to continue using it as before, you can build your app locally using an older version of turtle-cli or expokit. More details in this blog post.

The Branch SDK currently lives under Expo's DangerZone namespace because it's in a place where it might change significantly. You can import it like this:
import { DangerZone } from 'expo';
let { Branch } = DangerZone;

  • Add the Branch Key to your app.json in the section android.config.branch.apiKey and ios.config.branch.apiKey. You can find your key on this page of the Branch Dashboard.
  • Add a linking scheme to your app.json in the scheme section if you don't already have one.

Branch can track universal links from domains you associate with your app. Note: Expo won't forward these to your JS via the normal Linking API.
  • Enable associated domains on Apple's Developer Portal for your app id. To do so go in the App IDs section and click on your app id. Select Edit, check the Associated Domains checkbox and click Done.
  • Enable Universal Links in the Link Settings section of the Branch Dashboard and fill in your Bundle Identifier and Apple App Prefix.
  • Add an associated domain to support universal links to your app.json in the ios.associatedDomains section. This should be in the form of applinks:<link-domain> where link-domain can be found in the Link Domain section of the Link Settings page on the Branch Dashboard.

We pull in the API from react-native-branch, so the documentation there is the best resource to follow. Make sure you import Branch using the above instructions (from Expo.DangerZone.Branch).

Listen for links:
Expo.DangerZone.Branch.subscribe((bundle) => {
  if (bundle && bundle.params && !bundle.error) {
    // `bundle.params` contains all the info about the link.
  }
});
Open a share dialog:
class ArticleScreen extends Component {
  componentDidMount() {
    this.createBranchUniversalObject();
  }

  async createBranchUniversalObject() {
    const { article } = this.props;

    this._branchUniversalObject = await Expo.DangerZone.Branch.createBranchUniversalObject(
      `article_${article.id}`,
      {
        title: article.title,
        contentImageUrl: article.thumbnail,
        contentDescription: article.description,
        // This metadata can be used to easily navigate back to this screen
        // when implementing deep linking with `Branch.subscribe`.
        metadata: {
          screen: 'articleScreen',
          params: JSON.stringify({ articleId: article.id }),
        },
      }
    );
  }

  onShareLinkPress = async () => {
    const shareOptions = {
      messageHeader: this.props.article.title,
      messageBody: `Checkout my new article!`,
    };
    await this._branchUniversalObject.showShareSheet(shareOptions);
  };
}