CameraScanner

The scannerDataSubscribable will return the scanner data and source that is executed on the extension. You can learn more in the Scanner API documentation.

Determines the banner's appearance and content.

Camera scanning is available when the device has a camera and the user grants POS permission to access it. For third-party apps, camera scanning can be initiated from within the app via a ‘Button’ component that launches the camera scanner feature.

The full-screen camera scanning UI should resemble the functionality in the core POS app.

Utilize the error banner to display scanning errors or unrecognized barcodes at the top of the camera view screen.

After a successful scan, dismiss the full-screen camera view and display a secondary screen showcasing the intended outcome.

The camera scanner UI can be adjusted to display the camera view on part of the screen while dedicating the remaining portion to other components. This can be useful for tasks like inventory management.

In situations where scanning should not be allowed within a specific section of your application, use an error banner to inform merchants that scanning is not permitted on that screen and offer alternative areas where the scanning function can be performed.

Use the error banner at the top of the screen to denote errors while scanning or when encountering an unrecognized barcode.

Upon successful scanning of an item, display a ‘Toast’ component with a message such as "Item scanned" to indicate the outcome. Additionally, altering the screen contents can also be used to signal a successful scan.

• Be concise.
• Keep to 1 or 2 short sentences.
• Be dismissible unless it contains critical information or an important step merchants need to take.

Example:

✅ Scanning not permitted on this screen. Go to {Section} to scan items.
Dismiss (CTA)
❌Error.

✅ Barcode not recognized. Try scanning item again.
Dismiss (CTA)
❌ Didn’t work.

• Used for short messages to confirm an action.
• Never go over 3 or 4 words.
• Do not use for error messages.
• Should be used for success messages.
• Written in the pattern of noun + verb.

Example:

✅ Item scanned.
❌ Your item has been scanned and added to your inventory count!