Cordova ProgressView

Cordova/PhoneGap extension for displaying a native, determinate progress dialog view. Uses MRProgress in iOS and native UI controls in Android.
sidneys3.0.11
platforms: ios,android
$ cordova plugin add de.neofonie.cordova.plugin.progressview

Cordova Progress View Plugin

Cordova+PhoneGap Extension for displaying a native determinate progress dialog.

Contents

  1. Description
  2. Platforms
  3. Installation
  4. Usage
  5. 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:

cordova plugin add https://github.com/SidneyS/cordova-plugin-progressview.git

Usage

  1. Wait for deviceReady.
  2. show() the native progress dialog.
  3. Update progress via setProgress().
  4. hide() the native progress dialog.

API

show()

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()

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()

ProgressView.hide: function ()

Hides progress dialog.

  • params
    • progressPercentage - Floating point value (0.1 - 1.0), representing the percentage to be displayed.