matrixscan-batch-cordova

Installation
SKILL.md

MatrixScan Batch Cordova 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.

Cordova-specific gotchas worth flagging:

  • Global namespace: The Scandit SDK is exposed on window.Scandit. Use Scandit.BarcodeBatch, Scandit.DataCaptureView, etc. at runtime. The npm packages (scandit-cordova-datacapture-*) are plugin manifests, not ES modules. Do not emit import { ... } from 'scandit-cordova-datacapture-*' in user code running in the WebView. Only TypeScript projects using a bundler can import types at compile time.
  • deviceready gate: All Scandit APIs must be called after document.addEventListener('deviceready', ...). Never call at module load time.
  • context.setMode(barcodeBatch): This is the Cordova method to register the mode with the context. It replaces any previously active mode. Confirmed from both Cordova samples.
  • Modern constructors require SDK 7.6+: new Scandit.BarcodeBatch(settings), new Scandit.BarcodeBatchBasicOverlay(mode, style), new Scandit.BarcodeBatchAdvancedOverlay(mode), and Scandit.BarcodeBatch.createRecommendedCameraSettings() are all available from cordova=7.6.
  • AdvancedOverlay uses serialized views: On Cordova, setViewForTrackedBarcode accepts view: Promise<TrackedBarcodeView?> — a serialized TrackedBarcodeView, NOT a native UI instance. Use Scandit.TrackedBarcodeView.withHTMLElement(domElement, options) to construct one. This is the same shape as Capacitor. See the Bubbles sample for the exact pattern.
  • MatrixScan AR add-on required: BarcodeBatchAdvancedOverlay, IBarcodeBatchBasicOverlayListener.brushForTrackedBarcode, and setBrushForTrackedBarcode all require the MatrixScan AR add-on to be licensed.
  • Camera permissions are configured automatically by the plugins on both iOS and Android.
  • DataCaptureView.forContext(context) is the Cordova factory. Then call view.connectToElement(htmlElement) to attach it to the DOM.
  • TrackedObject (Cordova 8.2+): In SDK 8.2+, a TrackedObject base class was introduced that TrackedBarcode extends. No recipe is needed — the TrackedBarcode API you use day-to-day is unchanged.
Related skills

More from scandit/scandit-sdk-skills

Installs
3
GitHub Stars
10
First Seen
Apr 28, 2026