Skip to content

Expo plugin for adding @intercom/react-native-intercom using expo config plugins

Notifications You must be signed in to change notification settings

volodymyr-rutskyi/config-plugin-react-native-intercom

 
 

Repository files navigation

Expo Config Plugin react-native-intercom

An Expo config plugin for easily setting up React Native Intercom

Installation

Prerequisites

  • App project using Expo SDK 41+.
  • Installed expo-cli@4.4.4 or later.
  • Installed @intercom/intercom-react-native JavaScript libraries:

With expo install

expo install config-plugin-react-native-intercom

Without expo install

# using yarn
yarn add config-plugin-react-native-intercom

# using npm
npm install config-plugin-react-native-intercom

Open your app.json and update your plugins section (expo install would do it for you):

{
  "plugins": ["config-plugin-react-native-intercom"]
}

Configuration

The plugin needs your intercom api key so that it can communicate with the intercom application.

{
  "plugins": [
    [
      "config-plugin-react-native-intercom",
      {
        "iosApiKey": "<your-api-key>",
        "androidApiKey": "<your-api-key>",
        "appId": "<your-app-id>
      }
    ]
  ]
}

Other configuration options

Add a custom photo usage description
{
  "plugins": [
    [
      "config-plugin-react-native-intercom",
      {
        //...
        "iosPhotoUsageDescription": "Upload to support center"
      }
    ]
  ]
}

Building and running

You can either:

  • use expo prebuild or expo run:android/expo run:ios to update your native projects,
  • use EAS Build to build your development client.

Contributing

Contributions are very welcome! The package uses expo-module-scripts for most tasks. You can find detailed information at this link.

Please make sure to run yarn build/yarn rebuild to update the build directory before pushing. The CI will fail otherwise.

Credits

License

MIT

About

Expo plugin for adding @intercom/react-native-intercom using expo config plugins

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.0%
  • TypeScript 49.0%