Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

cordova-plugin-spinner-dialog

1.3.1 • Public • Published

SpinnerDialog

PhoneGap waiting dialog / progress dialog plugin with spinner for Android, iOS and Windows Phone 8.

Installation

Latest stable release: phonegap local plugin add cordova-plugin-spinner-dialog
or cordova plugin add cordova-plugin-spinner-dialog

Current state from git: phonegap local plugin add https://github.com/Paldom/SpinnerDialog.git
or cordova plugin add https://github.com/Paldom/SpinnerDialog.git

Installation - PhoneGap Build

Add following to config.xml: <gap:plugin name="cordova-plugin-spinnerdialog" source="npm" />

For older versions, use the following: <gap:plugin name="hu.dpal.phonegap.plugins.spinnerdialog" /> or <gap:plugin name="hu.dpal.phonegap.plugins.spinnerdialog" source="plugins.cordova.io" />

Methods

  • window.plugins.spinnerDialog.show
  • window.plugins.spinnerDialog.hide

window.plugins.spinnerDialog.show

window.plugins.spinnerDialog.show([title], [message], [cancelCallback])
  • title: Spinner title (Android only). Optional. (String)
  • message: Spinner message. Optional. (String)
  • cancelCallback: Callback to invoke when spinner cancel event fired (tap or Android hardware back button event). If set, spinner dialog will be fixed, you should explicitly call window.plugins.spinnerDialog.hide. Due to legacy reasons you can provide boolean value (true/false) to set spinner not cancelable. Optional, defaults to false. (Function/Boolean)

Supported Platforms

  • Android
  • iOS
  • Windows Phone 8

Usage

// Show spinner dialog
window.plugins.spinnerDialog.show();

// Show spinner dialog with message 
// Note: spinner dialog is cancelable by default
window.plugins.spinnerDialog.show(null, "message");

// Set spinner dialog fixed
window.plugins.spinnerDialog.show(null, null, true);

// Set spinner dialog fixed with callback
// Note: callback fires on tap events and Android hardware back button click event
window.plugins.spinnerDialog.show(null, null, function () {console.log("callback");});

// Show spinner dialog with title and message (Android only)
window.plugins.spinnerDialog.show("title","message");

// Set spinner dialog fixed (cannot be canceled with screen touch or Android hardware button)
window.plugins.spinnerDialog.show("title","message", true);

// Hide spinner dialog
window.plugins.spinnerDialog.hide();

Note: on Android platform, multiple show calls builds up a stack (LIFO) which means hide will dismiss the last spinner added with show call.

Install

npm i cordova-plugin-spinner-dialog

DownloadsWeekly Downloads

157

Version

1.3.1

License

MIT

Last publish

Collaborators

  • avatar