React Native MaskedView

React Native MaskedView for iOS and Android.

Platforms Supported

• iOS
• Android

Note: React Native MaskedView is not currently supported by Expo unless you "eject".

Getting Started

$ yarn add @react-native-community/masked-view

or

$ npm install --save @react-native-community/masked-view

Using React Native >= 0.60

Linking the package manually is not required anymore with Autolinking.

• iOS Platform:

  $ cd ios && pod install

Using React Native < 0.60

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:

$ react-native link @react-native-community/masked-view

Usage

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

1import React from 'react';
2import { Text, View } from 'react-native';
3import MaskedView from '@react-native-community/masked-view';
4
5export default class App extends React.Component {
6  render() {
7    return (
8      <MaskedView
9        style={{ flex: 1, flexDirection: 'row', height: '100%' }}
10        maskElement={
11          <View
12            style={{
13              // Transparent background because mask is based off alpha channel.
14              backgroundColor: 'transparent',
15              flex: 1,
16              justifyContent: 'center',
17              alignItems: 'center'
18            }}
19          >
20            <Text
21              style={{
22                fontSize: 60,
23                color: 'black',
24                fontWeight: 'bold'
25              }}
26            >
27              Basic Mask
28            </Text>
29          </View>
30        }
31      >
32        {/* Shows behind the mask, you can put anything here, such as an image */}
33        <View style={{ flex: 1, height: '100%', backgroundColor: '#324376' }} />
34        <View style={{ flex: 1, height: '100%', backgroundColor: '#F5DD90' }} />
35        <View style={{ flex: 1, height: '100%', backgroundColor: '#F76C5E' }} />
36        <View style={{ flex: 1, height: '100%', backgroundColor: '#e1e1e1' }} />
37      </MaskedView>
38    );
39  }
40}

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

Props

• View props...

• maskElement

Reference

Props

maskElement

Type	Required
element	Yes