Installation

Install the package using your preferred package manager.

bash
npm install @apliko/react-native-deep-link
# or
yarn add @apliko/react-native-deep-link

No additional native module installation is needed. This SDK uses React Native's built-in Linking API, making it compatible with any version.

Quick Start

Mandatory

You must initialize DeepLinkManager as early as possible (e.g., in your index.js or app entry file) with your API key. Without this, deep link handling will not work.

typescript
// index.js (or index.ts)
import { DeepLinkManager } from '@apliko/react-native-deep-link';
import App from './App';

// Initialize immediately with your API key
DeepLinkManager.init({ apiKey: "your-api-key" });

Need an API Key?

To get started, you'll need an API key. Contact us to get onboarded and receive your key.

Contact Us to Get Your Key →