Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 2.01 KB

README.md

File metadata and controls

39 lines (29 loc) · 2.01 KB

cordova-plugin-spinnerdialog

Cordova plugin for showing a progress indicator based on Paldom/SpinnerDialog

cordova-plugin-progress-indicator on NPM

Platforms

Android logo iOS logo Windows logo Windows logo
4.1+ ✔ ?+ ✔ Windows Phone 8.1+ ✔ 10+ ✔

Installation

cordova plugin add https://github.com/filfat-Studios-AB/cordova-plugin-spinnerdialog
cordova prepare

Methods

  • SpinnerDialog.show
  • SpinnerDialog.hide

SpinnerDialog.show

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)

SpinnerDialog.hide

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.

License

See "LICENSE". Based on https://github.com/Paldom/SpinnerDialog