BegynnOnboarding

The main component for embedding Begynn onboarding flows.

Import

import { BegynnOnboarding } from "@begynn/react-native";

Basic Usage

<BegynnOnboarding
  placementId="your-placement-id"
  onComplete={(event) => {
    console.log("Completed!", event.payload);
  }}
/>

How It Works

BegynnOnboarding renders a WebView that loads your onboarding flow from Begynn’s servers. The component:

1. Generates (or retrieves) a persistent user ID via AsyncStorage
2. Loads the onboarding content for your placement
3. Handles communication between the WebView and your React Native app
4. Dispatches events as users interact with the onboarding

Props Overview

See Props for detailed documentation.

Event Handlers

See Events for detailed documentation.