react-native-zoomable-box/README.md

A simple Zoomable box using react-native-gesture-handler. Compatible with react-native v0.60

# ZoomableBox

ZoomableBox is a react Component that makes it's children zoomable

## IMPORTANT!

Before anything make sure you have react-native-gesture-handler on your project.

You can it by following [here](https://kmagiera.github.io/react-native-gesture-handler/docs/getting-started.html#installation)

## Installation

```bash
yarn add react-native-zoomable-box
```

or

```bash
npm install --save react-native-zoomable-box
```

## Usage

```javascript
<ZoomableBox style={{ flex: 1 }}>
  <View style={{ backgroundColor: "red", flex: 1, alignItems: "center", justifyContent: "center" }}>
    <Text style={{ color: "white", fontSize: 20 }}>Zoomable Box</Text>
  </View>
</ZoomableBox>
```

## Props

Non of props are required.

| Parameter              | Type    | Default        |
| ---------------------- | ------- | -------------- |
| style                  | object  | ****\_\_\_**** |
| backToDefault          | boolean | true           |
| swipeCompleteDirection | string  | 'y'            |
| swipeThreshold         | number  | 100            |
| doubleTapScale         | number  | 4              |
| maxScale               | number  | 4              |
| doubleTap              | boolean | false          |
| animationTiming        | number  | 250            |
| maxDoubleTapDist       | number  | 25             |

## Events

| Parameter       | params                                                                                                       |
| --------------- | ------------------------------------------------------------------------------------------------------------ |
| backHandler     | ({ translateX, translateY, scale }) => ...                                                                   |
| onSwipeComplete | ({ translateX, translateY, scale, translationX, translationY, velocityY, velocityX, swipeDirection }) => ... |

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.