pDialog - A Native Android Progress Dialog Plugin for Cordova

Requirements

• Android 4 or higher
• Cordova 3.0 or higher

Installation

cordova plugin add cordova-plugin-pdialog

Simple Usage

show:

cordova.plugin.pDialog.init({
    theme : 'HOLO_DARK',
    progressStyle : 'SPINNER',
    cancelable : true,
    title : 'Please Wait...',
    message : 'Contacting server ...'
});

dismiss:

cordova.plugin.pDialog.dismiss();

Functions

###.init(arguments)

Initialize the progress dialog and set various parameters. These are the valid options:

theme: can be one of the following: TRADITIONAL, DEVICE_DARK, DEVICE_LIGHT (default), HOLO_DARK, HOLO_LIGHT

progressStyle: can be one of the following: SPINNER (default), HORIZONTAL

cancelable: true (default) or false

title: title of the progress dialog (defaults to empty)

message: contents of the progress dialog (defaults to empty)

cordova.plugin.pDialog.init({
    theme : 'HOLO_DARK',
    progressStyle : 'SPINNER',
    cancelable : true,
    title : 'Please Wait...',
    message : 'Contacting server ...'
});

###.dismiss()

Dismiss the progress dialog.

cordova.plugin.pDialog.dismiss();

###.setProgress(int)

Set the value of the progress bar when progressStyle is HORIZONTAL.

cordova.plugin.pDialog.init({progressStyle : 'HORIZONTAL', title: 'Please Wait...', message : 'Connecting to server...'});
cordova.plugin.pDialog.setProgress(25);

###.setTitle(title)

Set the title of the progress dialog.

cordova.plugin.pDialog.setTitle('Please Wait...');

###.setMessage(message)

Set the message of the progress dialog

cordova.plugin.pDialog.setMessage('Connecting to server...');   

###.setCancelable(boolean)

Set whether the progress dialog is calncelable or not (defaults to true)

cordova.plugin.pDialog.setCancelable(false); // The user can not cancel the progress dialog  

Chaining The Functions

It is also possible to chain the functions instead of calling them one by one.

cordova.plugin.pDialog.init({
    theme: 'HOLO_DARK',
    title: 'Please Wait...',
    message : 'Connecting to server1...',
    progressStyle: 'HORIZONTAL'
})
.setProgress(25)
.setMessage('Connecting to server2...');

LICENSE

The MIT License (MIT)

Copyright (c) 2014 pwlin - [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.