Onboarding

Owned by Nadzeya Karaban
Jun 20, 2024
1 min read

The onboarding feature presents essential information to the user on how to best capture documents. You can customize the onboarding in the following ways:

  • Deactivate showing the onboarding at the first run
    By default, the onboarding is shown in the first run. To deactivate this, pass false to GiniConfiguration.shared.onboardingShowAtFirstLaunch.

  • Customize the onboarding pages
    If you wish to show different onboarding pages, pass a list of OnboardingPage structs to GiniConfiguration.shared.customOnboardingPages.

  • Force showing the onboarding
    If you wish to show the onboarding after the first run, pass true to GiniConfiguration.shared.onboardingShowAtLaunch.

  • Animate illustrations by injecting custom views
    If you need to animate the illustrations on the onboarding pages, implement the OnboardingIllustrationAdapter interface to inject a view that can animate images (for example, Lottie) and pass it to the relevant onboarding illustration adapter setters (for example, onboardingAlignCornersIllustrationAdapter,onboardingLightingIllustrationAdapter,onboardingMultiPageIllustrationAdapter,onboardingQRCodeIllustrationAdapter) when configuring the GiniConfiguration.shared instance.

For more information about UI customization, see Onboarding Screen.