SparkScan View

Defined in library scandit_datacapture_barcode_spark_ui

SparkScanScanningBehavior

Added in version 6.20.0

The capture mode type of the SparkScanView.

single

Added in version 6.20.0

Barcode capturing session is stopped after each scan.

continuous

Added in version 6.20.0

Keeps the barcode capturing session active for longer time.

SparkScanPreviewBehavior

Added in version 6.23.0

The preview behavior type of the SparkScanView.

defaultBehaviour

Added in version 6.23.0

After a scan with scanning behavior SparkScanScanningBehavior.single, or stopping scanning with scanning behavior SparkScanScanningBehavior.continuous, camera moves to standby state and preview is hidden for maximum efficiency.

persistent

Added in version 6.23.0

After a scan with scanning behavior SparkScanScanningBehavior.single, or stopping scanning with scanning behavior SparkScanScanningBehavior.continuous, camera stays active and preview is visible for maximum precision.

SparkScanMiniPreviewSize

Added in version 7.0.0

The size of the mini preview in SparkScanView. Used in SparkScanViewSettings.defaultMiniPreviewSize.

regular

Added in version 7.0.0

Regular, smaller size of the mini preview.

expanded

Added in version 7.0.0

Expanded, larger size of the mini preview.

SparkScanViewState

Added in version 7.0.0

The view state of SparkScanView.

initial

Added in version 7.0.0

The initial view state for a few moments after SparkScanView is created.

idle

Added in version 7.0.0

SparkScan is displaying only the collapsed capture button.

inactive

Added in version 7.0.0

SparkScan is displaying an expanded capture button, and if the SparkScanPreviewBehavior of the current SparkScanScanningMode is SparkScanPreviewBehavior.persistent, we are also displaying camera feed through the mini preview but no actual scanning is taking place. This state is reachable after scanning or after a SparkScanViewSettings.inactiveStateTimeout timeout.

active

Added in version 7.0.0

We are actively recognising barcodes, mini preview and expanded capture button are visible.

error

Added in version 7.0.0

User returns SparkScanBarcodeFeedback.Error from the SparkScanView.feedbackDelegate. Mini preview is visible with a frozen frame and expanded capture button is visible. If capture button is tapped or after a SparkScanBarcodeErrorFeedback.resumeCapturingDelay timeout is reached we move to active state.

SparkScanViewUiListener
abstract class SparkScanViewUiListener

Added in version 6.20.0

didTapBarcodeFindButton(view)
void didTapBarcodeFindButton(SparkScanView view)

Added in version 7.0.0

Callback method that can be used to define an action that should be performed when barcode find button is tapped from the toolbar. Called from the main thread.

didTapBarcodeCountButton(view)
void didTapBarcodeCountButton(SparkScanView view)

Added in version 6.20.0

Callback method that can be used to define an action that should be performed when barcode count button is tapped from the toolbar. Called from the main thread.

didTapLabelCaptureButton(view)
void didTapLabelCaptureButton(SparkScanView view)

Added in version 8.0.0

Callback method that can be used to define an action that should be performed when label capture button is tapped from the toolbar. Called from the main thread.

didChangeViewState(newState)
void didChangeViewState(SparkScanViewState newState)

Added in version 7.0.0

Callback method that will be called when SparkScanViewState changes. Called from the main thread.

SparkScanScanningMode
abstract class SparkScanScanningMode

Added in version 6.20.0

The base class for setting a default scanning mode to SparkScanViewSettings. Can be either SparkScanScanningModeTarget or SparkScanScanningModeDefault.

SparkScanScanningModeTarget
class SparkScanScanningModeTarget : SparkScanScanningMode

Added in version 6.20.0

Target scanning mode. This is meant and optimized to scan codes further away.

SparkScanScanningModeTarget.fromPreviewBehavior(scanningBehavior, previewBehavior)
SparkScanScanningModeTarget.fromPreviewBehavior(
        SparkScanScanningBehavior scanningBehavior,
        SparkScanPreviewBehavior previewBehavior)

Added in version 6.23.0

Constructs a new target scanning mode with the provided capture mode and preview behavior.

scanningBehavior
SparkScanScanningBehavior get scanningBehavior

Added in version 6.20.0

The scanning mode provided in the constructor.

previewBehavior
SparkScanPreviewBehavior get previewBehavior

Added in version 6.23.0

The preview behavior provided in the constructor.

SparkScanScanningModeDefault
class SparkScanScanningModeDefault : SparkScanScanningMode

Added in version 6.20.0

This is the standard scanning mode for SparkScan.

SparkScanScanningModeDefault.fromPreviewBehavior(scanningBehavior, previewBehavior)
SparkScanScanningModeDefault.fromPreviewBehavior(
        SparkScanScanningBehavior scanningBehavior,
        SparkScanPreviewBehavior previewBehavior)

Added in version 6.23.0

Constructs a new default scanning mode with the provided capture mode and preview behavior.

scanningBehavior
SparkScanScanningBehavior get scanningBehavior

Added in version 6.20.0

The scanning mode provided in the constructor.

previewBehavior
SparkScanPreviewBehavior get previewBehavior

Added in version 6.23.0

The preview behavior provided in the constructor.

SparkScanView
class SparkScanView : StatefulWidget

Added in version 6.20.0

SparkScan comes with a ready-to-use UI and scanning modes that are purpose-built to tackle high-volume scanning at close range. The SparkScanView integrates with any app without requiring app redesign or customization. It includes:

  • camera preview screen

  • large-sized scan button

  • quick access toolbar to adjust scanning settings

feedbackDelegate
SparkScanFeedbackDelegate? feedbackDelegate

Added in version 6.23.0

Sets the feedback delegate. If no delegate is set, the default SparkScanBarcodeFeedback.Success feedback is emitted.

hardwareTriggerSupported
static bool get hardwareTriggerSupported

Added in version 6.20.0

Returns whether the device supports listening for hardware button events. This is true for devices with api >= 28.

Note

This method is only supported on Android devices.

SparkScanView.forContext(child, dataCaptureContext, sparkScan, settings)
SparkScanView.forContext(Widget child,
        DataCaptureContext dataCaptureContext,
        SparkScan sparkScan,
        SparkScanViewSettings? settings)

Added in version 6.20.0

Constructs a new SparkScan view and adds it to the provided parentView. When the settings are provided, those will be used to set the default behaviour and look of the view.

SparkScanView.forContext(YOUR_WIDGET_TREE_BODY, dataCaptureContext, sparkScan, viewSettings);
stopScanning()
Future<void> stopScanning()

Added in version 7.6.2

startScanning()
Future<void> startScanning()

Added in version 6.20.0

Starts the scanning process. You can call this method if you want to trigger the scanning process without any user interaction.

pauseScanning()
Future<void> pauseScanning()

Added in version 6.20.0

Pauses the scanning process. You can call this method if you want to trigger pausing the scanning process without any user interaction.

setListener(listener)
void setListener(SparkScanViewUiListener? listener)

Added in version 6.20.0

Sets the listener which is called whenever a barcode find button or barcode count button is tapped from the toolbar.

showToast(text)
Future<void> showToast(String text)

Added in version 6.20.0

Shows a toast with text inside the mini preview.

setTriggerButtonImage(image)
Future<void> setTriggerButtonImage(Uint8List image)

Added in version 7.0.0

Sets the image to use for the trigger button.

defaultBrush
static Brush get defaultBrush

Added in version 6.20.0

Returns the default brush used by the overlay.

barcodeCountButtonVisible
bool barcodeCountButtonVisible

Added in version 6.20.0

Indicates whether the barcode count button should be shown to the user.

Default is false.

barcodeFindButtonVisible
bool barcodeFindButtonVisible

Added in version 6.26.0

Indicates whether the barcode find button should be shown to the user.

Default is false.

labelCaptureButtonVisible
bool labelCaptureButtonVisible

Added in version 7.4.0

Indicates whether the label capture button should be shown to the user.

Default is false.

targetModeButtonVisible
bool targetModeButtonVisible

Added in version 6.20.0

Indicates whether the target mode button should be shown to the user.

Default is false.

scanningBehaviorButtonVisible
bool scanningBehaviorButtonVisible

Added in version 6.20.0

Indicates whether the scanning behavior button should be shown to the user.

Default is false.

zoomSwitchControlVisible
bool zoomSwitchControlVisible

Added in version 6.20.0

Indicates whether the zoom switch control should be shown to the user.

Default is true.

triggerButtonVisible
bool triggerButtonVisible

Added in version 7.0.0

Indicates whether the trigger button should be shown to the user.

Default is true.

previewSizeControlVisible
bool previewSizeControlVisible

Added in version 6.23.0

Indicates whether the mini preview size control should be shown to the user.

Default is true.

torchControlVisible
bool torchControlVisible

Added in version 7.0.0

Indicates whether the torch control should be shown to the user.

Default is true.

Note

If SparkScanViewSettings.defaultTorchState is set to TorchState.auto, torch control is hidden.

previewCloseControlVisible
bool previewCloseControlVisible

Added in version 7.0.0

Indicates whether the mini preview close control should be shown to the user.

Default is true.

cameraSwitchButtonVisible
bool cameraSwitchButtonVisible

Added in version 6.24.0

Indicates whether the camera switch button should be shown to the user.

Default is false.

Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

triggerButtonCollapsedColor
Color? triggerButtonCollapsedColor

Added in version 7.0.0

Sets the background color of the trigger button when button is collapsed.

triggerButtonExpandedColor
Color? triggerButtonExpandedColor

Added in version 7.0.0

Sets the background color of the trigger button when button is expanded.

triggerButtonAnimationColor
Color? triggerButtonAnimationColor

Added in version 7.0.0

Sets the color of the pulsing animation around the trigger button, which is shown when the scanner is active.

triggerButtonTintColor
Color? triggerButtonTintColor

Added in version 7.0.0

Sets the trigger button tint color.

toolbarBackgroundColor
Color? toolbarBackgroundColor

Added in version 6.20.0

Sets the toolbar background color.

Default is null.

toolbarIconActiveTintColor
Color? toolbarIconActiveTintColor

Added in version 6.20.0

Sets the toolbar icon active color.

Default is null.

toolbarIconInactiveTintColor
Color? toolbarIconInactiveTintColor

Added in version 6.20.0

Sets the toolbar icon inactive color.

Default is null.

triggerButtonImage
Image? triggerButtonImage

Added in version 7.0.0

The image displayed in the trigger button.

createState()
State<StatefulWidget> createState()

Added in version 6.20.0

Implemented from StatefulWidget. Called by the Flutter framework.

Note

Troubleshooting: Buttons Not Working With Navigation Header

When using the SparkScanView component with React Navigation and headerShown: true, you may encounter an issue where the Buttons within your SparkScanView don’t respond to touch events. This is a known issue with React Navigation’s header implementation.

The Issue

The navigation header can interfere with touch event handling for components rendered within certain custom views like SparkScanView. While the buttons appear to be functioning visually, their onPress events do not trigger when the screen includes a header.

Solution

Try this workaround if you encounter this issue:

Use TouchableOpacity instead of Button

<TouchableOpacity
  onPressIn={() => handleButtonPress()}>
  <Text>Scan</Text>
</TouchableOpacity>

or

<TouchableOpacity
  onPressOut={() => handleButtonPress()}>
  <Text>Scan</Text>
</TouchableOpacity>

Ensure you’re importing TouchableOpacity from ‘react-native’

Some users have found that using the TouchableOpacity component from ‘react-native-gesture-handler’ causes issues, while the one from ‘react-native’ works correctly.