# 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` | `react-native-branch`   | `@config-plugins/react-native-branch` |
|--------|-------------------------|---------------------------------------|
| 56.0.0 | 6.10.0                  | 13.0.0                                |
| 55.0.0 | 6.9.0                   | 12.0.0                                |
| 54.0.0 | 6.8.0                   | 11.0.0                                |
| 53.0.0 | 6.6.0                   | 10.0.0                                |
| 52.0.0 | 6.4.0                   | 9.0.0                                 |
| 51.0.0 | 6.2.1                 3 | 8.0.0                                 |
| 50.0.0 | 6.0.0                   | 7.0.0                                 |
| 49.0.0 | 5.9.0                   | 6.0.0                                 |
| 48.0.0 | 5.7.0                   | 5.0.0                                 |

## Expo installation

> This package cannot be used in the "Expo Go" app because [it requires custom native code](https://docs.expo.io/workflow/customizing/).

First install the package with yarn, npm, or [`npx expo install`](https://docs.expo.io/workflow/expo-cli/#expo-install).

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

After installing this npm package, add the [config plugin](https://docs.expo.io/guides/config-plugins/) to the [`plugins`](https://docs.expo.io/versions/latest/config/app/#plugins) array of your `app.json` or `app.config.js`:

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

Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.io/workflow/customizing/) 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

```json
{
  "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"]
      }
    ]
  ]
}
```