react-native-material-ripple/readme.md

# react-native-material-ripple

Base component for touchable elements

![Example](https://cloud.githubusercontent.com/assets/2055622/23309410/a363975a-fabf-11e6-8cd8-b9c5cca76b63.gif)

## Installation

```bash
npm install --save react-native-material-ripple
```

## Usage

```javascript
import React, { Component } from 'react';
import { Text } from 'react-native';
import Ripple from 'react-native-material-ripple';

export default class Example extends Component {
  render() {
    return (
      <Ripple onPress={ () => null }>
        <Text>touch me</Text>
      </Ripple>
    );
  }
}
```

## Properties

* `rippleColor`                 - Ripple color (default: black)
* `rippleOpacity`               - Ripple opacity (default: 0.3)
* `rippleDuration`              - Ripple duration in ms (default: 400)
* `rippleSize`                  - Ripple size restriction (default: 0)
* `rippleContainerBorderRadius` - Ripple container border radius (default: 0)
* `rippleCentered`              - Ripple always starts from center (default: false)
* `disabled`                    - Ripple should ignore touches (default: false)
* `onPressIn`                   - Touch moved in or started callback
* `onPressOut`                  - Touch moved out or terminated callback
* `onPress`                     - Touch up inside bounds callback

## Example

```bash
git clone https://github.com/n4kz/react-native-material-ripple.git
cd react-native-material-ripple/example
npm install
react-native run-ios # or run-android
```

## Copyright and License

BSD License

Copyright 2017 Alexander Nazarov. All rights reserved.