# cordova-plugin-spinnerdialog

> PhoneGap waiting dialog (progress indicator) plugin with spinner for Android, iOS and Windows Phone 8.

Latest version **1.3.2** (published 2015-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install cordova-plugin-spinnerdialog
pnpm add cordova-plugin-spinnerdialog
yarn add cordova-plugin-spinnerdialog
bun add cordova-plugin-spinnerdialog
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2015-09-22 |
| First published | 2015-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Robert Hovhannisyan |
| Maintainers | roberthovhannisyan |
| Keywords | phonegap, android, ios, wp8, windows, phone, spinner, dialog, progress, indicator, ecosystem:cordova, cordova-android, cordova-ios, cordova-wp8 |

## Links

- npm: https://www.npmjs.com/package/cordova-plugin-spinnerdialog
- Repository: https://github.com/roberthovhannisyan/SpinnerDialog
- Homepage: https://github.com/roberthovhannisyan/SpinnerDialog#readme
- Issues: https://github.com/roberthovhannisyan/SpinnerDialog/issues
- npm.io page: https://npm.io/package/cordova-plugin-spinnerdialog

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2015-09-22

## README

SpinnerDialog
=============

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

> Note: The pluglin is a fork of [Sharinglabs](https://github.com/Sharinglabs/SpinnerDialog) version forked from  [Paldom](https://github.com/Paldom/SpinnerDialog)

## Installation

Use the following command to install the plugin from npmjs repository with with Cordova CLI (requires cordova 5.0+)
```cordova plugin add cordova-plugin-spinnerdialog```  

## Installation - PhoneGap Build 

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

## 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.

---
_Source: https://npm.io/package/cordova-plugin-spinnerdialog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._