Tips Customization
Capture Tips Customization
The specific “tips” of the Capture Tips page can be customized.
For each tip, the title, description and icon can be overridden. Some tips have a receipt and invoice variation. The appropriate variation will be displayed based on the provided Capture configuration.
The following section describes how each tip can be customized on each platform. Below that section, the summary of specific Android and iOS keys for each tip is provided.
How to Customize Tips
- Follow the Localization guide to change the strings specified below
- Follow the Images section in iOS-specific section of Global Theme to change the images specified below.
To override any string resources mentioned below, add the exact string key to your own strings.xml file.
For example, for the string key sb__tips_description_flattenreceipt, add the following to override it:
<string name="sb__tips_description_flattenreceipt">My tip description</string>To override and drawable resources mentioned below, create a new drawable with the exact name as the one that you wish to override.
The correct resources to override for each tip are listed above this section.
Keys to Override
Capture has four tips, all of which can be customized. Here’s the summary of the tips and their keys
General Tip 1
Default: “Flatten receipt / invoice”
| Item | Android Keys | iOS Keys |
|---|---|---|
| Title (receipt) | sb__tips_title_flattenreceipt | sblCaptureTipsScreenFlattenReceiptTitle |
| Title (invoice) | sb__tips_title_flattenreceipt_invoice | sblCaptureTipsScreenFlattenInvoiceTitle |
| Description (receipt) | sb__tips_description_flattenreceipt | sblCaptureTipsScreenFlattenReceiptDescription |
| Description (invoice) | sb__tips_description_flattenreceipt_invoice | sblCaptureTipsScreenFlattenInvoiceDescription |
| Icon | sb__tips_ic_flatten | captureTipsFlatenIcon |
General Tip 2
Default: “Hold steady”
| Item | Android Keys | iOS Keys |
|---|---|---|
| Title (receipt) | sb__tips_title_holdsteady | sblCaptureTipsScreenHoldSteadyReceiptTitle |
| Title (invoice) | sb__tips_title_holdsteady_invoice | sblCaptureTipsScreenHoldSteadyInvoiceTitle |
| Description (receipt) | sb__tips_description_holdsteady | sblCaptureTipsScreenHoldSteadyReceiptDescription |
| Description (invoice) | sb__tips_description_holdsteady_invoice | sblCaptureTipsScreenHoldSteadyInvoiceDescription |
| Icon | sb__tips_ic_steady | captureTipsSteadyIcon |
Flash Tip
Conditional: will not be shown if a flash/torch was disabled via the feature flag
| Item | Android Key | iOS Key |
|---|---|---|
| Title | sb__tips_title_makeitbright | sblCaptureTipsScreenMakeItBrightTitle |
| Description | sb__tips_description_makeitbright | sblCaptureTipsScreenMakeItBrightDescription |
| Icon | sb__tips_ic_bright | captureTipsBrightIcon |
Long Receipt Tip
Conditional: will not be shown if long receipt capture was disabled via the feature flag
| Item | Android Key | iOS Key |
|---|---|---|
| Title | sb__tips_title_longreceipt | sblCaptureTipsScreenLongReceiptTitle |
| Description | sb__tips_description_longreceipt | sblCaptureTipsScreenLongReceiptDescription |
| Icon | sb__tips_ic_longreceipt | captureTipsLongIcon |