Ionic Native Setup
In order to use the Ionic Native plugins, there's just a few quick steps.
First, log into the Ionic Hub, then navigate to the Native Plugins Keys page.
Assign to App, then
New App. Enter a name, then click
Hover over a Native Plugin Key, then click to copy it to your clipboard:
Next, open up a terminal on your computer.
Ensure that you have the latest Ionic CLI installed:
Next, install the Ionic Enterprise Cordova CLI (even if you're using Capacitor). Ionic Native plugins use scoped packages, which the regular Cordova CLI does not support. All Cordova functionality will still work as expected.
The Ionic Enterprise Cordova CLI should be installed on each developer's machine. This is also true for any development build servers that you may use.
Sign into your Ionic Account using the same login info as the Ionic Hub:
Change directory into the Ionic app project folder, then register the product key to this app. When prompted, paste in the
Product Key value previously copied from the Ionic Hub:
This only needs to be run once per app. Within the app's directory, a
.npmrc file is generated and
ionic.config.json updated. Both of these changes should be committed to version control so that CI/CD systems as well as other team members can restore the plugins from a fresh clone of the app's repository.
Now you are able to install any of the Ionic Native plugins that you have access to by following the instructions on each plugin's documentation page.
Install Cordova into your project by adding the native platform(s) of choice, then install the Ionic Native plugin:
If you don't have Capacitor installed into your Ionic project, follow the instructions here first. Next, install your plugin of choice and sync the project:
Some Ionic Native solutions require updating the native project configuration file (such as the iOS' Info.plist or Android's AndroidManifest.xml) before they can be used. You'll find these configurations on each solution's Capacitor installation details.
To make these one-time manual changes, either use the native tools (Xcode, Android Studio) or edit the config files by hand. From the root directory of your Capacitor project:
- To edit
Info.plist, navigate to
- To edit
AndroidManifest.xml, navigate to
After you've added a plugin or two, continue building your app using Ionic Framework