https://github.com/sidneys/cordova-plugin-progressview
Cordova+PhoneGap Extension for displaying a native determinate progress dialog.
https://github.com/sidneys/cordova-plugin-progressview
Last synced: 3 months ago
JSON representation
Cordova+PhoneGap Extension for displaying a native determinate progress dialog.
- Host: GitHub
- URL: https://github.com/sidneys/cordova-plugin-progressview
- Owner: sidneys
- License: mit
- Created: 2014-11-22T14:11:36.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-05T07:51:10.000Z (almost 8 years ago)
- Last Synced: 2025-04-04T18:39:04.173Z (about 1 year ago)
- Language: Objective-C
- Size: 7.55 MB
- Stars: 7
- Watchers: 3
- Forks: 19
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cordova Progress View Plugin
=======================
Cordova+PhoneGap Extension for displaying a native determinate progress dialog.
=======================
# Contents
1. [Description](#description)
2. [Platforms](#platforms)
3. [Installation](#installation)
4. [Usage](#usage)
5. [API](#api)
=======================
## Description
Small Plugin for displaying a native progress dialog. Ideal for synchronous operations (downloading, zipping). Runnning on a background thread.
=======================
## Platforms
* iOS, 7.1.2+
* Android, 4.0.0+
=======================
## Installation
Via Cordova CLI:
```bash
cordova plugin add https://github.com/SidneyS/cordova-plugin-progressview.git
```
=======================
## Usage
1. Wait for `deviceReady`.
2. `show()` the native progress dialog.
2. Update progress via `setProgress()`.
3. `hide()` the native progress dialog.
=======================
## API
### show()
```javascript
ProgressView.show: function (progressLabel, progressType, progressTheme)
```
Shows a progress dialog.
* params
* progressLabel - Text description of current operation.
* progressType - Type of dialog - "CIRCLE" (Default), "HORIZONTAL"
* progressTheme - Visual Theme (Android only) - "DEVICE_LIGHT" (Default), "TRADITIONAL", "DEVICE_DARK", "HOLO_DARK", "HOLO_LIGHT"
### setProgress()
```javascript
ProgressView.setProgress: function (progressPercentage)
```
Updates displayed progress dialog percentage.
* params
* progressPercentage - Floating point value (0.1 - 1.0), representing the percentage to be displayed.
### hide()
```javascript
ProgressView.hide: function ()
```
Hides progress dialog.
* params
* progressPercentage - Floating point value (0.1 - 1.0), representing the percentage to be displayed.