nativescript-loading-indicator-new
v2.1.0
Published
A NativeScript plugin for showing an overlayed loading indicator.
Downloads
2
Maintainers
Readme
nativescript-loading-indicator-new
Note: this plugin is not being actively maintained.
nativescript-loading-indicator-new is a plugin for NativeScript which overlays a loading indicator on the current page. Can be used, for example, to prevent the UI being interacted with while data is being fetched from an API, while informing the user that something is happening.
Under the hood, we use MBProgressHUD on iOS, and ProgressDialog on Android.
Installation
tns plugin add nativescript-loading-indicator-new
Example
var LoadingIndicator = require("nativescript-loading-indicator-new").LoadingIndicator;
// or with TypeScript:
// import {LoadingIndicator} from "nativescript-loading-indicator-new";
var loader = new LoadingIndicator();
// optional options
// android and ios have some platform specific options
var options = {
message: 'Loading...',
progress: 0.65,
android: {
indeterminate: true,
cancelable: false,
max: 100,
progressNumberFormat: "%1d/%2d",
progressPercentFormat: 0.53,
progressStyle: 1,
secondaryProgress: 1
},
ios: {
details: "Additional detail note!",
square: false,
margin: 10,
dimBackground: true,
color: "#4B9ED6",
mode: // see iOS specific options below
}
};
loader.show(options); // options is optional
// Do whatever it is you want to do while the loader is showing, then
loader.hide();
Options
- message:
string
Your message! - progress:
number
Set progress display
Android Specific
- Reference: http://developer.android.com/intl/zh-tw/reference/android/app/ProgressDialog.html
iOS Specific
- Reference: https://github.com/jdg/MBProgressHUD/blob/master/Demo/Classes/MBHudDemoViewController.m
Quick Mode
Reference:
MBProgressHUDModeDeterminate
MBProgressHUDModeAnnularDeterminate
MBProgressHUDModeDeterminateHorizontalBar
MBProgressHUDModeText
MBProgressHUDModeCustomView
- use with
customView: string
- local path to an image file
- use with