Configure the Core Plugins

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

IDE

With the core plugins, you access native operating system functionality such as the accelerometer, camera, compass or the file system. You can enable or disable the core plugins required for your app from the user interface.

You can choose which plugins to enable when you build with the debug and the release configurations. By default, the core plugins are enabled in all build 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 Properties.
  2. In the Plugins tab, navigate to the Core Plugins section and expand it, if needed.
    A check mark indicates if a core plugin is enabled or disabled.
  3. To enable or disable a plugin for all build configurations, select or deselect the check box for the plugin.
  4. To enable or disable a plugin for a selected build configuration, complete the following steps.
    1. Click Expand for the plugin.
    2. To enable or disable the plugin for the debug configuration, select or deselect the respective check box.
    3. To enable or disable the plugin for the release configuration, select or deselect the respective check box.
  5. Configure the plugin variables for the plugin, if any.
    1. Click Expand for the plugin.
    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.
  6. Close the properties dialog.

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

Universal

  1. In the Project Navigator, double-click Properties.
  2. In the Plugins tab, navigate to the Core Plugins section and expand it, if needed.
    A check mark indicates if a core plugin is enabled or disabled.
  3. To enable or disable a plugin for all build configurations, select or deselect the check box for the plugin.
  4. To enable or disable a plugin for a selected build configuration, complete the following steps.
    1. Click Expand for the plugin.
    2. To enable or disable the plugin for the debug configuration, select or deselect the respective check box.
    3. To enable or disable the plugin for the release configuration, select or deselect the respective check box.
  5. Configure the plugin variables for the plugin, if any.
    1. Click Expand for the plugin.
    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.
  6. Close the properties dialog.

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

Windows

  1. In the Project Navigator, double-click Properties.
  2. In the Plugins tab, navigate to the Core Plugins section and expand it, if needed.
    An ON or OFF slider indicates if a core plugin is enabled or disabled, respectively.
  3. To enable or disable a plugin, click the ON or OFF slider for the plugin, respectively.
  4. To enable or disable a plugin for a selected build configuration, complete the following steps.
    1. Click Expand for the plugin.
    2. To enable or disable the plugin for the debug configuration, select or deselect the Debug check box, respectively.
    3. To enable or disable the plugin for the release configuration, select or deselect the Release check box, respectively.
  5. Configure the plugin variables for the plugin, if any.
    1. Click Expand for the plugin.
    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.
  6. Press Ctrl+S to save your changes.
  7. Close the properties dialog.

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

Visual Studio

  1. In the Solution Explorer, double-click Properties.
  2. In the Plugins tab, navigate to the Core Plugins section and expand it, if needed.
    An ON or OFF slider indicates if a core plugin is enabled or disabled, respectively.
  3. To enable or disable a plugin, click the ON or OFF slider for the plugin, respectively.
  4. To enable or disable a plugin for a selected build configuration, complete the following steps.
    1. Click + for the plugin.
    2. To enable or disable the plugin for the debug configuration, select or deselect the respective check box.
    3. To enable or disable the plugin for the release configuration, select or deselect the respective check box.
  5. Configure the plugin variables for the plugin, if any.
    1. Click + for the plugin.
    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.
  6. Press Ctrl+S to save your changes.
  7. Close the properties dialog.

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

CLI

  1. (Optional) To list the currently enabled Apache Cordova plugins, run the following command.

    appbuilder plugin
    
  2. (Optional) To list the core and integrated 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.

  3. To enable a core plugin, run the following command.

    appbuilder plugin add <Plugin ID>
    

    Where <Plugin ID> is the plugin ID as listed by appbuilder plugin add --available.

    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.

    1. If prompted, provide value for the plugin variable for the Debug configuration and press Enter.
    2. If prompted, provide value for the plugin variable for the Release configuration and press Enter.
  4. To disable an enabled plugin, run the following command.

    appbuilder plugin remove <Plugin ID>
    

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

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

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

Next Steps

Configure any plugin variables for the plugin and 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.