# @wz-mobile/rn-exclude-system-gesture-area

> 🔧 Provide component to exclude component area from navigation system gesture.

Latest version **1.0.0** (published 2022-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wz-mobile/rn-exclude-system-gesture-area
pnpm add @wz-mobile/rn-exclude-system-gesture-area
yarn add @wz-mobile/rn-exclude-system-gesture-area
bun add @wz-mobile/rn-exclude-system-gesture-area
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-31 |
| First published | 2022-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 87 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jérémy Barbe |
| Maintainers | winzana-apps |
| Keywords | react-native, ios, android, gesture, system, navigation |

## Links

- npm: https://www.npmjs.com/package/@wz-mobile/rn-exclude-system-gesture-area
- Repository: https://github.com/Winzana/rn-exclude-system-gesture-area
- Homepage: https://github.com/Winzana/rn-exclude-system-gesture-area#readme
- Issues: https://github.com/Winzana/rn-exclude-system-gesture-area/issues
- npm.io page: https://npm.io/package/@wz-mobile/rn-exclude-system-gesture-area

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-10-31

## README

![banner](./banner.png)

Provide component excluding component area from the android native navigation system gesture.

# Why another component ?

With newest versions of android (10+), users can select navigation with gestures. For example on the latest pixel navigation gestures are set by default.

It comes up with few problems concerning gestures. The android navigation gesture take the ascendant over any other gesture.
And sometimes you would need to override this behavior, in that case you have to use `systemGestureExclusionRects` from the android sdk.
That's exactly what this library does. The component provided wrap your component and add a system gesture exclusion area around your
component.

| ⚠️ Be careful overriding the behavior, make sure that's what you want to do before. Until you really need it Navigation Gesture must be always the priority ! |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- |

## Installation

```sh
yarn add @wz-mobile/exclude-system-gesture-area
```

## Usage

```js
import { ExcludeSystemGestureAreaView } from '@wz-mobile/exclude-system-gesture-area';

// ...

<ExcludeSystemGestureAreaView>
  <YourComponent />
</ExcludeSystemGestureAreaView>;
```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

---
_Source: https://npm.io/package/@wz-mobile/rn-exclude-system-gesture-area · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._