npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

react-native-progress-display

1.0.1 • Public • Published

react-native-progress-display

Platform License

react-native-progress-display is a Native Module for react-native that uses SVProgressHUD on iOS and KProgressHUD on Android.

Getting started

$ npm install react-native-progress-display --save

Mostly automatic installation

$ react-native link react-native-progress-display

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-progress-display and add RNProgressHud.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNProgressHud.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.rnprogresshud.RNProgressHudPackage; to the imports at the top of the file
  • Add new RNProgressHudPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-progress-display'
    project(':react-native-progress-display').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-progress-display/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-progress-display')
    

iOS Dependency Installation:

Important: This package depends on SVProgressHUD library. Please make sure you also install SVProgressHUD

  1. Go to https://github.com/SVProgressHUD/SVProgressHUD
  2. Follow the installation instructions and install before trying to run your project with the react-native-progress-display package installed.

Usage

import RNProgressHud from 'react-native-progress-display';

Showing a loading spinner with message:

// Where you want to display the spinner
RNProgressHud.showWithStatus("Loading...");

Showing a loading spinner with message and mask type:

// To use one of the pre-defined styles for background color:
const ProgressHUDMaskType = RNProgressHud.ProgressHUDMaskType;
RNProgressHud.showWithStatus("Loading...", ProgressHUDMaskType.Clear);

Show circular progress view:

// Input progress parameter must be a double or float with a range of 0.0 to 1.0 representing 0% and 100%.
// This will not automatically dismiss spinner unless progress reaches 100%. Otherwise, dismiss() must be called explicitly.
 
RNProgressHud.showProgressWithStatus(0.25, "Downloading data...");

Dismiss:

RNProgressHud.dismiss();

Dismiss with a delay (in seconds):

RNProgressHud.dismissWithDelay(1.0); // Dismisses after one second.

install

npm i react-native-progress-display

Downloadsweekly downloads

28

version

1.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability