Skip to content

Gautham495/react-native-app-clip-overlay

react-native-app-clip-overlay

react-native-app-clip-overlay

A React Native TurboModule to open the iOS App Clip Overlay (SKOverlay) and prompt users to download your main app in a bare react native app (Expo coming soon & PRs welcomed!)

Important

  • This feature is iOS-only (App Clips are not supported on Android).
  • This library compiles in Simulator, but StoreKit functionality (review prompts, product pages, IAP) only works on a real iPhone device, since StoreKit doesn’t simulate App Store behavior in Simulator.

📷 Demo

Demo

Installation

npm install react-native-app-clip-overlay

or with Yarn:

yarn add react-native-app-clip-overlay

iOS Setup

  • Requires iOS 16.0+.
  • Will require setup of app-clip in your react-native app in XCode for using this library.
  • No additional setup is required if you are using autolinking.

Usage

import AppClipOverlay from 'react-native-app-clip-overlay';
import { Button } from 'react-native';

export default function App() {
  return (
    <Button
      title="Open App Clip"
      onPress={() => AppClipOverlay.presentOverlay('com.example.myapp.AppClip')}
    />
  );
}

API

AppClipOverlay.presentOverlay(appClipBundleId: string): void

  • appClipBundleId → The bundle identifier of your App Clip target (as defined in Xcode).

Guides


Android Instant Apps


Contributing

We welcome contributions!


License

MIT © Gautham Vijayan


Made with create-react-native-library