matrixscan-batch-rn
MatrixScan Batch React Native Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeBatch* API surface changes between major SDK versions — constructor signatures, overlay constructors, and listener shapes have all evolved.
Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, plugin names, or property names.
React Native-specific gotchas worth flagging:
DataCaptureContext.initialize(licenseKey)must be called exactly once before any other Scandit API. It sets upDataCaptureContext.sharedInstance. Do not construct multiple contexts.dataCaptureContext.setMode(barcodeBatch)is how the mode is registered in the context (confirmed from all RN samples). This replaces any previously active mode.dataCaptureContext.removeMode(barcodeBatch)is the cleanup call — use it in theuseEffectcleanup function.new BarcodeBatch(settings)andnew BarcodeBatchBasicOverlay(mode, style)andnew BarcodeBatchAdvancedOverlay(mode)constructors (without a context argument) are available from react-native=7.6.BarcodeBatch.createRecommendedCameraSettings()is available from react-native=7.6.- Overlays must be added to a
DataCaptureViewviaview.addOverlay(overlay)inside theDataCaptureViewrefcallback. - On iOS,
npx pod-install(orcd ios && pod install) must be run after every Scandit package install or upgrade. Android auto-links via Gradle. - Metro's bundler cache frequently masks Scandit package upgrades. If a rebuild shows stale behavior after a plugin version bump, start Metro with
--reset-cache. - Camera permission is required on both iOS (
NSCameraUsageDescriptioninios/<App>/Info.plist) and Android (runtime request viaPermissionsAndroid). - New Architecture caveat (react-native ≥ 0.79, iOS): When using the new React Native architecture (Fabric / TurboModules), iOS apps must have the
AppDelegateimplement theScanditReactNativeFactoryContainerprotocol (available in the core module) when usingBarcodeBatchAdvancedOverlay. See integration.md for details. - MatrixScan AR add-on required:
BarcodeBatchAdvancedOverlay,BarcodeBatchBasicOverlayListener.brushForTrackedBarcode, andBarcodeBatchBasicOverlay.setBrushForTrackedBarcodeall require the MatrixScan AR add-on to be licensed.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
- Integrating MatrixScan Batch from scratch (e.g. "add MatrixScan to my app", "set up BarcodeBatch", "track multiple barcodes simultaneously", "show AR overlays", "per-barcode brushes", "lifecycle or cleanup", "camera permissions") → read
references/integration.mdand follow the instructions there.
API Usage Policy
Only use APIs that are explicitly documented in the Scandit references below. Do not invent or guess method signatures, parameters, property names, or imports. If unsure whether an API exists or how it is called, fetch the relevant reference page before responding. Do not tell the user to check the docs themselves. After answering, always include the relevant link so the user can explore further.
Never construct or guess documentation URLs. When you need a specific class or property's API page:
- First check whether the page you already fetched contains a direct hyperlink to it.
- If no direct link was found, fetch the API index, extract the actual link from it, and follow that.
URL structures vary across SDK versions and package paths and guessing will lead to 404s.
Framework variant policy
React Native apps can be written with class components or function components. Examples in this skill use function components with hooks because they match the current React Native convention. Write new BarcodeBatch integration code as function components — use useRef, useEffect, useCallback.
Examples are in TypeScript (.tsx). If the target project is plain JavaScript (.js / .jsx), drop the type annotations and keep the same imports and structure.
References
Direct users to the right resource based on their question:
| Topic | Resource |
|---|---|
| React Native get started | Get Started |
| React Native AR overlays | Adding AR Overlays |
| Full API reference | BarcodeBatch API |
More from scandit/scandit-sdk-skills
data-capture-sdk
Use when a user mentions Scandit, data capture SDK, barcode scanning products, smart data capture, choosing a scanning product, comparing scanning features, supported barcode symbologies, system requirements, device compatibility, or Scandit pricing. Helps choose the right Scandit product (SparkScan, Barcode Capture, MatrixScan, Smart Label Capture, ID Capture, etc.), points to the correct documentation and sample apps for their platform, and hands off to implementation skills.
19sparkscan-ios
Use when SparkScan is involved in an iOS project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new iOS app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, troubleshooting SparkScan behavior, or replacing a third-party barcode scanning library with SparkScan. If the project is iOS and SparkScan is in play, use this skill.
13label-capture-rn
Use when Label Capture (Smart Label Capture) is involved in a React Native project — whether the user mentions Label Capture directly, or the codebase already uses it and something needs to be added, changed, fixed, or customized. This includes adding Label Capture to a new React Native app, defining label structures (barcode fields + text fields with regex patterns), handling captured labels, enabling the Validation Flow, or upgrading between SDK versions. If the project is React Native and Label Capture is in play, use this skill.
3sparkscan-rn
Use when SparkScan is involved in a React Native project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new React Native app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, or troubleshooting SparkScan behavior. If the project is React Native and SparkScan is in play, use this skill.
3sparkscan-web
Use when SparkScan is involved in an web project — whether the user mentions SparkScan directly, or the codebase already uses SparkScan as its barcode scanning library and something needs to be added, changed, fixed, or migrated. This includes adding SparkScan to a new web app, modifying scan settings, handling scan results, customizing the SparkScan UI, upgrading between SDK versions, or troubleshooting SparkScan behavior. If the project is a web project and SparkScan is in play, use this skill.
3matrixscan-ar-rn
Use when MatrixScan AR, Barcode AR, AR overlays, AR annotations, or AR highlights are involved in a React Native project — whether the user mentions MatrixScan AR or Barcode AR directly, or the codebase already uses BarcodeAr* classes and something needs to be added, changed, fixed, or extended. This includes adding MatrixScan AR to a new React Native app, configuring BarcodeArSettings and symbologies, wiring highlight providers (BarcodeArCircleHighlight, BarcodeArRectangleHighlight, BarcodeArCustomHighlight), wiring annotation providers (BarcodeArInfoAnnotation, BarcodeArPopoverAnnotation, BarcodeArStatusIconAnnotation, BarcodeArResponsiveAnnotation, BarcodeArCustomAnnotation), handling session updates via BarcodeArListener, customizing BarcodeArFeedback, or troubleshooting BarcodeAr* behavior. If the project is React Native and MatrixScan AR / Barcode AR is in play, use this skill.
3