icon element

Syntax

<icon src="string" />

Description

The <icon> element specifies a custom icon for a BlackBerry WebWorks app. The icon that you specify in the src attribute is the app's icon that appears on the Home screen of the BlackBerry device. The icon must meet the requirements for custom or default icons.

This element is optional.

Parent elements

<widget>

Child elements

None

Occurrences

Zero or more

Attributes

You can use the following attributes in this element:

Attribute Description
src

Specifies the path for an image file in the app archive.

This attribute is required.

rim:hover

A Boolean value that specifies whether the icon is used as a hover icon. The first hover icon in the config.xml file is used as the hover icon for the app.

By default, if you do not specify a value for the rim:hover attribute, the value is set to false.

This attribute is optional.

BlackBerry smartphone icons

  • If you do not specify the <icon> element, the BlackBerry WebWorks Packager uses the default icon from the app archive. If the BlackBerry WebWorks Packager does not find the default icon in the archive, it uses the default device app icon.
  • You can specify one or more <icon> elements. The first icon that you specify that does not use the rim:hover attribute appears on the Home screen of the device.
  • You can also specify an icon by invoking the blackberry.app.setHomeScreenIcon(src, rim:hover) that is provided in the BlackBerry WebWorks Packager API.
<icon src="icons/appicon.png"/>
<icon src="icon/hovicon.png" rim:hover="true"/>

Last modified: 2013-10-02