Update Core and Integrated Plugins

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

IDE

When you need to use an important bug fix or improvement in one of the Apache Cordova core or integrated plugins, you can update the plugin. To update a core or integrated plugin in your app, you can change the target Apache Cordova version of your app or you can replace the plugin by importing it as a custom plugin.

When you change the target Apache Cordova version, AppBuilder automatically updates the core and integrated plugins in your app to match the target Apache Cordova version. You might need to replace a core or an integrated plugin by importing it as a custom plugin, if AppBuilder does not provide the target Apache Cordova version that carries the plugin update.

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

If the plugin that you want to update relies on an updated functionality in another Apache Cordova core or integrated plugin, you need to update this plugin as well.

If the plugin that you want to update relies on an updated functionality in the Apache Cordova framework that AppBuilder does not yet provide, you might not be able to build your app.

In-Browser

  • Update the plugin by changing the target Apache Cordova version.
    1. In the Project Navigator, double-click Properties.
    2. Verify that the currently open tab is General.
    3. From the Cordova Version drop-down menu, select the target Apache Cordova version that carries the updated plugin.
    4. Close the properties dialog.
  • Update the plugin by importing it as a custom plugin.
    1. Download the plugin as a ZIP archive from its GitHub repository.
    2. In the Project Navigator, double-click Properties.
    3. Select Plugins.
    4. Navigate to the Core Plugins or the Others Plugins section and expand it, if needed.
    5. Deselect the check box for the plugin that you want to update.
    6. In the Custom Plugins section, click Import.
    7. From a file explorer, drag and drop the plugin archive to the drop files here to upload text box and click Upload.
    8. Confirm the import and wait for the operation to complete.
      Make sure that the plugin files are nested in a folder in the Plugins node.
    9. (Optional) If needed, configure the plugin variables for the plugin.
      1. Click Expand for the newly added plugin to expand its configuration options.
      2. Click Configuration Variables.
      3. Select the build configuration to which you want to apply the plugin variables.
      4. Provide values for the listed variables and click Done.
    10. Close the properties dialog.

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

Universal

  • Update the plugin by changing the target Apache Cordova version.
    1. In the Project Navigator, double-click Properties.
    2. Verify that the currently open tab is General.
    3. From the Cordova Version drop-down menu, select the target Apache Cordova version that carries the updated plugin.
    4. Close the properties dialog.
  • Update the plugin by importing it as a custom plugin.
    1. Download the plugin as a ZIP archive from its GitHub repository.
    2. In the Project Navigator, double-click Properties.
    3. Select Plugins.
    4. Navigate to the Core Plugins or the Others Plugins section and expand it, if needed.
    5. Deselect the check box for the plugin that you want to update.
    6. In the Custom Plugins section, click Import.
    7. From a file explorer, drag and drop the plugin archive to the drop files here to upload text box and click Upload.
    8. Confirm the import and wait for the operation to complete.
      Make sure that the plugin files are nested in a folder in the Plugins node.
    9. (Optional) If needed, configure the plugin variables for the plugin.
      1. Click Expand for the newly added plugin to expand its configuration options.
      2. Click Configuration Variables.
      3. Select the build configuration to which you want to apply the plugin variables.
      4. Provide values for the listed variables and click Done.
    10. Close the properties dialog.

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

Windows

  • Update the plugin by changing the target Apache Cordova version.
    1. In the Project Navigator, double-click Properties.
    2. Verify that the currently open tab is General.
    3. From the Cordova Version drop-down menu, select the target Apache Cordova version that carries the updated plugin.
    4. Press Ctrl+S to save your configuration changes.
    5. Review and accept the Change version warning message, if shown.
    6. Close the dialog.
  • Update the plugin by importing it as a custom plugin.
    1. Download the plugin as a ZIP archive from its GitHub repository.
    2. In the Project Navigator, double-click Properties.
    3. Select Plugins.
    4. Navigate to the Core Plugins or the Other Plugins section and expand it, if needed.
    5. Verify that the plugin that you want to update is disabled.
      The toggle for the plugin must be set to OFF.
    6. Press Ctrl+S to save your configuration changes.
    7. Scroll to the top of the current page and click Import.
    8. Confirm the import.
    9. Navigate to the location where the plugin archive is stored, select it and click Open.
    10. Wait for the operation to complete.
      Make sure that the plugin files are nested in a folder in the Plugins node.
    11. (Optional) If needed, configure the plugin variables for the plugin.
      1. Click Expand for the newly added plugin to expand its configuration options.
      2. Click Configure.
      3. Select the build configuration to which you want to apply the plugin variables.
      4. Provide values for the listed variables and click Close.
    12. Press Ctrl+S to save your changes.
    13. Close the dialog.

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

Visual Studio

  • Update the plugin by changing the target Apache Cordova version.
    1. In the Solution Explorer, double-click Properties.
    2. Verify that the currently open tab is General.
    3. From the Cordova Version drop-down menu, select the target Apache Cordova version that carries the updated plugin.
    4. Press Ctrl+S to save your configuration changes.
    5. Close the file tab.
  • Update the plugin by importing it as a custom plugin.
    1. Download the plugin as a ZIP archive from its GitHub repository.
    2. In the Solution Explorer, double-click Properties.
    3. Select Plugins.
    4. Navigate to the Core Plugins or the Other Plugins section and expand it, if needed.
    5. Verify that the plugin that you want to update is disabled.
      The toggle for the plugin must be set to OFF.
    6. Press Ctrl+S to save your configuration changes.
    7. Close the dialog.
    8. In the Solution Explorer, right-click Plugins.
    9. Select Import Plugin.
    10. Browse and locate the archive that you want to import in AppBuilder, select it and click Open.
    11. (Optional) If needed, configure the plugin variables for the plugin.
      1. Click + for the newly added plugin to expand its configuration options.
      2. Click Configure.
      3. Select the build configuration to which you want to apply the plugin variables.
      4. Provide values for the listed variables and click Close.
    12. Press Ctrl+S to save your changes.
    13. Close the dialog.

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

CLI

  • Update the plugin by changing the target Apache Cordova version.

    1. In the command prompt, navigate to the directory that contains your app.
    2. Run the following command.

      appbuilder prop set FrameworkVersion "version number"
      

      To list the available target Apache Cordova versions, run the following command.

      appbuilder prop print FrameworkVersion --valid-value
      
  • Update the plugin by importing it as a custom plugin.

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

      appbuilder plugin
      

      The command-line interface lists all enabled core and integrated plugins.

    3. To disable a plugin, run the following command.

      appbuilder plugin remove <Plugin ID or Name>
      

      Where <Plugin ID or Name> is the plugin ID or name as listed by appbuilder plugin.

    4. To import the updated plugin, run the following command.

      appbuilder plugin fetch "Local Path, Plugin Repository, name or ID of the plugin in the Apache Cordova Plugin Registry or the npm registry"
      
    5. (Optional) If needed, configure the plugin variables for the plugin.
    6. On your local file system, open the directory that contains your app and navigate to the Plugins subdirectory.
    7. Locate plugin.xml for your Apache Cordova plugin and double-click to open it.
    8. In the markup of plugin.xml, locate the <preference> elements that contain variable declarations in the following format.

      $VARIABLE_IN_CAPITAL_LETTERS$
      
    9. Replace any $VARIABLE_IN_CAPITAL_LETTERS$ strings with the values for your plugin variables.
    10. Save changes.

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

Next Steps

Continue developing your app and writing and debugging your code.

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.