IncdOnboarding SDK Customization guide
IncdOnboarding SDK Customization guide
IncdOnboarding SDK enables you to customize the default provided theme - you can easily change colors, fonts, logo, videos and texts.
Change the Theme
Please follow the guide for IncdTheme
Change the logo
We support the ability for you to use your own logo image which is shown on some of the onboarding screens.
To achieve this, name your image “incdOnboardingLogo” and place it in your app’s asset catalog (usually called “Assets.xcassets”).
For best results, use an image with a size of around 190 × 34.
The logo can also be changed dynamically by assigning a UIImage to the global variable IncdTheme.logo
.
Hide the logo
To hide the logo shown on some screens please create a completely white 190x34 image, name it “incdOnboardingLogo” and place it in your app’s asset catalog (usually called “Assets.xcassets”).
The logo can also be hidden by assigning an empty UIImage to the global variable IncdTheme.logo
.
Module Specific logos
Face capture module, including login, can use a custom logo to display during face capture step. Use customLogo
parameter when calling addSelfieScan
and startFaceLogin
respectively.
VideoSelfie module can display a custom logo on all steps of capture. Use setLogo(UIImage(named: "LogoName"))
from VideoSelfieConfiguration before calling addVideoSelfie(videoSelfieConfiguration: videoSelfieConfiguration)
.
Change tutorial videos
We support the option of using your own videos that are displayed as tutorials before ID and Selfie scan.
The supported animation format is Lottie JSON, and to apply your own videos, they need to be named in the following way:
tutorial_front.json
for changing ID front tutorial videotutorial_back.json
for changing ID back tutorial videotutorial_passport.json
for changing Passport tutorial videotutorial_selfie.json
for changing Selfie tutorial video- 'tutorial_videoSelfie.json' for changing Video Selfie tutorial video
- 'tutorial_qr.json' for changing QR tutorial video
Updated 7 months ago