If you find any errors, typos or have general feedback, select the text and click CTRL+ALT+ENTER.

Introduction

A plugin is an out-of-the-box component that can be easily added to your app. A plugin can be as simple as a single page or service, but to provide more complete functionality, it usually contains a page, service and a mapping. You can create your own plugins. These plugins will be private by default, and available only to you.

Public plugins

Public plugins are available to all Appery.io developers. If you created a plugin, and would like us to add it to our plugin directory, please email us at support@appery.io. Below is a list of available tutorials for our public plugins.

Also, Appery.io enables adding Cordova plug-ins to your apps. Please read here for more information.

Business and development

Email and SMS

Payments

Native features

Creating your own plugins

Create a plugin

Build an app that you want to export as a plugin. You don’t need to build a complete, working app. You can create just pages, or just services, and export them as a plugin.

In the upper dashboard, click EXPORT -> Appery.io plugin. The following dialog opens:

Exporting_plugin

Set up the following:

  1. Enter the plugin name and description.
  2. Upload the plugin’s icon image.
  3. Provide an API home page and documentation site.
  4. Set the plugin version.
  5. Pick at least one category.
  6. Set the API vendor.

By default, the entire project is exported as a plugin. If you want to use just some specific pages or services as a template, uncheck the Export entire project checkbox and select app files to export.

Click Export to finish.

Plugins list

To see all plugins (private) you have created, go to Plugins tab:
Plugins_list

You can find information about the plugin (creator e-mail, publicity, import counter value and so on) and:

  • Open the plugin to edit it.
  • Rename the plugin.
  • Delete it.
  • Backup it.

Update the plugin

There are three ways to update the plugin:

  1. Create a new plugin.
  2. Open the plugin and edit it.
  3. Replace the plugin with a new version.

When creating a new plugin, you lose the Import counter value (the new plugin doesn’t inherit this value from the old one). If you open and edit the plugin, someone can import it when you haven’t finished working on it – it’s unsafe. The safest way is to replace the plugin with a new version.

To replace the plugin with a new version:

1. Open the project your plugin was created from, or recreate a project with the same features.

2. Make changes in the project and check that it works correctly (debug it).

3. Select Export > Appery.io plugin.

4. In the Export plugin tab, check the Replace plugin box:
Replace_plugin

5. In the popup, check the plugin you are going to replace and click Import selected plug-ins.

6. Change the version of the plugin. Other properties can also be updated. Make sure the additional options’ boxes are checked correctly.

7. Click Replace.

Your plugin will be replaced instantly, and the import counter will be kept.

Publish as project template

Any project can also be published as a project template. To export it as a project template, check Export entire project, and Add this plugin as project template:
Publish_as_template

To export it as a project template, Export entire project must be selected.

To create a new app based on a project template, click Create from the Apps page, then select the project in From template tab.

When you go to Plugins, you’ll see a project template listed there as well (with “Project template: yes”):
(image)

Make your plugin public

By default, custom plugins are only available to you and your team. If you would like to make your plugin public and available to the entire Appery.io user community, please contact support@appery.io. We will review the plugin and publish it.

Importing plug-ins

To import a plugin (public or private) to your app:

  1. From Project view, click CREATE NEW > From Plugin.
  2. Select the needed plugin(s) from list and click Import selected plugins.
  3. Select a start page for default routing (you may skip it and set it later in Project > Routing).
  4. If imported plugin contains index page you will be asked about further action with it. You’ll need to decide which index page to use in your app – created from plugin or your old one. If you don’t know which index screen to choose leave them all. You can review pages and remove the one you don’t need later.

    It is important to leave only one index page in your app. Otherwise, it will be randomly selected from two pages when running app.

  5. Click Apply settings.
  6. All the routing will be merged. Routes added to plugin screens will be added to your existing routes. If routes coincide, plugin routes will be automatically renamed. Please correct any renamed routes manually in navigate-to directive and Apperyio.navigateTo().

In Project view, you should now see files from the plugin added to your app.

If an app asset name coincide with a plugin asset name, it will be automatically renamed. So you can expect the need to rename screens, services, directives etc. Also check Routing, JavaScript code and directives.

More help resources

More help resources are links to the blog, our YouTube channel and other web sites.