@locusvia/react-native-sdk
v0.1.3
Published
LocusVia React Native SDK — deep-link lifecycle provider for React Native and Expo
Readme
@locusvia/react-native-sdk
LocusVia deep-link lifecycle SDK for React Native and Expo.
LocusVia is a control plane for mobile deep-linking: resolve links, capture referral attribution, and recover deferred journeys — with zero PII in the edge path.
Install
npm install @locusvia/react-native-sdkRequires React Native >= 0.79 and React >= 18.0.0 as peer dependencies.
Quick start
Wrap your app in LocusViaProvider with your LocusVia configuration:
import { LocusViaProvider, useLocusVia } from "@locusvia/react-native-sdk";
<LocusViaProvider config={{ appID: "your-app-id", apiKey: "your-api-key", baseUrl: "https://your-domain.locusvia.com" }}>
<App />
</LocusViaProvider>;
function App() {
const { link, resolve } = useLocusVia();
// link: the most recent resolved link
// resolve(url): resolve a deep link on demand
}API
Provider and hooks
LocusViaProvider— provider component. Props:config(LocusViaConfig).useLocusVia— provider state and resolve action.useLinkContext— resolved link context.useLastLink— the most recently resolved link.useDeferredLink— deferred (post-install) link recovery state.
Client
createLocusViaClient(config)/LocusViaClient— headless client for non-React usage.LocusViaSdkError— typed SDK error.
Analytics
LocusViaAnalytics— send link and outcome events.LocusViaEventNames/LocusViaEventName— event name constants and types.
Expo Router
import { createNativeIntentHandler } from "@locusvia/react-native-sdk/expo-router";Storage
createMemoryStorage— in-memory storage (default).createAsyncStorageAdapter— persist link state via@react-native-async-storage/async-storage.
Types
Full TypeScript types ship with the package (dist/index.d.ts): LocusViaConfig,
LocusViaResolvedLink, LocusViaResolveResponse, LocusViaProviderState,
DeferredLinkState, LinkContextType, LinkSource, LinkType, NativeIntentArgs,
NativeIntentHandler, ReferralAttribution, and more.
License
Apache-2.0 — see LICENSE. Copyright 2026 LocusVia.
Links
- LocusVia docs — SDK onboarding, quickstart, migration guides.
- Replace Firebase Dynamic Links — migration guide.
