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 up DataCaptureContext.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 the useEffect cleanup function.
• new BarcodeBatch(settings) and new BarcodeBatchBasicOverlay(mode, style) and new 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 DataCaptureView via view.addOverlay(overlay) inside the DataCaptureView ref callback.
• On iOS, npx [email protected] (or cd 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 (NSCameraUsageDescription in ios/<App>/Info.plist) and Android (runtime request via PermissionsAndroid).
• New Architecture caveat (react-native ≥ 0.79, iOS): When using the new React Native architecture (Fabric / TurboModules), iOS apps must have the AppDelegate implement the ScanditReactNativeFactoryContainer protocol (available in the core module) when using BarcodeBatchAdvancedOverlay. See integration.md for details.
• MatrixScan AR add-on required: BarcodeBatchAdvancedOverlay, BarcodeBatchBasicOverlayListener.brushForTrackedBarcode, and BarcodeBatchBasicOverlay.setBrushForTrackedBarcode all 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", "read the tracked barcode data / identifier / location", "handle taps on highlights or AR views", "emit feedback / beep on a new barcode", "show AR overlays", "per-barcode brushes", "lifecycle or cleanup", "camera permissions") → read references/integration.md and follow the instructions there.
• Replacing a third-party multi-barcode scanner with MatrixScan Batch (e.g. "replace my react-native-vision-camera useCodeScanner with MatrixScan Batch", "migrate from VisionCamera multi-barcode scanning to Scandit", "switch from RNCamera / ML Kit batch scanning to BarcodeBatch") → read references/third-party-migration.md and 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:

1. First check whether the page you already fetched contains a direct hyperlink to it.
2. 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.

Licence key

Scanning needs a Scandit licence key. For this skill the licence product is native and the licence platforms are ios and android.

Work through these in order — never block the user on MCP:

1. The Scandit MCP server is connected — call ensure_scanner_setup with product native and platforms ios and android, app_identifier (the app's bundle or application id; for web, its production domain, never localhost) and env_var SCANDIT_LICENSE_KEY. Do not run the command it returns. Then call get_license_key with the key's id, from that result or from list_license_keys; if list_license_keys shows the key is not a trial, ask the user before fetching it. Show at most a masked preview in chat; never print a full key.

2. It is not connected — tell the user once that they can connect the remote Scandit MCP server, https://ssl.scandit.com/mcp, in their MCP client, then continue from step 1. Do not edit MCP client configuration yourself.

   Authentication is browser-based, so it is not supported headless or in CI. The server provisions trial keys only; it never creates, revokes, or modifies production licences.

3. The user declines, or has no MCP client — they generate a key themselves at https://ssl.scandit.com (no account yet: https://ssl.scandit.com/dashboard/sign-up?p=test) and paste it in.

Then put the key into the code: write it into the licence-key call in place of the placeholder — the key get_license_key returned, or the one the user pastes or gives you — still showing only a masked preview in chat. Do not search the project, its files or the environment for a key.

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