microblink-ux/com.microblink.ux/UiSettings

UiSettings

data class UiSettings(val typography: UiTypography? = null, val colorScheme: ColorScheme? = null, val uiColors: UiColors? = null, val sdkStrings: SdkStrings? = null, val showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, val showHelpButton: Boolean = DefaultShowHelpButton)

Configuration settings for the scanning UI.

Allows customization of various aspects of the UI used during the scanning process, such as typography, color schemes, reticle colors, string resources, and dialogs.

Constructors

Link copied to clipboard
constructor(typography: UiTypography? = null, colorScheme: ColorScheme? = null, uiColors: UiColors? = null, sdkStrings: SdkStrings? = null, showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, showHelpButton: Boolean = DefaultShowHelpButton)

Properties

Link copied to clipboard
val colorScheme: ColorScheme? = null

The ColorScheme to be used in the scanning UI. If left null, the theme will be applied based on the device settings (dark or light mode). Setting this value will overwrite the default behavior and the user will be responsible for handling theming based on device settings. Defaults to null.

Link copied to clipboard
val sdkStrings: SdkStrings? = null

The SdkStrings containing text strings for the scanning UI, such as scanning strings and help dialog strings. Defaults to com.microblink.ux.theme.SdkStrings.Default.

Link copied to clipboard
val showHelpButton: Boolean

A boolean indicating whether to show a help button and enable help screens during the scanning session. Defaults to DefaultShowHelpButton.

Link copied to clipboard
val showOnboardingDialog: Boolean

A boolean indicating whether to show an onboarding dialog at the beginning of the scanning session. Defaults to DefaultShowOnboardingDialog.

Link copied to clipboard
val typography: UiTypography? = null

The Typography to be used in the scanning UI. Defaults to com.microblink.ux.theme.UiTypography which uses default OS font. Defaults to null.

Link copied to clipboard
val uiColors: UiColors? = null

The UiColors to be used for graphical elements of scanning the UI. If left null, the theme will be applied based on the device settings (dark or light mode). Setting this value will overwrite the default behavior and the user will be responsible for handling theming based on device settings. Defaults to null.