Skip to content

Commit

Permalink
added usage category
Browse files Browse the repository at this point in the history
  • Loading branch information
greybax committed Apr 14, 2017
1 parent 57c8ca6 commit 3a1d33f
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,42 @@ cordova prepare
#### SpinnerDialog.hide
SpinnerDialog.hide();

## Usage

```
// Show spinner dialog
SpinnerDialog.show();
// Show spinner dialog with message
// Note: spinner dialog is cancelable by default
SpinnerDialog.show(null, "message");
// Set spinner dialog fixed
SpinnerDialog.show(null, null, true);
// Set spinner dialog fixed with callback
// Note: callback fires on tap events and Android hardware back button click event
SpinnerDialog.show(null, null, function () {console.log("callback");});
// Show spinner dialog with title and message (Android only)
SpinnerDialog.show("title","message");
// Set spinner dialog fixed (cannot be canceled with screen touch or Android hardware button)
SpinnerDialog.show("title","message", true);
// Overlay opacity and text color options (IOS only)
SpinnerDialog.show(null,"Message",true, {overlayOpacity: 0.35, textColorRed: 1, textColorGreen: 1, textColorBlue: 1});
// Change only overlay opacity (IOS only)
SpinnerDialog.show(null,"Message",true,{overlayOpacity:0.70});
// Change only text color (IOS only)
SpinnerDialog.show(null,"message",true, { textColorRed: 0.1, textColorGreen: 0.1, textColorBlue: 1});
// Hide spinner dialog
SpinnerDialog.hide();
```

## Quirks
* Cordova 5.0 or higher is required for Windows 10 support.
* Windows 10 Mobile or Windows Phone 8.1 is required as desktop doesn't support StatusBar.
Expand Down

0 comments on commit 3a1d33f

Please sign in to comment.