Skip to main content
The RampKit Expo SDK displays onboarding flows you build in the RampKit dashboard. Design your onboarding in the editor, then show it with one line of code.

​
Quick Start

1

Install

npx expo install rampkit-expo-dev react-native-webview react-native-pager-view react-native-root-siblings
2

Initialize

import { RampKit } from "rampkit-expo-dev";

await RampKit.init({
  appId: "YOUR_APP_ID",
  onOnboardingFinished: () => {
    navigation.replace("Home");
  },
});
3

Show Onboarding

RampKit.showOnboarding();

​
That’s It

Everything else—screens, navigation, animations, haptics, variables, personalization—is configured in the RampKit editor. The SDK just displays what you build.

​
Configuration Options

await RampKit.init({
  appId: "YOUR_APP_ID",
  autoShowOnboarding: true,  // Auto-show after init
  onOnboardingFinished: (payload) => {
    // User completed onboarding
  },
  onShowPaywall: (payload) => {
    // Onboarding triggered a paywall
  },
});

​
API

MethodDescription
RampKit.init(config)Initialize the SDK
RampKit.showOnboarding()Show the onboarding
RampKit.closeOnboarding()Close the onboarding
RampKit.isInitialized()Check if ready
RampKit.getUserId()Get the user ID

​
Platform Support

PlatformVersion
iOS13.0+
AndroidAPI 21+
Expo SDK49.0.0+