Appearance
Here is a list of all parameters that are accepted in the appearance object present in the Document Detector options.
General
Parameter
Type
Default Value
fontFamily
Changes the font for all elements contained in the SDK.
Example: "arial"
string
The font family is inherited from the page.
closeButtonIconColor
Close SDK button icon color customization.
Example: "red"
string
"#fff"
Capture
Parameter
Type
Default Value
captureButtonIcon
Capture icon source customization.
Options: image URL or base64 SVG.
string
The default capture button icon is used.
captureButtonIconSize
Capture icon size customization.
Example: "50%"
string
"100%"
captureButtonColor
Capture button color customization.
Example: "green"
string
"#fff"
cameraSwitchButtonIcon
Camera switch icon source customization.
Options: image URL or base64 SVG.
string
The default switch button icon is used.
cameraSwitchButtonIconSize
Camera switch icon size customization.
Example: "5vh"
string
"4vh"
cameraSwitchButtonIconColor
Camera switch icon color customization.
Example: "#FF0000"
string
"white"
hideCameraSwitchButton
Hides the camera switch button.
boolean
false
hideCaptureTitle
Hides the capture title.
boolean
false
Upload
Parameter
Type
Default Value
backgroundColor
Upload mode - background color.
Example: gray
string
#BDBDBD
card.backgroundColor
Upload mode - card background color.
Example: white
string
#FFFFFF
startScreen.title.color
Upload mode - start screen - title color.
Example: "black"
string
"#323232"
startScreen.details.color
Upload mode - start screen - details color.
Example: "gray"
string
"#828282"
startScreen.allowButton.backgroundColor
Upload mode - start screen - allow button background color.
Example: "black"
string
"#323232"
startScreen.allowButton.label.color
Upload mode - start screen - allow button label color.
Example: "white"
string
"#FFFFFF"
loadingScreen.icon.color
Upload mode - loading screen - icon color.
Example: "black"
string
"#000000"
loadingScreen.text.color
Upload mode - loading screen - text color.
Example: "black"
string
"#323232"
failureScreen.icon.color
Upload mode - failure screen - icon color.
Example: "red"
string
"#E21B45"
failureScreen.icon.shadowColor
Upload mode - failure screen - icon shadow color.
Example: "indianred"
string
"#FFE4E6"
failureScreen.title.color
Upload mode - failure screen - title color.
Example: "black"
string
"#323232"
failureScreen.details.color
Upload mode - failure screen - details color.
Example: "gray"
string
"#828282"
failureScreen.retryButton.backgroundColor
Upload mode - failure screen - retry button background color.
Example: "red"
string
"#E21B45"
failureScreen.retryButton.label.color
Upload mode - failure screen - retry button label color.
Example: "white"
string
"#FFFFFF"
successScreen.icon.color
Upload mode - success screen - icon color.
Example: "green"
string
"#0BAA43"
successScreen.icon.shadowColor
Upload mode - success screen - icon shadow color.
Example: "darkseagreen"
string
"#DAFEE5"
successScreen.text.color
Upload mode - success screen - text color.
Example: "green"
string
"#0BAA43"
Below are screenshots demonstrating where each option is applied in the SDK screens for the Upload mode.
All screens (upload mode)
Start screen (upload mode)
Loading screen (upload mode)
Success screen (upload mode)
Failure screen (upload mode)
Last updated
