Ref Methods

Access imperative methods using a ref.

BegynnOnboardingRef


interface BegynnOnboardingRef {
  reload(): void;
}

Usage


import { useRef } from "react";
import { BegynnOnboarding, BegynnOnboardingRef } from "@begynn/react-native";
 
function OnboardingScreen() {
  const ref = useRef<BegynnOnboardingRef>(null);
 
  const handleReload = () => {
    ref.current?.reload();
  };
 
  return (
    <BegynnOnboarding
      ref={ref}
      placementId="your-placement-id"
    />
  );
}

Methods

reload()

Reloads the onboarding WebView. Useful for:

Restarting the onboarding after an error
Allowing users to restart after exiting
Refreshing content during development


const handleExit = (event: OnboardingExitEvent) => {
  Alert.alert(
    "Exit Onboarding?",
    `You're ${event.progress_percentage}% done.`,
    [
      { text: "Continue", onPress: () => ref.current?.reload() },
      { text: "Exit", onPress: onFinish },
    ],
  );
};