📁 Table of Contents
Table of Contents | ||
---|---|---|
|
🛠️ Configuration
📚 Full Code
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Info |
---|
JSON file can have only those values that you want to replace |
1️⃣ Colours
Code | Name | |||||||
---|---|---|---|---|---|---|---|---|
|
| Primary colour
| ||||||
| Black colour
| |||||||
| White colour
| |||||||
| Danger / Alert Red Used for alert and rejection icons | |||||||
| Warning Yellow Used for the warning icons | |||||||
| Success Green Used for the identification approval icon | |||||||
| Background color Used for every screen background color. |
2️⃣ Illustrations / icons
In the application there are two types of media assets:
Illustrations
Their accent colour is set from the"primaryColor"
. It is also possible to overwrite the illustrations with your own.Icons
Icon colour can be adjusted with the icon colour configuration. It is also possible to overwrite the icons with your own.Images
Some of the default images can be overridden, the important part here is to use the exact same naming as the default image resource.
For example, on Android, to override the identification waiting screen image, one needs to use a raw resource JSON file namedwaiting_page_animation.json
, put under theres/raw
folder inside your project and it would work like a charm. Note that it has to adhere to Lottie image JSON format, as explained in their documentation.
3️⃣ Fonts
Font style can be adjusted with the text configuration. It is also possible to use your own custom font.
Note |
---|
Guide how to do that is coming soon |
4️⃣ Overwritable screens
It is possible to replace the following screens with your own custom screens.
Note |
---|
Guide how to do that is coming soon |
🧩 Components
🔘 Buttons structure
In the application we are using these button types:
Primary button (1)
for the main actions like “Submit”, “Capture”.Secondary button (2)
for the other actions, like “Cancel”, “Retake photo”.Back (3) and Close (4) buttons
These are icon buttons on the top part of the card
Button whitelabel is structured in 4 parts - primaryButtonAppearance, secondaryButtonAppearancewhich has variables for styles like corner radius, padding, font. These stylings are applied for all 3 states:
Normal
Default button viewHighlighted
When the button is pressedDisabled
When the button is not accessible.
1️⃣ Button. Main Appearance.
These values will go thorough all primary button states - Normal, Highlighted and Disabled
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Font size | 8-32pt | ||||||
| Font weight | 100-800 | ||||||||
| Line height | 8-32pt | ||||||||
2 |
| Corner radius | 0-32pt | |||||||
| if true, ignores cornerRadius value and rounds the button corners completely | true/false | ||||||||
3 |
| Button padding | 0-32pt | |||||||
| 0-32pt | |||||||||
| 0-32pt | |||||||||
| 0-32pt | |||||||||
4 |
| if true, shows the icon near the button text | true/false |
2️⃣ Button. Normal view
This view will be default look of a button.
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Text color |
| ||||||
2 |
| Background color |
| |||||||
3 |
| Border color | #FFFFFF | |||||||
| Border width | 0-32pt | ||||||||
4 |
| Icon colour | #FFFFFF |
3️⃣ Button. Highlighted state
Button style when it’s pressed down.
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Text color |
| ||||||
2 |
| Background color |
| |||||||
3 |
| Border color | #FFFFFF | |||||||
| Border width | 0-32pt | ||||||||
4 |
| Icon colour | #FFFFFF |
4️⃣ Button. Disabled state
Button style when it’s disabled
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Text color |
| ||||||
2 |
| Background color |
| |||||||
3 |
| Border color | #FFFFFF | |||||||
| Border width | 0-32pt | ||||||||
4 |
| Icon colour | #FFFFFF | |||||||
| Button opacity | 0-1 |
5️⃣ Back and Close Buttons
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Icon color |
|
💬 Typography structure
In the application we are using these typography types:
Heading 1 (1)
Used for the each screens titleHeading 2 (2)
Used for the second hierarchy texts, for example - “Please check if” or “Make sure” textsNormal Text (3)
The body textList Text (4)
Texts style used in lists
Note |
---|
Fonts needs to be set-up separately from the JSON file. |
1️⃣ Heading 1 style
Text style used for the title of each screen
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Text alignment |
| ||||||
| Font size | 16–48pt | |||||||
| Font weight | 100–800 | |||||||
| Line height | 8–32pt | |||||||
| Text color |
|
2️⃣ Heading 2 style
Used for the second hierarchy texts, for example - “Please check if” or “Make sure” texts
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Text alignment |
| ||||||
| Font size | 14–24pt | |||||||
| Font weight | 100–800 | |||||||
| Line height | 8–32pt | |||||||
| Text color |
|
3️⃣ Normal text style
The body text
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Text alignment |
| ||||||
| Font size | 14–18pt | |||||||
| Font weight | 100–800 | |||||||
| Line height | 8–32pt | |||||||
| Text color |
|
4️⃣ List text style
Text style used for the list
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Text alignment |
| ||||||
| Font size | 14–18pt | |||||||
| Font weight | 100–800 | |||||||
| Line height | 8–32pt | |||||||
| Text color |
|
👤 Face Scan UI Configuration
These values define the appearance of the Face Scan UI, including the scan frame and feedback bar.
Face Scan frame (1)
The oval frame in the face captureFeedback bar (2)
1️⃣ Face Scan Frame
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Border color | #FFFFFF | ||||||
| Border width | 0 |
2️⃣ Feedback bar
Code | Name | Values | |||||||
---|---|---|---|---|---|---|---|---|---|
|
| Background color | #282B2F | ||||||
| Text color | #FFFFFF | |||||||
| Corner radius | 0–32pt |
🗂️ Other components
1️⃣ Selection card
Selection card is a button that is used to choose the document.
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Background color |
| ||||||
2 |
| Border width | 0–32pt | |||||||
| Border color |
| ||||||||
3 |
| Border radius | 0–32pt | |||||||
4 |
| Font weight | 100–800 | |||||||
| Line height | 8–32pt | ||||||||
5 |
| Tint color |
|
2️⃣ Activity indicator
A style of the loader
Code | Name | Values | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
| 1 |
| Loader color | #D3DAE2 |