Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kwaak/react-native-android-circles

A react native android package to show a circle progress view
https://github.com/kwaak/react-native-android-circles

Last synced: 6 days ago
JSON representation

A react native android package to show a circle progress view

Awesome Lists containing this project

README 

        
# Circle progress view for react-native android



[![npm](https://img.shields.io/npm/v/react-native-android-circles.svg)](https://www.npmjs.com/package/react-native-android-circles)



A react native android module to show a circle progress view based on [Circle-Progress-View] (https://github.com/jakob-grabner/Circle-Progress-View).



## Setup



* install module



```bash

 npm i --save react-native-android-circles

```



* `android/build.gradle`



```gradle

...

allprojects {

    ...

    repositories {

      ...

      maven { url "https://jitpack.io" }

    }

    ...



}

```



* `android/settings.gradle`



```gradle

...

include ':react-native-android-circles'

project(':react-native-android-circles').projectDir = new File(settingsDir, '../node_modules/react-native-android-circles')

```



* `android/app/build.gradle`



```gradle

...

dependencies {

    ...

    compile project(':react-native-android-circles')

}

```



* register module (in MainActivity.java)



```java

import com.kwaak.reacttwo.CirclesPackage;  // <--- import



public class MainActivity extends Activity implements DefaultHardwareBackBtnHandler {



  ......

  private static Activity mActivity = null;



  @Override

  protected void onCreate(Bundle savedInstanceState) {

    super.onCreate(savedInstanceState);

    mReactRootView = new ReactRootView(this);



    mActivity = this;

    mReactInstanceManager = ReactInstanceManager.builder()

      .setApplication(getApplication())

      .setBundleAssetName("index.android.bundle")

      .setJSMainModuleName("index.android")

      .addPackage(new MainReactPackage())

      .addPackage(new CirclesPackage())      // <------- add package

      .setUseDeveloperSupport(BuildConfig.DEBUG)

      .setInitialLifecycleState(LifecycleState.RESUMED)

      .build();



    mReactRootView.startReactApplication(mReactInstanceManager, "ExampleRN", null);



    setContentView(mReactRootView);

  }



  ......



}

```



## Usage



```js

var Circles = require('react-native-android-circles');



  



```



## Available props & methods



### Props



```

  barColors: PropTypes.array,

  barWidth: PropTypes.number,

  blockCount: PropTypes.number,

  blockScale: PropTypes.number,

  contourColor: PropTypes.string,

  textColor: PropTypes.string,

  contourSize: PropTypes.number,

  delayMillis: PropTypes.number,

  fillColor: PropTypes.string,

  value: PropTypes.number,

  maxValue: PropTypes.number,

  rimColor: PropTypes.string,

  rimWidth: PropTypes.number,

  spinSpeed: PropTypes.number,

  startAngle: PropTypes.number,

  textScale: PropTypes.number,

  textSize: PropTypes.number,

  unit: PropTypes.string,

  unitVisible: PropTypes.bool,

  unitColor: PropTypes.string,

  unitScale: PropTypes.number,

  unitSize: PropTypes.number,

  animated:  PropTypes.bool,

  text: PropTypes.string,

  textMode: PropTypes.oneOf(['text', 'value', 'percent']),

```



### Methods



```

  .spin()

  .stopSpinning()

```