# react-native-easy-gestures

> React Native Gestures. Support: Drag, Scale and Rotate a Component.

Latest version **2.2.4** (published 2018-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-easy-gestures
pnpm add react-native-easy-gestures
yarn add react-native-easy-gestures
bun add react-native-easy-gestures
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.4 |
| Published | 2018-11-21 |
| First published | 2017-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 217.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 170 |
| Author | Andrey Keske |
| Maintainers | andreykeske |
| Keywords | react, native, gestures, drag, scale, rotate |

## Links

- npm: https://www.npmjs.com/package/react-native-easy-gestures
- Repository: https://github.com/keske/react-native-easy-gestures
- Homepage: https://github.com/keske/react-native-easy-gestures#readme
- Issues: https://github.com/keske/react-native-easy-gestures/issues
- npm.io page: https://npm.io/package/react-native-easy-gestures

## Dependencies (2)

- [ramda](https://npm.io/package/ramda.md) ^0.26.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.2.4 (latest) — 2018-11-21
- 2.2.3 — 2018-11-20
- 2.2.2 — 2018-11-20
- 2.2.1 — 2018-11-20
- 2.1.2 — 2018-07-27
- 2.1.1 — 2018-07-27
- 2.1.0 — 2018-07-27
- 2.0.5 — 2017-12-10
- 2.0.4 — 2017-11-27
- 2.0.3 — 2017-11-19
- 2.0.2 — 2017-11-12
- 2.0.1 — 2017-11-12
- 1.0.6 — 2017-05-29
- 1.0.5 — 2017-05-28
- 1.0.4 — 2017-05-13
- … 7 more at https://npm.io/package/react-native-easy-gestures/versions

## README

# React Native Easy Gestures

React Native Gestures. Support: Drag, Scale and Rotate a Component.

![example](https://raw.githubusercontent.com/keske/react-native-easy-gestures/master/static/gestures.gif)

## Instalation

### RN > 0.46 👶

```
$ npm install --save react-native-easy-gestures
```

### RN < 0.46 👴

```
$ npm install --save react-native-easy-gestures@1.0.x
```

## Usage

```javascript
import Gestures from 'react-native-easy-gestures';

/* Simple example: */
<Gestures>
  <Image
    source={photo}
    style={{
      width: 200,
      height: 300,
    }}
  />
</Gestures>

/* Only drag example witn `onChange` event: */
<Gestures
  rotatable={false}
  scalable={false}
  onChange={(event, styles) => {
    console.log(styles);
  }}
>
  <Image
    source={photo}
    style={{
      width: 200,
      height: 300,
    }}
  />
</Gestures>

/**
 * Another example:
 * Drag only on x axis;
 * Scale from 0.1 to 7;
 * Do not rotate;
 * On release callback;
 */
<Gestures
  draggable={{
    y: false,
  }}
  scalable={{
    min: 0.1,
    max: 7,
  }}
  rotatable={false}
  onEnd={(event, styles) => {
    console.log(styles);
  }}
>
  <Image
    source={photo}
    style={{
      width,
      height,
    }}
  />
</Gestures>
```

## Props

### Behavior

```javascript
draggable?: boolean = true | object = { x?: boolean = true, y?: boolean = true }
```

```javascript
rotatable?: boolean = true
```

```javascript
scalable?: boolean = true | object = { min?: number = 0.33, max?: number = 2 }
```

### Styles

```javascript
style?: object // RN Styles
```

### Callbacks

```javascript
onStart?(event: object, styles: object): void
```

```javascript
onChange?(event: object, styles: object): void
```

```javascript
onEnd?(event: object, styles: object): void
```

```javascript
onMultyTouchStart?(event: object, styles: object): void
```

```javascript
onMultyTouchChange?(event: object, styles: object): void
```

```javascript
onMultyTouchEnd?(event: object, styles: object): void
```

```javascript
onRotateStart?(event: object, styles: object): void
```

```javascript
onRotateChange?(event: object, styles: object): void
```

```javascript
onRotateEnd?(event: object, styles: object): void
```

```javascript
onScaleStart?(event: object, styles: object): void
```

```javascript
onScaleChange?(event: object, styles: object): void
```

```javascript
onScaleEnd?(event: object, styles: object): void
```

### How to reset styles

```javascript
<Gestures
  ref={(c) => { this.gestures = c; }}
  onEnd={(event, styles) => {
    this.gestures.reset((prevStyles) => {
      console.log(prevStyles);
    });
  }}
```

# Development

```
$ git clone https://github.com/keske/react-native-easy-gestures.git
$ cd react-native-easy-gestures
$ npm install
$ react-native run-ios
```

# TODO

- [ ] Rotate step, ex: every 90deg
- [ ] Guidelines and center snap

---
_Source: https://npm.io/package/react-native-easy-gestures · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
