blinkid-ux/com.microblink.blinkid.ux.theme

Package-level declarations

Types

data class AccessibilityStrings(@StringRes val scanCompleted: Int, @StringRes val firstSideScanned: Int, @StringRes val previousPage: Int, @StringRes val nextPage: Int, @StringRes val showHelpScreens: Int, @StringRes val turnFlashlightOff: Int, @StringRes val turnFlashlightOn: Int, @StringRes val exitScanning: Int, @StringRes val flashlightOff: Int, @StringRes val flashlightOn: Int) : Parcelable

BlinkIdScanningStrings

@Immutable

data class BlinkIdScanningStrings(@StringRes val instructionsFirstSide: Int, @StringRes val instructionsSecondSide: Int, @StringRes val instructionsBarcode: Int, @StringRes val instructionsFlip: Int, @StringRes val instructionsBarcodeOnlyModule: Int, @StringRes val instructionsBarcodeIdModule: Int, @StringRes val instructionsNotFullyVisible: Int, @StringRes val instructionsTilted: Int, @StringRes val instructionsFacePhotoNotFullyVisible: Int, @StringRes val instructionsScanningWrongSide: Int, @StringRes val instructionsBlurDetected: Int, @StringRes val instructionsGlareDetected: Int, @StringRes val instructionsMoveFarther: Int, @StringRes val instructionsMoveCloser: Int, @StringRes val instructionsIncreaseLight: Int, @StringRes val instructionsDecreaseLight: Int, @StringRes val snackbarFlashlightWarning: Int, @StringRes val instructionsPassportDataPage: Int, @StringRes val instructionsPassportMoveToTopPage: Int, @StringRes val instructionsPassportMoveToRightPage: Int, @StringRes val instructionsPassportMoveToLeftPage: Int, @StringRes val instructionsPassportMoveToBarcodePage: Int, @StringRes val instructionsPassportWrongPageTop: Int, @StringRes val instructionsPassportWrongPageRight: Int, @StringRes val instructionsPassportWrongPageLeft: Int, @StringRes val instructionsPassportWrongPageBarcode: Int, @StringRes val instructionsPassportScanTopPage: Int, @StringRes val instructionsPassportScanRightPage: Int, @StringRes val instructionsPassportScanLeftPage: Int, @StringRes val instructionsPassportScanBarcodePage: Int, @StringRes val instructionsBarcodeWrongSide: Int) : Parcelable, ScanningStrings

Includes common SDK strings from ScanningStrings and BlinkID specific strings.

BlinkIdSdkStrings

@Immutable

data class BlinkIdSdkStrings(val blinkIdScanningStrings: BlinkIdScanningStrings, val blinkIdDocumentHelpDialogsStrings: HelpDialogsStrings, val blinkIdBarcodeHelpDialogsStrings: HelpDialogsStrings, val blinkIdBarcodeIdHelpDialogsStrings: HelpDialogsStrings, val blinkIdAccessibilityStrings: AccessibilityStrings) : Parcelable, SdkStrings

Data class contains all the strings used throughout the SDK. Default can be used to keep the original strings if only some of the elements are to be changed.

HelpDialogsStrings

@Immutable

data class HelpDialogsStrings(@StringRes val onboardingTitle: Int, @StringRes val onboardingMessage: Int, @StringRes val helpTitles: List<Int>, @StringRes val helpMessages: List<Int>) : Parcelable

SDK-specific onboarding and help dialog strings.

ScanningStrings

@Immutable

open class ScanningStrings(@StringRes val instructionsFirstSide: Int, @StringRes val instructionsSecondSide: Int, @StringRes val instructionsFlip: Int, @StringRes val instructionsNotFullyVisible: Int, @StringRes val instructionsTilted: Int, @StringRes val instructionsScanningWrongSide: Int, @StringRes val instructionsBlurDetected: Int, @StringRes val instructionsMoveFarther: Int, @StringRes val instructionsMoveCloser: Int, @StringRes val snackbarFlashlightWarning: Int) : Parcelable

SdkStrings

@Immutable

open class SdkStrings(val scanningStrings: ScanningStrings, val accessibilityStrings: AccessibilityStrings) : Parcelable

Contains the common strings used by the shared scanning UX layer.

SdkTheme

object SdkTheme

UiColors

@Immutable

data class UiColors(val helpButtonBackground: Color, val helpButton: Color, val helpTooltipBackground: Color, val helpTooltipText: Color)

Data class contains all the text, button, and background colors used throughout the SDK scanning session. Default can be used to keep the original theme colors if only some of the elements are to be changed.

UiTypography

@Immutable

data class UiTypography(val onboardingTitle: TextStyle, val onboardingText: TextStyle, val onboardingButton: TextStyle, val helpDialogTitle: TextStyle, val helpDialogText: TextStyle, val helpDialogButton: TextStyle, val errorDialogTitle: TextStyle, val errorDialogText: TextStyle, val errorDialogButton: TextStyle, val scanningInstructions: TextStyle, val helpTooltip: TextStyle, val loadingScreen: TextStyle)

Defines the typography used in the verification UI.

Properties

Black

val Black: Color

Cobalt

val Cobalt: Color

CobaltDark

val CobaltDark: Color

CobaltLight

val CobaltLight: Color

DarkColorScheme

val DarkColorScheme: ColorScheme

val DarkGray: Color

val ErrorRed: Color

val Gray: Color

val LightColorScheme: ColorScheme

LocalBaseBlinkIdSdkStrings

var LocalBaseBlinkIdSdkStrings: ProvidableCompositionLocal<BlinkIdSdkStrings>

LocalBaseSdkStrings

var LocalBaseSdkStrings: ProvidableCompositionLocal<SdkStrings>

LocalBaseUiColors

var LocalBaseUiColors: ProvidableCompositionLocal<UiColors>

LocalTheme

var LocalTheme: ProvidableCompositionLocal<ColorScheme>

LocalTypography

var LocalTypography: ProvidableCompositionLocal<UiTypography>

SdkTypography

val SdkTypography: (fontFamily: FontFamily?) -> UiTypography

White

val White: Color

Functions

BlinkIdSdkTheme

@Composable

fun BlinkIdSdkTheme(uiSettings: UiSettings, darkTheme: Boolean = isSystemInDarkTheme(), content: @Composable () -> Unit)

Theme used in the entire SDK. Defines colors and strings that are used for all the elements. The theme can be updated by defining UiSettings which customizes all the visual elements.