config-plugin-react-native-intercom
v1.10.1
Published
Config plugin for intercom-react-native package
Maintainers
Readme
Expo Config Plugin @intercom/intercom-react-native
An Expo config plugin for easily setting up React Native Intercom
Installation
Prerequisites
- App project using Expo SDK 41+.
- Installed
[email protected]or later. - Installed
@intercom/intercom-react-nativeJavaScript libraries:
With expo install
expo install config-plugin-react-native-intercomWithout expo install
# using yarn
yarn add config-plugin-react-native-intercom
# using npm
npm install config-plugin-react-native-intercomOpen 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>",
"isPushNotificationsEnabledIOS": "<boolean>"
}
]
]
}Other configuration options
{
"plugins": [
[
"config-plugin-react-native-intercom",
{
//...
"iosPhotoUsageDescription": "Upload to support center"
}
]
]
}Building and running
You can either:
- use
expo prebuildorexpo run:android/expo run:iosto 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
the Expo team
License
MIT
