# react-native-bpk-component-touchable-overlay

> Backpack React Native touchable overlay component.

Latest version **3.0.1** (published 2020-02-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install react-native-bpk-component-touchable-overlay
pnpm add react-native-bpk-component-touchable-overlay
yarn add react-native-bpk-component-touchable-overlay
bun add react-native-bpk-component-touchable-overlay
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2020-02-26 |
| First published | 2017-11-16 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 37.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 543 |
| Author | Backpack Design System |
| Maintainers | georgegillams, k0nserv, mattface, ojcurt, shaundon, tiagohngl |

## Links

- npm: https://www.npmjs.com/package/react-native-bpk-component-touchable-overlay
- Repository: https://github.com/Skyscanner/backpack
- Homepage: https://github.com/Skyscanner/backpack#readme
- Issues: https://github.com/Skyscanner/backpack/issues
- npm.io page: https://npm.io/package/react-native-bpk-component-touchable-overlay

## Dependencies (2)

- [bpk-tokens](https://npm.io/package/bpk-tokens.md) ^32.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8

## Recent versions

- 3.0.1 (latest) — 2020-02-26
- 2.1.4-alpha.1 (canary) — 2019-12-03
- 3.0.0 — 2020-02-19
- 2.1.11 — 2020-02-13
- 2.1.10 — 2020-01-30
- 2.1.9 — 2020-01-22
- 2.1.8 — 2020-01-20
- 2.1.7 — 2019-12-17
- 2.1.6 — 2019-12-12
- 2.1.5 — 2019-12-06
- 2.1.4 — 2019-12-04
- 2.1.3 — 2019-11-29
- 2.1.2 — 2019-11-28
- 2.1.1 — 2019-11-26
- 2.1.0 — 2019-11-14
- … 82 more at https://npm.io/package/react-native-bpk-component-touchable-overlay/versions

## README

# react-native-bpk-component-touchable-overlay

> Backpack React Native touchable overlay component.

## Installation

```sh
npm install react-native-bpk-component-touchable-overlay --save-dev
```

## Usage

```js
import React, { Component } from 'react';
import { View, StyleSheet } from 'react-native';
import BpkText from 'react-native-bpk-component-text';
import { spacingBase } from 'bpk-tokens/tokens/base.react.native';
import BpkTouchableOverlay from 'react-native-bpk-component-touchable-overlay';

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    padding: spacingBase,
  }
});

export default class App extends Component {
  render() {
    return (
      <View style={styles.container}>
        <BpkTouchableOverlay
          onPress={() => null}
          accessibilityLabel="Example touchable overlay"
        >
          <BpkText>
            Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean
            commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus
            et magnis dis parturient montes, nascetur ridiculus mus.
          </BpkText>
        </BpkTouchableOverlay>
      </View>
    );
  }
}
```

## Props

| Property     | PropType                  | Required | Default Value |
| ------------ | ------------------------- | -------- | ------------- |
| children     | node                      | true     | -             |
| borderRadius | oneOf('sm', 'lg', 'pill') | false    | null          |
| overlayStyle | object                    | false    | null          |

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