Package Exports

onesignal-expo-plugin
onesignal-expo-plugin/app.plugin.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (onesignal-expo-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Welcome to onesignal-expo-plugin 👋

The OneSignal Expo plugin allows you to use OneSignal without leaving the managed workflow. Developed in collaboration with SweetGreen.

🏠 Homepage
🖤 npm

🚧 In Beta 🚧

Overview

This plugin is an Expo Config Plugin. It extends the Expo config to allow customizing the prebuild phase of managed workflow builds (no need to eject to a bare workflow). For the purposes of OneSignal integration, the plugin facilitates automatically generating/configuring the necessary native code files needed to get the OneSignal React-Native SDK to work. You can think of adding a plugin as adding custom native code.

Supported environments:

The Expo run commands (expo run:[android|ios])
Custom clients
EAS Build

Install

expo install onesignal-expo-plugin
yarn add react-native-onesignal

Configuration in app.json / app.config.js

Plugin

Add the plugin to the plugin array:

app.json

{
  "plugins": [
    [
      "onesignal-expo-plugin",
      {
        "mode": "development",
      }
    ]
  ]
}

app.config.js

export default {
  ...
  plugins: [
    [
      "onesignal-expo-plugin",
      {
        mode: "development",
      }
    ]
  ]
};

Plugin Prop

You can pass props to the plugin config object to configure:

Plugin Prop
`mode`	required	Used to configure APNs environment entitlement. `"development"` or `"production"`
`devTeam`	optional	Used to configure Apple Team ID. You can find your Apple Team ID by running `expo credentials:manager` e.g: `"91SW8A37CR"`
`iPhoneDeploymentTarget`	optional	Target `IPHONEOS_DEPLOYMENT_TARGET` value to be used when adding the iOS NSE. A deployment target is nothing more than the minimum version of the operating system the application can run on. This value should match the value in your Podfile e.g: `"12.0"`.

OneSignal App ID

Add your OneSignal App ID to your Expo constants via the extra param:

Example:

{
  "extra": {
    "oneSignalAppId": "<YOUR APP ID HERE>"
  }
}

You can then access the value to pass to the setAppId function:

import OneSignal from 'react-native-onesignal';
import Constants from "expo-constants";
OneSignal.setAppId(Constants.manifest.extra.oneSignalAppId);

Alternatively, pass the app ID directly to the function:

OneSignal.setAppId("YOUR-ONESIGNAL-APP-ID");

Run

$ expo prebuild --clean

# Build your native iOS project
$ expo run:ios

# Build your native Android project
$ expo run:android

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

JSPM

onesignal-expo-plugin