naoufal / react-native-progress-hud Goto Github PK

A clean and lightweight progress HUD for your React Native app.

Home Page: https://www.npmjs.com/package/react-native-progress-hud

JavaScript 100.00%

react-native-progress-hud's Introduction

React Native Progress HUD

React Native Progress HUD is a React Native port of the popular SVProgressHUD. It is a clean and easy-to-use HUD meant to display the progress of an ongoing task.

Are you using React? Check out React Progress HUD.

Install

npm i --save react-native-progress-hud

Usage

Using the HUD in your app will usually look like this:

var ProgressHUD = require('react-native-progress-hud');

var YourComponent = React.createClass({
  mixins: [ProgressHUD.Mixin],

  ...

  render() {
    return (
      <View>
        ...
        <ProgressHUD
          isVisible={this.state.is_hud_visible}
          isDismissible={true}
          overlayColor="rgba(0, 0, 0, 0.11)"
        />
      </View>
    );
  }

Showing the HUD

You can display the HUD by calling:

  this.showProgressHUD();

Dismissing the HUD

It can be dismissed by calling:

  this.dismissProgressHUD();

Child Components

From time to time, you may need to show the HUD from the a child component. Using the HUD from a child component will look like this:

var YourChildComponent = React.createClass({
  render() {
    contextTypes: {
      showProgressHUD: React.PropTypes.func,
      dismissProgressHUD: React.PropTypes.func
    },

    return (
      <View>
        ...
        <TouchableHighlight
          onPress={this.context.showProgressHUD}
        >
          Show Progress HUD
        </TouchableHighlight>
      </View>
    );
  }

Props

The following props can be used to modify the HUD's style and/or behaviour:

Prop	Type	Opt/Required	Default	Note
`isVisible`	Boolean	Required	`N/A`	Displays the HUD when set to true.
`isDismissible`	Boolean	Optional	`false`	When set to true, the HUD is dismissed on user interaction.
`overlayColor`	String	Optional	`rgba(0, 0, 0, 0)`	Sets the color of the overlay.
`color`	String	Optional	`#000`	Sets the color of the spinner.

License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

react-native-progress-hud's People

Contributors

Stargazers

Watchers

react-native-progress-hud's Issues

Context warnings

I am using this throughout my apps as well, but since I am using flux implementation and props driven UI manipulation - I do not use context at all (and actually somehow can't without hacks since I have ES6 classes). It would be cool to improve the current implementation to make mixin a complete opt-in, as it seems to work without it with no problems.

Ps. Since activity view already have one maintainer - gonna reserve this one if there's such need in the future 💃

  contextTypes: {
    showProgressHUD: React.PropTypes.func.isRequired,  // Remove isRequired here will solve it
    dismissProgressHUD: React.PropTypes.func
  },

The render function looks like this

render() {
  // Something else
        <ProgressHUD
          isVisible={this.props.hudVisible}
          isDismissible={false}
          overlayColor="rgba(0, 0, 0, 0.11)"
        />
}

What can I do here?

IntroView.getChildContext(): childContextTypes must be defined in order to use getChildContext().

Code:

const React = require('react-native');
const {
    Component,
    StyleSheet,
    Text,
    TextInput,
    TouchableHighlight,
    View,
    ScrollView,
    } = React;


const ProgressHUD = require('react-native-progress-hud');
const reactMixin = require('react-mixin');


class IntroView extends Component {
    constructor(props) {
        super(props);
        this.state = {
            is_hud_visible: false,
        };
    }

    componentDidMount(){

    }

    render(){
        return (
                <View style={ styles.container  }>
                    <View style={{flex:1}}>
                        <Text style={styles.welcome}>
                            Branding Text HERE
                        </Text>
                    </View>


                    <View style={ styles.welcome} >
                        <TouchableHighlight onPress={(this.onSubmitPressed.bind(this))} style={styles.btn}>
                            <Text style={styles.instructions}>Get Started</Text>
                        </TouchableHighlight>
                    </View>

                    <ProgressHUD
                        isVisible={this.state.is_hud_visible}
                        isDismissible={false}
                        overlayColor="rgba(0, 0, 0, 0.11)"
                        />

                </View>
        );
    }

    onSubmitPressed() {        
        this.showProgressHUD();
    }

}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  welcome: {
    margin: 10,
    fontSize: 20,
    fontWeight: '600',
    textAlign: 'center'
  },
  instructions: {
    marginBottom: 5,
    color: '#333333',
    fontSize: 13,
    textAlign: 'center'
  },
  btn: {
    borderRadius: 3,
    marginTop: 200,
    paddingTop: 15,
    paddingBottom: 15,
    paddingLeft: 15,
    paddingRight: 15,
    backgroundColor: '#0391D7',
  }
});

reactMixin(IntroView.prototype, ProgressHUD.Mixin);

module.exports = IntroView;

Not sure if this is a issue with the progress hud , would be nice if we can use this in es6 classes