Skip to content

Latest commit

 

History

History
155 lines (100 loc) · 3.82 KB

README.md

File metadata and controls

155 lines (100 loc) · 3.82 KB
Raw

@react-native-community/progress-view

Build Status Version Supports iOS MIT License Lean Core Badge

ProgressBar Component for iOS, based on UIProgressView.

Getting started

$ npm install @react-native-community/progress-view --save

or

$ yarn add @react-native-community/progress-view

Linking

  • React Native 0.60+

The package is automatically linked when building the app. All you need to do is:

$ cd ios && pod install
  • React Native <= 0.59

Run the following commands

$ react-native link @react-native-community/progress-view

Manual installation

Manually linking the library - iOS
  1. In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
  2. Go to node_modules ➜ @react-native-community/progress-view and add RNCProgressView.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNCProgressView.a to your project's Build Phases ➜ Link Binary With Libraries
  4. Run your project (Cmd+R)

Usage

import {ProgressView} from "@react-native-community/progress-view";

Reference

Props

Reference

Props

progress

The progress value (between 0 and 1).

Type Required
number No

progressImage

A stretchable image to display as the progress bar.

Type Required
Image.propTypes.source No

progressTintColor

The tint color of the progress bar itself.

Type Required
string No

progressViewStyle

The progress bar style.

Type Required
enum('default', 'bar') No

trackImage

A stretchable image to display behind the progress bar.

Type Required
Image.propTypes.source No

trackTintColor

The tint color of the progress bar track.

Type Required
string No

Contributors

License

The library is released under the MIT license. For more information see LICENSE.