Skip to content
This repository
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Custom Context Menu Sample

This sample demonstrates how to set custom Context Menu's to DOM Elements into a BlackBerry WebWorks application for BlackBerry 10.

The sample code for this application is Open Source under the Apache 2.0 License.

Applies To

Author(s)

Dependencies

  1. bbUI.js is licensed under the Apache 2.0 license.

Icons
Icons used here are from Liz Myers and are licensed under the CC-BY-3.0 license.

To contribute code to this repository you must be signed up as an official contributor.

Screenshots

Screenshot

API Documentation

The documentation for this API is available at https://developer.blackberry.com/html5/apis/blackberry.ui.contextmenu.html#.defineCustomContext

How to Use

Config.xml

The following feature must be included in your project's config.xml.

<feature id="blackberry.ui.contextmenu" />

Define the custom Context Menu

var options = {
    includeContextItems: [blackberry.ui.contextmenu.CONTEXT_IMAGE],
    includePlatformItems: true,
    includeMenuServiceItems: true
};

blackberry.ui.contextmenu.defineCustomContext("myContext", options)

Setup the custom menu item

var myItem = {
    actionId: 'MyCustomAction',
    label: 'Custom Item',
    icon: <path to image>
},

Set which context type will trigger the menu

contexts = [blackberry.ui.contextmenu.CONTEXT_IMAGE];

Add the custom menu item to the Context Menu

blackberry.ui.contextmenu.addItem(contexts, myItem, function() {
    console.log('Custom item selected');
});

How to Build

  1. Clone this repo to your local machine.

  2. Ensure the BlackBerry 10 WebWorks SDK 2.0 is correctly installed.

  3. Open a command prompt (windows) or terminal (mac) and run the following command:

    webworks create <your source folder>\CustomContext
    
  4. Replace the default CustomContext\www folder with the \www folder from this project

  5. Replace the default CustomContext\config.xml with the config.xml from this project

  6. From the command prompt (Windows) or terminal (mac), navigate to the CustomContext folder

    cd <your source folder>\CustomContext
    
  7. Run the following commands to configure plugins used by this app

    webworks plugin add com.blackberry.app
    webworks plugin add com.blackberry.ui.toast
    webworks plugin add com.blackberry.ui.contextmenu
    
  8. Run the following command to build and deploy the app to a device connected via USB

    webworks run
    

More Info

Contributing Changes

Please see the README of the BB10-WebWorks-Samples repository for instructions on how to add new Samples or make modifications to existing Samples.

Bug Reporting and Feature Requests

If you find a bug in a Sample, or have an enhancement request, simply file an Issue for the Sample.

Disclaimer

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.