Props

placementId

Type: string Required

The placement ID from your Begynn dashboard. This identifies which onboarding flow to load.


<BegynnOnboarding placementId="onboarding-main" />

isPreview

Type: boolean Default: false

Enable preview mode to test your onboarding without being locked on a variant and impacting A/B test quotas.

Use this during development to iterate on your onboarding without affecting production metrics.


<BegynnOnboarding placementId="onboarding-main" isPreview />

baseUrl

Type: string Default: https://begynn.com

Custom base URL for self-hosted Begynn instances.


<BegynnOnboarding
  placementId="onboarding-main"
  baseUrl="https://custom.begynn.com"
/>

containerStyle

Type: ViewStyle

Style object applied to the container View wrapping the WebView.


<BegynnOnboarding
  placementId="onboarding-main"
  containerStyle={{ flex: 1, backgroundColor: "#fff" }}
/>

webViewProps

Type: WebViewProps

Additional props passed directly to the underlying WebView component.


<BegynnOnboarding
  placementId="onboarding-main"
  webViewProps={{
    bounces: false,
    scrollEnabled: false,
  }}
/>

renderLoading

Type: () => ReactElement

Custom component to render while the onboarding is loading.


import { ActivityIndicator, View } from "react-native";
 
<BegynnOnboarding
  placementId="onboarding-main"
  renderLoading={() => (
    <View style={{ flex: 1, justifyContent: "center", alignItems: "center" }}>
      <ActivityIndicator size="large" />
    </View>
  )}
/>

debug

Type: boolean Default: false

Enable debug logging to the console for troubleshooting.


<BegynnOnboarding
  placementId="onboarding-main"
  debug={__DEV__}
/>