adapty-ui/com.adapty.kmp.ui/AdaptyUIOnboardingPlatformView

AdaptyUIOnboardingPlatformView

fun AdaptyUIOnboardingPlatformView(onboarding: AdaptyOnboarding, modifier: Modifier = Modifier, externalUrlsPresentation: AdaptyWebPresentation = AdaptyWebPresentation.IN_APP_BROWSER, onDidFinishLoading: (meta: AdaptyUIOnboardingMeta) -> Unit = {}, onDidFailWithError: (error: AdaptyError) -> Unit = {}, onCloseAction: (meta: AdaptyUIOnboardingMeta, actionId: String) -> Unit = { _, _ -> }, onPaywallAction: (meta: AdaptyUIOnboardingMeta, actionId: String) -> Unit = { _, _ -> }, onCustomAction: (meta: AdaptyUIOnboardingMeta, actionId: String) -> Unit = { _, _ -> }, onStateUpdatedAction: (meta: AdaptyUIOnboardingMeta, elementId: String, params: AdaptyOnboardingsStateUpdatedParams) -> Unit = { _, _, _ -> }, onAnalyticsEvent: (meta: AdaptyUIOnboardingMeta, event: AdaptyOnboardingsAnalyticsEvent) -> Unit = { _, _ -> })

Displays an embedded onboarding as a platform view in your Compose UI hierarchy.

This Composable allows you to embed an onboarding directly in your UI rather than presenting it as a full-screen modal. It provides inline callbacks for various events, such as loading completion, errors, user actions, state updates, and analytics.

Parameters

onboarding

The onboarding instance to display.

externalUrlsPresentation

Defines where the web should be opened. Defaults to AdaptyWebPresentation.IN_APP_BROWSER.

modifier

Optional Modifier for styling and layout.

onDidFinishLoading

Callback invoked when the onboarding finishes loading successfully.

onDidFailWithError

Callback invoked when the onboarding fails to load.

onCloseAction

Callback invoked when a close action is triggered by the user.

onPaywallAction

Callback invoked when a paywall action is triggered by the user.

onCustomAction

Callback invoked when a custom action is triggered by the user.

onStateUpdatedAction

Callback invoked when the state of an onboarding element is updated.

onAnalyticsEvent

Callback invoked when an analytics event occurs within the onboarding.