Configuring your app preferences

You can configure aspects of your app, such as its orientation or background color, by setting your app preferences. You can configure your app preferences using the BlackBerry 10 WebWorks SDK web tool, or you can edit the config.xml file. For information on editing the config.xml file, see Modifying your config.xml file.

To set your app preferences with the BlackBerry 10 WebWorks SDK web tool:

  1. Open BlackBerry WebWorks <version>. A new browser window opens, displaying the BlackBerry 10 WebWorks SDK web tool.
  2. Navigate to your project and click Config.
  3. Complete the fields for the preferences you would like to set.

The following table lists the available preferences and their descriptions.

Preference Description

App ID

The ID of your application.

App Name

The name of your application.

Icon

The image that appears on a device's app grid.

Splash Screen Image

The image that's displayed when the app is opened.

Project Location

The path of your project directory.

App Description

A description of your app.

Author

Your name, or the name of your organization.

Author Email

The email address that is associated with the author.

Author URL

A web address that is associated with the author.

App Background Color

The background color for your app.

License

The end-user license agreement or a copyright statement for a BlackBerry WebWorks app. The content is made available on the About screen in the app.

Main URL

The start page that the BlackBerry WebWorks app displays when it runs.

Orientation

The orientation for screens in your app. The orientation can be default (orientation changes according to the orientation of the device), portrait, or landscape. If no value is specified, the orientation is set to default.

Autohide Splash Screen

Hides the splash screen for your application. When this setting is disabled, the splash screen is displayed until splashscreen.hide() is invoked in your code.

Hide Keyboard Form Bar

Hides the row of buttons (Previous, Next, and Submit) that is displayed when an <input> element on the current page of the app gets focus.

Enable Child Browser

Enables your app to open child browser windows. A child window is launched when the content attempts to open a resource in a new window or tab (by using window.open(), or by specifying _blank as the target of an anchor).

Enable Popup Blocker

When selected, prevents the app from displaying popups.

Enable Web Security

Enables web security. Disabling web security allows you to access remote content from unknown sources.

This feature is intended primarily as a development convenience. In production, URIs should generally be known and should be whitelisted using the Access List preference.

If you disable web security, before packaging your app for distribution, you should re-enable this setting, unless there is an explicit reason not to do so.

Enable Disk Cache

Enables WebView caching, which prevents the app from issuing multiple network requests for the same resource.

Enable Spatial Navigation

Enables spatial navigation on devices with a track pad or similar input method. Spatial navigation allows the user to skip from one focusable element (for example, a text field or button) to another, rather than having to select each element to give it focus.

For more information about navigation modes, see Setting the navigation mode for trackpad input.

Access List

Specifies which domains the app is permitted to access. By default, no access to external domains is permitted.

For more information about whitelisting domains, see Accessing external resources.

Permissions

Allows you to specify any permissions required to allow plugins to access native functionality.

For more information about permissions, see Adding and removing app permissions.

Last modified: 2014-09-29



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus