# progress-hud

> React Native wrapper for SVProgressHUD library on iOS and KProgressHUD library on Android.

Latest version **1.3.2** (published 2022-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install progress-hud
pnpm add progress-hud
yarn add progress-hud
bun add progress-hud
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2022-07-14 |
| First published | 2019-05-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 70.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | bunhouth |
| Maintainers | bunhouth |
| Keywords | react-native, react-component, ios, android, mobile, loading-spinner, progress-hud, cocoapod |

## Links

- npm: https://www.npmjs.com/package/progress-hud
- Repository: https://github.com/bunhouth/react-native-progress-hud
- Issues: https://github.com/bunhouth/react-native-progress-hud/issues
- npm.io page: https://npm.io/package/progress-hud

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2022-07-14
- 1.3.1 — 2022-07-03
- 1.3.0 — 2021-12-30
- 1.2.0 — 2019-07-04
- 1.1.0 — 2019-06-22
- 1.0.4 — 2019-05-22
- 1.0.3 — 2019-05-22
- 1.0.2 — 2019-05-22
- 1.0.1 — 2019-05-22
- 1.0.0 — 2019-05-22

## README

# progress-hud

![Platform](https://img.shields.io/badge/platform-react--native%20%5Bios%20%26%20android%5D-blue.svg)

![License](https://img.shields.io/npm/l/express.svg)

  

`progress-hud` is a Native Module for react-native that uses [SVProgressHUD](https://github.com/SVProgressHUD/SVProgressHUD) on iOS and [KProgressHUD](https://github.com/Kaopiz/KProgressHUD) on Android.

  

## Getting started

`$ npm install progress-hud --save`

`$ yarn add progress-hud`

  

### Mostly automatic installation

__RN < 60 Only__

`$ react-native link progress-hud`

  

__NOTE__

- if RN < 0.60

`$ npm install progress-hud@1.1.0`

  

### Manual installation

#### iOS

1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`

2. Go to `node_modules` ➜ `progress-hud` and add `RNProgressHud.xcodeproj`

3. In XCode, in the project navigator, select your project. Add `libRNProgressHud.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`

4. Run your project (`Cmd+R`)<

  

#### Android

1. Open up `android/app/src/main/java/[...]/MainActivity.java`

- Add `import com.progresshud.RNProgressHudPackage;` to the imports at the top of the file

- Add `new RNProgressHudPackage()` to the list returned by the `getPackages()` method

2. Append the following lines to `android/settings.gradle`:

```

include ':progress-hud'

project(':progress-hud').projectDir = new File(rootProject.projectDir, '../node_modules/progress-hud/android')

```

3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:

```

implementation project(':progress-hud')

```

  

### 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 progress-hud package installed.

  

## Usage

```javascript

import  RNProgressHud  from  'progress-hud';

```

  

Showing a loading spinner with message:

```javascript

// Where you want to display the spinner

RNProgressHud.showWithStatus("Loading...");

```

  

Showing a loading spinner with message and mask type:

```javascript

// To use one of the pre-defined styles for background color:

const  ProgressHUDMaskType = RNProgressHud.ProgressHUDMaskType;

RNProgressHud.showWithStatus("Loading...", ProgressHUDMaskType.Clear);

```

  

Show circular progress view:

```javascript

// 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:

```javascript

RNProgressHud.dismiss();

```

  

Dismiss with a delay (in seconds):

```javascript

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

```

  
  

# Credit

[medlmobileenterprises](https://github.com/medlmobileenterprises/react-native-progress-display)

---
_Source: https://npm.io/package/progress-hud · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._