Customization guide

The Gini Capture SDK components can be customized either through the GiniConfiguration, the Localizable.string file or through the assets. Here you can find a complete guide with the reference to every customizable item.

• Generic components
• Camera screen
• Review screen
• Multipage Review screen
• Analysis screen
• Supported formats screen
• Open with tutorial screen
• Capturing tips screen
• Gallery album screen
• Onboarding screens
• Help screen

Supporting dark mode

Some background and text colors use the GiniColor type with which you can set colors for dark and light modes. Please make sure to set contrasting images to the background colors in your .xcassets for the Gini Vision Library images you override (e.g. onboardingPage1). The text colors should also be set in contrast to the background colors.

Generic components

GiniConfiguration.backgroundColor is deprecated in version 5.5.0. Use the screen specific background color instead e.g. GiniConfiguration.onboardingScreenBackgroundColor.

1. Navigation bar

• Tint color → GiniConfiguration.navigationBarTintColor
• Item tint color → GiniConfiguration.navigationBarItemTintColor
• Title color → GiniConfiguration.navigationBarTitleColor
• Item font → GiniConfiguration.navigationBarItemFont
• Title font → GiniConfiguration.navigationBarTitleFont

2. Notice

• Information background color → GiniConfiguration.noticeInformationBackgroundColor
• Information text color → GiniConfiguration.noticeInformationTextColor
• Error background → GiniConfiguration.noticeErrorBackgroundColor
• Error text color GiniConfiguration.noticeErrorTextColor

3. Tooltip

• Background color → GiniConfiguration.fileImportToolTipBackgroundColor
• Text color → GiniConfiguration.fileImportToolTipTextColor
• Close button color → GiniConfiguration.fileImportToolTipCloseButtonColor
• Text →
  • ginicapture.camera.fileImportTip localized string for file import tooltip
  • ginicapture.camera.qrCodeTip localized string for qr code tooltip
  • ginicapture.multipagereview.reorderContainerTooltipMessage localized string for reorder tooltip

4. Gini Capture font

• Font → GiniConfiguration.customFont

Camera screen

1. Navigation bar

• Title → ginicapture.navigationbar.camera.title localized string
• Close button
  • With image and title
    • Image → navigationCameraClose image asset
    • Title → ginicapture.navigationbar.camera.close localized string
  • With title only
    • Title → GiniConfiguration.navigationBarCameraTitleCloseButton
• Help button
  • Image → navigationCameraHelp image asset
  • Title → ginicapture.navigationbar.camera.help localized string

2. Camera preview

• Guides color → GiniConfiguration.cameraPreviewCornerGuidesColor
• Focus large image → cameraFocusLarge image asset
• Focus large small → cameraFocusSmall image asset
• Opaque view style (when tool tip is shown) → GiniConfiguration.toolTipOpaqueBackgroundStyle

3. Camera buttons container

• Capture button
  • Image → cameraCaptureButton image asset
• Import button
  • Image → documentImportButton image asset
• Captured images stack indicator color → GiniConfiguration.imagesStackIndicatorLabelTextcolor
• Flash toggle can be enabled through → GiniConfiguration.flashToggleEnabled
• Flash button
  • Image → flashOn image asset
  • Image → flashOff image asset

4. QR code popup

• Background color → GiniConfiguration.qrCodePopupBackgroundColor using GiniColor with dark mode and light mode colors
• Button color → GiniConfiguration.qrCodePopupButtonColor
• Text color → GiniConfiguration.qrCodePopupTextColor using GiniColor with dark mode and light mode colors
• Title → ginicapture.camera.qrCodeDetectedPopup.buttonTitle localized string
• Message → ginicapture.camera.qrCodeDetectedPopup.message localized string

Review screen

1. Navigation bar

• Title → ginicapture.navigationbar.review.title localized string
• Back button
  • With image and title
    • Image → navigationReviewBack image asset
    • Title → ginicapture.navigationbar.review.back localized string
  • With title only
    • Title → GiniConfiguration.navigationBarReviewTitleBackButton
• Next button
  • Image → navigationReviewContinue image asset
  • Title → ginicapture.navigationbar.review.continue localized string

2. Review top view

• Title → ginicapture.review.top localized string

3. Review bottom view

• Background color → GiniConfiguration.reviewBottomViewBackgroundColor
• Rotation button image → reviewRotateButton image asset
• Rotation message
  • Text → ginicapture.review.bottom localized string
  • Text color → GiniConfiguration.reviewTextBottomColor

Multipage Review screen

1. Navigation bar

• Back button
  • With image and title
    • Image → navigationReviewBack image asset
    • Title → ginicapture.navigationbar.review.back localized string
  • With title only
    • Title → GiniConfiguration.navigationBarReviewTitleBackButton
• Next button
  • Image → navigationReviewContinue image asset
  • Title → ginicapture.navigationbar.review.continue localized string

2. Main collection

• Opaque view style (when tool tip is shown) → GiniConfiguration.multipageToolTipOpaqueBackgroundStyle

3. Page item

• Page circle indicator color → GiniConfiguration.indicatorCircleColor using GiniColor with dark mode and light mode colors
• Page indicator color → GiniConfiguration.multipagePageIndicatorColor
• Page background color → GiniConfiguration.multipagePageBackgroundColor using GiniColor with dark mode and light mode colors
• Page selected indicator color → GiniConfiguration.multipagePageSelectedIndicatorColor
• Page draggable icon tint color → GiniConfiguration.multipageDraggableIconColor

4. Bottom container

• Background color → GiniConfiguration.multipagePagesContainerAndToolBarColor using GiniColor with dark mode and light mode colors
• Rotation button image → rotateImageIcon image asset
• Delete button image → trashIcon image asset

Analysis screen

1. Navigation bar

• Cancel button
  • With image and title
    • Image → navigationAnalysisBack image asset
    • Title → ginicapture.navigationbar.analysis.back localized string
  • With title only
    • Title → GiniConfiguration.navigationBarAnalysisTitleBackButton

2. PDF Information view

• Text color → GiniConfiguration.analysisPDFInformationTextColor
• Background color → GiniConfiguration.analysisPDFInformationBackgroundColor

3. Loading view

• Indicator color → GiniConfiguration.analysisLoadingIndicatorColor (Only with PDFs)
• Text → ginicapture.analysis.loadingText localized string

Supported formats screen

Navigation bar

• Back button
  • With image and title
    • Image → arrowBack image asset
    • Title → ginicapture.navigationbar.help.backToMenu localized string
  • With title only
    • Title → GiniConfiguration.navigationBarHelpScreenTitleBackToMenuButton

1. Supported format cells

• Supported formats icon color → GiniConfiguration.supportedFormatsIconColor
• Non supported formats icon color → GiniConfiguration.nonSupportedFormatsIconColor

Open with tutorial screen

Navigation bar

• Back button
  • With image and title
    • Image → arrowBack image asset
    • Title → ginicapture.navigationbar.help.backToMenu localized string
  • With title only
    • Title → GiniConfiguration.navigationBarHelpScreenTitleBackToMenuButton

1. Header

• Text → ginicapture.help.openWithTutorial.collectionHeader localized string

2. Open with steps

• App name → GiniConfiguration.openWithAppNameForTexts
• Step indicator color → GiniConfiguration.stepIndicatorColor
• Step 1
  • Title → ginicapture.help.openWithTutorial.step1.title localized string
  • Subtitle → ginicapture.help.openWithTutorial.step1.subtitle localized string
  • Image → openWithTutorialStep1 (German) and openWithTutorialStep1_en (English) image assets
• Step 2
  • Title → ginicapture.help.openWithTutorial.step2.title localized string
  • Subtitle → ginicapture.help.openWithTutorial.step2.subtitle localized string
  • Image → openWithTutorialStep2 (German) and openWithTutorialStep2_en (English) image assets
• Step 3
  • Title → ginicapture.help.openWithTutorial.step3.title localized string
  • Subtitle → ginicapture.help.openWithTutorial.step3.subtitle localized string
  • Image → openWithTutorialStep3 (German) and openWithTutorialStep3_en (English) image assets

Capturing tips screen

1. Capturing tip images

• Tip 1 image → captureSuggestion1 image asset
• Tip 2 image → captureSuggestion2 image asset
• Tip 3 image → captureSuggestion3 image asset
• Tip 4 image → captureSuggestion4 image asset
• Tip 5 image → captureSuggestion5 image asset

2. Go to camera button

• Background color → GiniConfiguration.noResultsBottomButtonColor

Gallery album screen

1. Selected image

• Selected item check color → GiniConfiguration.galleryPickerItemSelectedBackgroundCheckColor
• Background color → GiniConfiguration.galleryScreenBackgroundColor using GiniColor with dark mode and light mode colors

Onboarding screens

1. Background

• Background Color → GiniConfiguration.onboardingScreenBackgroundColor using GiniColor with dark mode and light mode colors

2. Image

• Page image → onboardingPage* image asset

3. Text

• Color → GiniConfiguration.onboardingTextColor using GiniColor with dark mode and light mode colors

4. Page indicator

• Color → GiniConfiguration.onboardingPageIndicatorColor using GiniColor with dark mode and light mode colors

5. Current page indicator

• Color → GiniConfiguration.onboardingCurrentPageIndicatorColor using GiniColor with dark mode and light mode colors
• Alpha → GiniConfiguration.onboardingCurrentPageIndicatorAlpha sets alpha to the GiniConfiguration.onboardingCurrentPageIndicatorColor

Help screen

1. Navigation bar

• Back button
  • With image and title
    • Image → navigationHelpBack image asset
    • Title → ginicapture.navigationbar.help.backToCamera localized string
  • With title only
    • Title → GiniConfiguration.navigationBarHelpMenuTitleBackToCameraButton

2. Table View Cells

• Background color → GiniConfiguration.helpScreenCellsBackgroundColor using GiniColor with dark mode and light mode colors

3. Background

• Background color → GiniConfiguration.helpScreenBackgroundColor using GiniColor with dark mode and light mode colors

4. Additional help menu items

• Custom help menu items → GiniConfiguration.customMenuItems an array of HelpMenuViewController.Item objects