Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

README.md

Built For BlackBerry - BBUI.js 0.9x Boilerplate

This sample is a meant to be a starting point for any BlackBerry WebWorks developer creating an app that delivers the signature BlackBerry 10 experience, and could pass the "Built For BlackBerry" designation.

It includes many of the "must have" components: BBM, Share Framework, App Menu (swipe down), Window Covers, Toasts, BlackBerry 10 UI look and feel using bbUI.js.

If you'd like to learn more about the Built For BlackBerry program, be sure to head on over to the website.

Applies To

Author(s)

Built For BlackBerry

Dependencies

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

Icons

Contributing

Screenshots

image image image image

Required Plugins

The following Cordova Plugins are required for this sample:

com.blackberry.bbm.platform
com.blackberry.invoke
com.blackberry.invoke.card
com.blackberry.ui.cover
com.blackberry.ui.toast
com.blackberry.utils

Using The Boilerplate

Activity Spinner

Show

Spinner.on('small');
Spinner.on('medium');   
Spinner.on('large');    

Hide

Spinner.off();

BBM

Register with the BlackBerry Messenger service

Bbm.register();

Update users status message

Bbm.updateMessage();

Invite to download

Bbm.inviteToDownload();

Invoking Apps

Share Targets

Invoke.app.targets();

BlackBerry Worl - App

Invoke.app.blackberryWorld(applicationID);

Compose an email

Invoke.app.email('email@address.com', 'subject', 'body');

Maps

Invoke.app.maps('123 Street St, Waterloo, Ontario, Canada');

NFC

Invoke.app.nfc('http://www.blackberry.com');

Twitter

Invoke.app.twitter('this is a tweet!');

Facebook

Invoke.app.facebook('this is a status update!');

Take Photo

Invoke.utils.camera(function(path) {
    // success
        console.log('Photo: ' + path);
    },

    // card closed
    function(reason) {
        console.log('Card closed: ' + reason);
    },

    // error
    function(error) {
        console.log(error);
});

File Picker

Invoke.utils.filePicker(function(path) {
    // success
        console.log('Picked: ' + path);
    },

    // card closed
    function(reason) {
        console.log('Card closed: ' + reason);
    },

    // error
    function(error) {
        console.log(error);
});

Toasts

Regular

Toast.regular('This is a toast!', 2500);

With Button

Toast.withButton('Toast w/Button', 'Button', 'toastCallbackFunction', 3000);

Window Covers

Setup a Window Cover / Active Frame

App.ui.windowCover.setup('local:///cover.png');

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>\BfB-Boilerplate-bbUI.js-0.9x
    
  4. Replace the default BfB-Boilerplate-bbUI.js-0.9x\www folder with the \www folder from this project

  5. Replace the default BfB-Boilerplate-bbUI.js\config.xml with the config.xml from this project

  6. From the command prompt (Windows) or terminal (mac), navigate to the BfB-Boilerplate-bbUI.js-0.9x folder

    cd <your source folder>\BfB-Boilerplate-bbUI.js-0.9x
    
  7. Run the following commands to configure plugins used by this app

    webworks plugin add com.blackberry.app
    webworks plugin add com.blackberry.invoke
    webworks plugin add com.blackberry.invoke.card
    webworks plugin add com.blackberry.ui.cover
    webworks plugin add com.blackberry.ui.toast
    webworks plugin add com.blackberry.utils    
    
  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.