Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greybax/cordova-plugin-native-spinner
:arrows_counterclockwise: Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog
https://github.com/greybax/cordova-plugin-native-spinner
android cordova cordova-android cordova-android-plugin cordova-ios cordova-ios-plugin cordova-plugin ios native phonegap phonegap-plugin spinner spinner-components spinner-icon windows windows-10 windows-phone windows10 windowsphone wp
Last synced: about 2 months ago
JSON representation
:arrows_counterclockwise: Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog
- Host: GitHub
- URL: https://github.com/greybax/cordova-plugin-native-spinner
- Owner: greybax
- License: mit
- Fork: true (ravi013/cordova-plugin-spinnerdialog)
- Created: 2017-04-13T00:04:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-08-10T19:32:40.000Z (over 2 years ago)
- Last Synced: 2024-09-24T21:03:42.941Z (about 2 months ago)
- Topics: android, cordova, cordova-android, cordova-android-plugin, cordova-ios, cordova-ios-plugin, cordova-plugin, ios, native, phonegap, phonegap-plugin, spinner, spinner-components, spinner-icon, windows, windows-10, windows-phone, windows10, windowsphone, wp
- Language: JavaScript
- Homepage:
- Size: 109 KB
- Stars: 32
- Watchers: 6
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cordova-plugin-native-spinner
[![NPM version][npm-image]][npm-url] [](https://www.npmjs.com/package/cordova-plugin-native-spinner)   
> Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog
NPM Package: [cordova-plugin-native-spinner](https://www.npmjs.com/package/cordova-plugin-native-spinner)
:fire: **This Plugin** is officially using in [ionic-native](https://ionicframework.com/docs/native/spinner-dialog/) :fire:
## Platforms
| 
| 
| 
| | 
|:---:|:---:|:---:|:---:|:---:|
| 4.1+ ✔ | 10+ ✔ | WP 8.1+ ✔ | 10+ ✔ | Browser ✔ |
## Installation
**Latest stable release**:
* PhoneGap - `phonegap local plugin add cordova-plugin-spinner-dialog`
* Cordova - `cordova plugin add cordova-plugin-spinner-dialog`
**Current state from git**:
* PhoneGap - `phonegap local plugin add https://github.com/greybax/cordova-plugin-native-spinner`
* Cordova - `cordova plugin add https://github.com/greybax/cordova-plugin-native-spinner`
```
cordova plugin add cordova-plugin-native-spinner
cordova prepare
```
## Includes PR's improvements from Paldom/SpinnerDialog:
* [InAppBrowser Compatibility](https://github.com/Paldom/SpinnerDialog/pull/34)
* [Change loading text if we call show function and loading dialog exists](https://github.com/Paldom/SpinnerDialog/pull/23)
* and **tons fixes** from here https://github.com/Paldom/SpinnerDialog/issues ...
## 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 `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([wpStatusbar]);
- __wpStatusbar__: Indicates whether to keep the status bar visible. (Windows 10 Mobile only). If set to `true`, only the spinner will be hidden, the status bar will remain visible if it was already visible. Optional, defaults to `false`. _(Boolean)_
## Usage
```javascript
// 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.
## Screenshots
### Android
### Browser
## Plugin demo app
Demo app source code to test the plugin is available at the [cordova-plugin-demos repository](https://github.com/andreszs/cordova-plugin-demos/tree/main/com.andreszs.spinner.demo "cordova-plugin-demos repository") by Andrés Zsögön.
## Post in my blog
https://alfilatov.com/posts/cordova-plugin-native-spinner/
## License
See "LICENSE".
Based on https://github.com/Paldom/SpinnerDialog with lots of awesome improvements! :star: :tada: :rocket: :star:
[npm-url]: https://npmjs.org/package/cordova-plugin-native-spinner
[npm-image]: https://img.shields.io/npm/v/cordova-plugin-native-spinner.svg