microblink-ux/com.microblink.ux.components

Package-level declarations

Types

class DocumentDrawable(@DrawableRes val front: Int, @DrawableRes val back: Int)

data class HelpScreenPage(@DrawableRes val pageImage: Int, @StringRes val pageTitle: Int, @StringRes val pageMessage: Int)

HelpScreens

data class HelpScreens(val onboardingDialogPage: HelpScreenPage, val helpDialogPages: List<HelpScreenPage>)

Functions

DocumentFlipAnimation

@Composable

fun DocumentFlipAnimation(screenDimensionMin: Dp, onAnimationCompleted: () -> Unit)

ErrorDialog

@Composable

fun ErrorDialog(@StringRes title: Int, @StringRes description: Int?, @StringRes buttonText: Int, onDismissErrorDialog: () -> Unit = {}, onButtonClick: () -> Unit)

ExitButton

@Composable

fun ExitButton(modifier: Modifier, onExit: () -> Unit)

fillHelpScreens

@Composable

fun fillHelpScreens(): HelpScreens

HelpBox

@Composable

fun HelpBox(modifier: Modifier, helpScreensButtonDisplayed: Boolean, helpTooltipDisplayed: Boolean, onChangeOnboardingDialogState: (Boolean) -> Unit, onChangeHelpTooltipState: (Boolean) -> Unit)

HelpButton

@Composable

fun HelpButton(modifier: Modifier = Modifier, onChangeOnboardingDialogState: (Boolean) -> Unit)

HelpScreens

@Composable

fun HelpScreens(onChangeHelpScreensState: (Boolean) -> Unit)

HelpScreensContentLandscape

@Composable

fun HelpScreensContentLandscape(pagerState: PagerState, helpScreens: List<HelpScreenPage>)

HelpScreensContentPortrait

@Composable

fun HelpScreensContentPortrait(pagerState: PagerState, helpScreens: List<HelpScreenPage>)

fun LoadingScreen()

fun MessageContainer(@StringRes textRes: Int, backgroundColor: Color)

NeedHelpTooltip

@Composable

fun NeedHelpTooltip(onChangeHelpTooltipState: (Boolean) -> Unit)

OnboardingDialog

@Composable

fun OnboardingDialog(onDismissOnboardingDialog: () -> Unit)

OnboardingDialogContent

@Composable

fun OnboardingDialogContent(onDismissOnboardingDialog: () -> Unit, onboardingScreenResources: HelpScreenPage)

Reticle

@Composable

fun Reticle(reticleState: ReticleState, screenDimensionMin: Dp, onReticleSuccessAnimationCompleted: () -> Unit)

ReticleSuccess

@Composable

fun ReticleSuccess(reticleRadius: Dp, @DrawableRes successDrawable: Int = R.drawable.mb_reticle_success, onReticleSuccessAnimationCompleted: () -> Unit)

TorchButton

@Composable

fun TorchButton(modifier: Modifier, torchState: MbTorchState, onTorchStateChange: () -> Unit)