React Native MaskedView

[![Build Status][build-badge]][build]
[![Version][version-badge]][package]
[![MIT License][license-badge]][license]
[![Lean Core Badge][lean-core-badge]][lean-core-issue]

Provides a React component that renders a masked view.

Platforms Supported

- [x] iOS
- [x] Android
- [ ] Web

Getting Started

``sh
yarn add @react-native-masked-view/masked-view
`

or

`sh
npm install --save @react-native-masked-view/masked-view
`

$3

Linking the package manually is not required anymore with Autolinking.

Remember to install the pod with:

`sh
npx pod-install
`

$3

You then need to link the native parts of the library for the platforms you are using. The easiest way to link the library is using the CLI tool by running this command from the root of your project:

`sh
react-native link @react-native-masked-view/masked-view
`

Usage

Import the MaskedView component from @react-native-masked-view/masked-view and use it like so:

`jsx
import React from 'react';
import { Text, View } from 'react-native';
import MaskedView from '@react-native-masked-view/masked-view';

const App = () => {
return (
style={{ flex: 1, flexDirection: 'row', height: '100%' }}
maskElement={
style={{
// Transparent background because mask is based off alpha channel.
backgroundColor: 'transparent',
flex: 1,
justifyContent: 'center',
alignItems: 'center',
}}
>
style={{
fontSize: 60,
color: 'black',
fontWeight: 'bold',
}}
>
Basic Mask


}
>
{/ Shows behind the mask, you can put anything here, such as an image /}





);
}

export default App
`

The following image demonstrates that you can put almost anything behind the mask. The three examples shown are masked , , and .

$3

- View props...

- maskElement

- androidRenderingMode

$3

$3

| Type | Required |
| ------- | -------- |
| element | Yes |

$3

By default hardware rendering mode will be used for best performance, however if you need to animate your maskElement then you’ll need to switch to software to get your mask to update. This prop only affects Android.

| Type | Required | Default |
| ---------------------- | -------- | ---------- |
| software, hardware | No | hardware` |

[build-badge]: https://github.com/react-native-masked-view/masked-view/workflows/Build/badge.svg
[build]: https://github.com/react-native-masked-view/masked-view/actions
[version-badge]: https://img.shields.io/npm/v/@react-native-masked-view/masked-view.svg?style=flat-square
[package]: https://www.npmjs.com/package/@react-native-masked-view/masked-view
[license-badge]: https://img.shields.io/npm/l/@react-native-masked-view/masked-view.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square
[lean-core-issue]: https://github.com/facebook/react-native/issues/23313