Progress will discontinue Telerik Platform on May 10th, 2018. Learn more

Install a Verified Plugin

Filter by IDE
Select the Progress AppBuilder client you are currently using for development.

IDE

You can install one or more of the Apache Cordova plugins from the Telerik Verified Plugins Marketplace to expand the functionality of your app. Telerik manages the Telerik Verified Plugins Marketplace, a collection of custom Apache Cordova plugins that the Telerik team modifies, configures and updates regularly to ensure that mobile developers can easily integrate the plugins in their hybrid mobile apps.

To let you easily identify plugins created and maintained by Telerik or its partners, AppBuilder shows the Telerik Plugin tag for plugins developed by Telerik and the Partner Plugin tag for plugins developed by partners of the company.

When you enable a verified plugin, AppBuilder does not add the plugin files to the Plugins folder in your app. Instead, AppBuilder lists them in the Other Plugins section in the Properties.

You can choose which plugins to enable when you build with the debug and the release configurations.

Prerequisites

  • Verify that your preferred AppBuilder client is running and you are logged in.
  • Verify that you have opened the code for your app in AppBuilder.

Procedure

In-Browser

  1. In the Project Navigator, double-click Plugins.
  2. In the Plugins tab, navigate to the Other Plugins section and expand it, if needed.
  3. Click Install from Plugins Marketplace.
  4. (Optional) Select your target mobile platforms to filter the available plugins.
  5. (Optional) Select a tag to filter the available plugins.
  6. Select the plugin that you want to use in your app.
    The New badge indicates that a new version is available for this plugin.
  7. (Optional) In the plugin description panel, from the Version drop-down menu, select the version that you want to install.
  8. Click Install.
    AppBuilder shows a check mark next to the newly installed plugin.
  9. Close the Manage Packages window.
    AppBuilder now lists the installed plugin in the Other Plugins section.
  10. Click Expand for the newly added plugin to expand its configuration options.
  11. Set values for the plugin variables, if any.
    1. Click Configuration Variables.
    2. Select the build configuration to which you want to apply the plugin variables.
    3. Provide values for the listed variables and click Done.
  12. Select the build configurations for which you want to enable the plugin.
  13. Close the properties dialog.

You might need to add <script> includes for the verified plugin in your index.html. You do not need to declare the verified plugins in the config.xml files for iOS, Windows Phone and Android.

Universal

  1. In the Project Navigator, double-click Plugins.
  2. In the Plugins tab, navigate to the Other Plugins section and expand it, if needed.
  3. Click Install from Plugins Marketplace.
  4. (Optional) Select your target mobile platforms to filter the available plugins.
  5. (Optional) Select a tag to filter the available plugins.
  6. Select the plugin that you want to use in your app.
    The New badge indicates that a new version is available for this plugin.
  7. (Optional) In the plugin description panel, from the Version drop-down menu, select the version that you want to install.
  8. Click Install.
    AppBuilder shows a check mark next to the newly installed plugin.
  9. Close the Manage Packages window.
    AppBuilder now lists the installed plugin in the Other Plugins section.
  10. Click Expand for the newly added plugin to expand its configuration options.
  11. Set values for the plugin variables, if any.
    1. Click Configuration Variables.
    2. Select the build configuration to which you want to apply the plugin variables.
    3. Provide values for the listed variables and click Done.
  12. Select the build configurations for which you want to enable the plugin.
  13. Close the properties dialog.

You might need to add <script> includes for the verified plugin in your index.html. You do not need to declare the verified plugins in the config.xml files for iOS, Windows Phone and Android.

Windows

  1. In the Project Navigator, double-click Properties.
  2. In the Plugins tab, navigate to the Other Plugins section and expand it, if needed.
  3. Click Install from Plugins Marketplace.
  4. (Optional) Select your target mobile platforms to filter the available plugins.
  5. (Optional) Select a tag to filter the available plugins.
  6. Select the plugin that you want to use in your app.
    The New badge indicates that a new version is available for this plugin.
  7. (Optional) In the plugin description panel, from the Version drop-down menu, select the version that you want to install.
  8. Click Install.
    AppBuilder shows a check mark next to the newly installed plugin.
  9. Close the Manage Packages window.
  10. Click Expand for the newly added plugin to expand its configuration options.
  11. Set values for the plugin variables, if any.
    1. Click Configure.
    2. Select the build configuration to which you want to apply the plugin variables.
    3. Provide values for the listed variables and click Close.
  12. Select the build configurations for which you want to enable the plugin.
  13. Press Ctrl+S to save your changes.
  14. Close the properties dialog.

You might need to add <script> includes for the verified plugin in your index.html. You do not need to declare the verified plugins in the config.xml files for iOS, Windows Phone and Android.

Visual Studio

  1. In the Project Navigator, double-click Properties.
  2. In the Plugins tab, navigate to the Other Plugins section and expand it, if needed.
  3. Click Install from Plugins Marketplace.
  4. (Optional) Select your target mobile platforms to filter the available plugins.
  5. (Optional) Select a tag to filter the available plugins.
  6. Select the plugin that you want to use in your app.
    The New badge indicates that a new version is available for this plugin.
  7. (Optional) In the plugin description panel, from the Version drop-down menu, select the version that you want to install.
  8. Click Install.
    AppBuilder shows a check mark next to the newly installed plugin.
  9. Close the Manage Packages window.
  10. Click + for the newly added plugin to expand its configuration options.
  11. Set values for the plugin variables, if any.
    1. Click Configure.
    2. Select the build configuration to which you want to apply the plugin variables.
    3. Provide values for the listed variables and click Close.
  12. Select the build configurations for which you want to enable the plugin.
  13. Press Ctrl+S to save your changes.
  14. Close the properties dialog.

You might need to add <script> includes for the verified plugin in your index.html. You do not need to declare the verified plugins in the config.xml files for iOS, Windows Phone and Android.

CLI

  1. In the command prompt, navigate to the directory that contains your app.
  2. (Optional) To list the currently enabled Apache Cordova plugins, run the following command.

    appbuilder plugin
    
  3. (Optional) To list the Telerik verified plugins that are available for your app, run the following command.

    appbuilder plugin add --available
    

    This command also prints information about the required module variables, if any.

  4. To enable a Telerik verified plugin, run the following command.

    appbuilder plugin add <Plugin ID or Name>
    

    Where <Plugin ID or Name> is the plugin ID or name as listed by appbuilder plugin add --available. If the plugin name contains spaces, make sure to place the plugin name in quotation marks (").

    Set the --debug or --release switch to enable the plugin only for the corresponding build configuration. If no switch is set, the plugin is enabled for all build configurations.

    Set the --default or --latest switch to install the recommended or the latest available version of the plugin.

    1. If prompted, use the arrow keys to choose which plugin version to install and press Enter.
    2. If prompted, provide value for the plugin variable for the Debug configuration and press Enter.
    3. If prompted, provide value for the plugin variable for the Release configuration and press Enter.

Next Steps

Configure any plugin variables for the plugin and continue developing your app and writing and debugging your code.

You might need to add <script> includes for the verified plugin in your index.html. You do not need to declare the verified plugins in the config.xml files for iOS, Windows Phone and Android.

See Also

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.