config-plugins/react-native-branch

Config plugin to auto-configure react-native-branch when the native code is generated (npx expo prebuild).

Versioning

Ensure you use versions that work together!

Expo installation

This package cannot be used in the "Expo Go" app because it requires custom native code.

First install the package with yarn, npm, or npx expo install.

npx expo install react-native-branch @config-plugins/react-native-branch

After installing this npm package, add the config plugin to the plugins array of your app.json or app.config.js:

{
  "plugins": ["@config-plugins/react-native-branch"]
}

Next, rebuild your app as described in the "Adding custom native code" guide.

API

The plugin provides props for extra customization. Every time you change the props or plugins, you'll need to rebuild (and prebuild) the native app. If no extra properties are added, defaults will be used.

• apiKey (string): Branch API key. Optional.
• iosAppDomain (string): App Domain for iOS. Optional.
• iosUniversalLinkDomains (string[]): Universal link domains for iOS. Optional.

Example

{
  "plugins": [
    [
      "@config-plugins/react-native-branch",
      {
        "apiKey": "key_live_f9f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8f8",
        "iosAppDomain": "awesome-alternate.app.link",
        "iosUniversalLinkDomains": ["awesome.app.link", "awesome-alternate.app.link", "awesome.test.app.link"]
      }
    ]
  ]
}