This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 52).

A library that provides a masked view.

@react-native-masked-view/masked-view provides a masked view that only displays the pixels that overlap with the view rendered in its mask element.

You can only have one of either @react-native-community/masked-view (deprecated) or @react-native-masked-view/masked-view installed in your project at any given time. React Navigation v6 and above requires @react-native-masked-view/masked-view, so you should use that package instead if you are using the latest version of React Navigation.

Android support for this library is experimental and you may encounter inconsistencies in behavior across platforms. Report issues you encounter to react-native-masked-view GitHub repository.

Installation

If you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions provided by the library's README or documentation.

Usage

See full documentation at react-native-masked-view/masked-view.