Skip to main content
Version: Next

Android

Library that implements onboarding flow - a consequent flow of screens launched before going to the main screen (usually once - after signing in).

Getting Started​

  1. Define onboarding steps
class GetStartedOnboardingStep : OnboardingStep {

    private fun shouldBeShown(params: OnboardingStepParams): Boolean {
        return params.preferencesManager.isGetStartedCompleted.not()
    }

    override suspend fun getActivityIntent(
        context: Context,
        params: OnboardingStepParams,
    ): Intent? {
        if (!shouldBeShown(params)) {
            return null
        }

        return GetStartedActivity.getLauncherIntent(context)
    }

    override fun getAnalyticsName() = "Get started"
}
  1. Initialize HumaOnboardingManager:
HumaOnboardingManager.init(
    // list of onboarding steps
   onboardingSteps = listOf(GetStartedOnboardingStep()),
   // if true - onboarding will consist of [onboardingSteps], if false - onboarding will consist of default steps (described in readme) + [onboardingSteps] 
   overrideDefault = true
)
  1. Start OnboardingActivity:
startActivity(OnboardingActivity.getIntent(context))