Documentation |

The Developer Hub

Welcome to the Apperyio developer hub. You'll find comprehensive guides and documentation to help you start working with apperyio as quickly as possible, as well as support if you get stuck. Let's jump right in!


Custom Plugins

Adding a custom Cordova plugin.

Introduction enables you to import Cordova plugins for use in apps without the need for configuring additional source files.

Custom Cordova plugins are supported in the following app library versions:

  • jQuery Mobile library version 5.0 or higher.
  • Ionic 4 library version 1.0 or higher.


App Version

Before you update to a new library version it's important ​that you create an app version so you can go back to it in case something doesn't work.

Importing Cordova Plugins from GitHub

Before the plugin can be used in your app, you need to import it to You can choose one of the two ways to do it:


Latest Plugin Version

We strongly recommend downloading the latest plugin version.


Important notice

Be informed that when creating an app with Cordova plugins it is important that the needed plugin be imported before you proceed with the app UI or create it from a backup.

Facebook Plugin Example

Please check how to import a custom Cordova plugin on the example of the Facebook Cordova plugin.

1. Importing from ZIP bundle

  • Go to the plugin GitHub page, for example, the official Facebook plugin in Apache Cordova/PhoneGap.
  • Here, click the Clone or download green button and select the Download ZIP option. ZIP archive with the plugin source files will be downloaded to your drive:
  • From the dashboard, navigate to Resources > Cordova plugins and click the Import Cordova plugin button.
  • Under the ZIP bundle tab, click Choose file.
  • Select the ZIP archive you have just downloaded and click Import Plugin:

From now on, when you open your projects you’ll see this plugin among the imported plugins:

2. Importing with Git URL

  • Go to the plugin GitHub page, for example, the official Facebook plugin in Apache Cordova/PhoneGap.
  • Click the green Clone or download button.
  • Click the button next to the text field to copy the plugin URL to clipboard:
  • From the dashboard, navigate to Resources > Cordova plugins and click the Import Cordova plugin button.
  • Go to the From Git tab.
  • Paste the copied URL into the Repository URL field and enter master as the Repository branch name, as shown on the screenshot below:
  • Click Import plugin. Now, you should see the plugin on the Cordova plugins list. Now, to be able to use it, enable it and click the SAVE at the top.


Important Note: Adding Dependencies in Ionic 4 projects

For correct work in Ionic 4 projects, the imported plugins must be correctly defined under the MODULE tab:

  1. First of all, go to Project > App settings > Npm modules and add a new Dependency, for example, @ionic-native/social-sharing of the needed version.
  2. Unfold the Pages folder and choose the app page.
  3. Click the MODULE tab of the app page. In the Imports section, type in import { SocialSharing } from '@ionic-native/social-sharing/ngx'; as an example.
  4. Then, scroll down to the NgModule Settings > Providers section and type SocialSharing into the text field.
  5. Save the changes.


Custom Plugin Permissions

A custom Cordova plugin permission can be managed by selecting the Permissions tab when viewing plugin details.

More Examples of Using Custom Plugins in

Below are some examples of how custom plugins can be used in projects.

  • Ionic 4 Calendar plugin Example
    In this tutorial, we will show how to build an Ionic 4 app, where you can use Cordova Calendar plugin. This plugin allows viewing and adding events to the mobile device calendar.

  • Ionic 4 Document Scanner plugin Example
    The tutorial that shows how to build an Ionic 4 app, where you can use the Cordova Document Scanner plugin.

  • Ionic 4 File Upload App Example
    This tutorial describes how to create an Ionic 4 app that can upload files from the device to the Firebase project storage using the Cordova plugins.

  • Ionic 4 Social Sharing plugin Example
    This tutorial demonstrates how to build an Ionic 4 app, where you can use Cordova Social Sharing plugin to share links, images, and text messages out of the app on social platforms or by email.

  • Toast Plugin Example Example
    Check here for instructions on how to import and configure the Toast Cordova plugin in an app.

  • Pollfish Plugin Example
    The blog post on how to add a Polish survey into your app: + Pollfish: How to Integrate a Pollfish Survey into Your App.

  • BitPay App Example
    The sample app demonstrating how to add secure Bitcoin payments to your mobile app with the BitPay Cordova SDK can be found here.


Testing Apps with Custom Plugin

To test the app, you must build the binary and launch the app on your device. Testing using Tester won't work as the plugin is not available inside the Tester app.

Passing Parameters to Plugins

Some Cordova plugins require initialization parameters to work properly. The phonegap-facebook-plugin, for example, requires APP_ID and APP_NAME variables to be specified.

Go to App settings > Cordova plugins and click the Options button next to the plugin. A modal window opens, where the necessary options can be added and specified. Click Save options.

Custom Cordova plugin parameters.


Option Button Color

The Options buttons will change to dark blue when at least one parameter is set.

Stuff You Should Know

When working with plugin parameters:

  • You can add any number of key/value pairs to any Cordova plugin (core or custom).
  • Key/values options can be changed/deleted at any time.
  • Options for unselected plugins can be managed as well.
  • Keys should be unique to one plugin (subject to validation).
  • For parameter names, the following symbols are allowed: all digits, letters, and an underscore or minus sign (subject to validation).
  • Empty keys/values are not allowed.
  • Parameter names are validated for duplication.


There are several important issues to note when using Cordova plugins:

  • Uploading files larger than 40 Mb is not allowed.
  • Before uploading plugin .zip archive make sure it contains only plugin code (without any other files).
  • Plugins do not work for Tester.
  • Cordova and Cordova plugins can’t be updated with the Automatic update feature.
  • When creating an app from the backup, re-adding custom plugins to the backup application is required as they are lost while building a backup.
  • Cordova plugins are not included under the Source tab in the Project view.

More Help Resources

Here is a great resource to help you learn Cordova basics:

Help with Custom Plugins

Our support team is not able to provide help or debug assistance with every 3rd party custom Cordova plugin since it's impossible to be familiar with all of the plugins out there.

There are many reasons why a custom plugin might not work:

  • Incorrect configuration.
  • Incorrect version support.
  • Bugs in the plugin (broken or outdated).

Our Advisory Pack and Flex Pack support services do include help with custom Cordova plugins. Please consider purchasing one of the packs if you need help with a custom Cordova plugin.

Updated 2 months ago

Custom Plugins

Adding a custom Cordova plugin.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.