Giter Club home page Giter Club logo

networkactivityindicator's Introduction

NetworkActivityIndicator for iOS

Version 0.1.1

A Plugin for Apache Cordova by ohh2ahh.

  1. Description
  2. Installation
  3. Automatically (Command-line Interface)
  4. Usage
  5. License

1. Description

This plugin allows you to show and hide the statusbar's network activity indicator on iOS. You can even start multiple instances of NetworkActivityIndicator simultaneously. The plugin hides the network activity indicator when all instances are finished.

  • Ready for the Command-line Interface of Cordova / PhoneGap 3.0 and later

Supported Platforms

  • iOS

2. Installation

The Cordova CLI is the recommended way to install NetworkActivityIndicator, see The Command-line Interface. You can find the plugin on these registries:

Automatically (Command-line Interface)

Simply run this command to add the latest version of NetworkActivityIndicator from npm to your project:

$ cordova plugin add cordova-plugin-networkactivityindicator

Don't forget to prepare and compile your project:

$ cordova build

You don't have to reference the JavaScript in your index.html.

Alternatively you can install NetworkActivityIndicator from GitHub:

$ cordova plugin add https://github.com/ohh2ahh/NetworkActivityIndicator.git

3. Usage

// Show network activity indicator
NetworkActivityIndicator.show();

// Hide network activity indicator
NetworkActivityIndicator.hide();

If you need/want callbacks:

// Show network activity indicator
NetworkActivityIndicator.show(function(){
  // Success
}, function(error){
  // Error (when statusbar is hidden or indicator already shown)
});


// Hide network activity indicator
NetworkActivityIndicator.hide(function(){
  // Success
}, function(error){
  // Error (when statusbar is hidden or another instance of NetworkActivityIndicator is running)
});

Full example

// Show network activity indicator
NetworkActivityIndicator.show(function(){
  // Success
}, function(error){
  // Error (when statusbar is hidden or indicator already shown)
});


// Hide network activity indicator after 5 seconds
setTimeout(function() {
  NetworkActivityIndicator.hide(function(){
    // Success
  }, function(error){
    // Error (when statusbar is hidden or another instance of NetworkActivityIndicator is running)
  });
}, 5000);

4. License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

networkactivityindicator's People

Watchers

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