Git Product home page Git Product logo

cordova-plugin-native-spinner's Introduction

cordova-plugin-native-spinner

NPM version NPM downloads GitHub code size in bytes GitHub top language License

Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog

NPM Package: cordova-plugin-native-spinner

🔥 This Plugin is officially using in ionic-native 🔥

Platforms

Android logo iOS logo Windows logo Windows logo iOS logo
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:

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

// 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 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! ⭐ 🎉 🚀 ⭐

cordova-plugin-native-spinner's People

Contributors

paldom avatar greybax avatar javierclavei avatar filiphsps avatar andreszs avatar rgfpy avatar eddyverbruggen avatar jsnee avatar misterkanister avatar ravi013 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.