microblink-ux/com.microblink.ux

Package-level declarations

Types

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.

Properties

DefaultShowHelpButton

const val DefaultShowHelpButton: Boolean = true

DefaultShowOnboardingDialog

const val DefaultShowOnboardingDialog: Boolean = true

Functions

ScanningUx

@Composable

fun ScanningUx(modifier: Modifier, uiState: BaseUiState, onExitScanning: () -> Unit, uiSettings: UiSettings, onTorchStateChange: () -> Unit, onFlipDocumentAnimationCompleted: () -> Unit, onReticleSuccessAnimationCompleted: () -> Unit, onChangeOnboardingDialogVisibility: (Boolean) -> Unit, onChangeHelpScreensVisibility: (Boolean) -> Unit, onChangeHelpTooltipVisibility: (Boolean) -> Unit, onRetry: () -> Unit, onDoneError: () -> Unit)

Composable function that provides the user interface for the scanning screen, including the reticle, instruction messages, buttons, and dialogs.