blinkcard-ux/com.microblink.blinkcard.ux.components

Package-level declarations

Types

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>)

Properties

needHelpTooltipDefaultTimeToAppearMs

const val needHelpTooltipDefaultTimeToAppearMs: Long = 8000

uiCountingWindowDurationMs

const val uiCountingWindowDurationMs: Long = 1500

Functions

DemoOverlay

@Composable

fun DemoOverlay(modifier: Modifier)

drawScrollbar

fun Modifier.drawScrollbar(scrollState: ScrollState, color: Color = Color.Gray.copy(alpha = 0.5f), nestedScrollConnection: NestedScrollConnection? = null): Modifier

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)

FlipAnimation

@Composable

fun FlipAnimation(@DrawableRes firstSideDrawable: Int, @DrawableRes secondSideDrawable: Int, screenDimensionMin: Dp, onAnimationCompleted: () -> Unit)

HelpBox

@Composable

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

HelpButton

@Composable

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

HelpScreens

@Composable

fun HelpScreens(helpScreenPages: List<HelpScreenPage>, onHelpScreensCloseRequested: (allPagesDisplayed: Boolean) -> Unit)

HelpScreensContentLandscape

@Composable

fun HelpScreensContentLandscape(modifier: Modifier, pagerState: PagerState, helpScreens: List<HelpScreenPage>, nestedScrollConnection: NestedScrollConnection? = null)

HelpScreensContentPortrait

@Composable

fun HelpScreensContentPortrait(modifier: Modifier, pagerState: PagerState, helpScreens: List<HelpScreenPage>, nestedScrollConnection: NestedScrollConnection? = null)

LoadingScreen

@Composable

fun LoadingScreen()

longHapticFeedback

@RequiresApi(value = 26)

fun longHapticFeedback(): VibrationEffect

MessageContainer

@Composable

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

NeedHelpTooltip

@Composable

fun NeedHelpTooltip(modifier: Modifier, onChangeHelpTooltipState: (Boolean) -> Unit, onDisplayHelpRequested: () -> Unit, activateHelpTooltip: Boolean)

OnboardingDialog

@Composable

fun OnboardingDialog(onboardingDialogPage: HelpScreenPage, onDismissOnboardingDialog: () -> Unit)

OnboardingDialogContent

@Composable

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

ProductionOverlay

@Composable

fun ProductionOverlay(modifier: Modifier)

Reticle

@Composable

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

ReticleSuccess

@Composable

fun ReticleSuccess(modifier: Modifier, reticleRadius: Dp, @DrawableRes successDrawable: Int = R.drawable.mb_blinkcard_reticle_success, onReticleSuccessAnimationCompleted: () -> Unit, isAfterFirstSide: Boolean)

shortHapticFeedback

@RequiresApi(value = 26)

fun shortHapticFeedback(): VibrationEffect

TorchButton

@Composable

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