matrixscan-count-cordova
MatrixScan Count Cordova Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeCount Cordova API has evolved significantly across SDK versions. Key milestones:
- Cordova 6.24: BarcodeCount first available on Cordova.
- Cordova 7.6: Context-free constructor
new Scandit.BarcodeCount(settings)introduced;context.addMode(barcodeCount)is now the wiring call. - Cordova 7.1:
BarcodeCountNotInListActionSettingsavailable. - Cordova 8.3:
BarcodeCountStatusProvider,shouldShowStatusModeButton,textForBarcodesNotInListDetectedHint,textForClusteringGestureHint,textForScreenCleanedUpHint,disableModeWhenCaptureListCompleted,ClusteringModeavailable.
Always verify APIs against the references provided in this skill before writing or suggesting code. Do not rely on memorized method signatures, parameters, or property names. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.
Source note: There is no public Cordova MatrixScan Count sample. The integration reference is anchored to the internal DebugApp (
frameworks/cordova/debugapp/src/pages/BarcodeCount.tsxandframeworks/cordova/debugapp/src/hooks/modes/useBarcodeCount.ts) and the Cordova plugin source (frameworks/cordova/scandit-cordova-datacapture-barcode/www/ts/src/BarcodeCountView.ts).
Cordova-Specific Gotchas
- Global namespace: The Scandit SDK is exposed on
window.Scandit. UseScandit.BarcodeCount,Scandit.BarcodeCountView, etc. at runtime. The npm packages (scandit-cordova-datacapture-*) are plugin manifests, not ES modules. Do not emitimport { ... } from 'scandit-cordova-datacapture-*'in user code running in the WebView. Only TypeScript projects using Webpack/bundler can import types at compile time. devicereadygate: All Scandit APIs must be called afterdocument.addEventListener('deviceready', ...). Never call at module load time.- Plugin install: Both plugins are required:
After any plugin change, runcordova plugin add scandit-cordova-datacapture-core cordova plugin add scandit-cordova-datacapture-barcodecordova prepare. - Web platform NOT supported: BarcodeCount on Cordova requires iOS or Android. The web platform is not supported.
BarcodeCountViewuses a DOM-overlay model: The native view is sized and positioned to mirror an HTML element. The attach API (verified against plugin source) is:barcodeCountView.connectToElement(htmlElement)— synchronous, noawaitneeded (internally async, but the public signature isvoid).barcodeCountView.detachFromElement()— synchronousvoid. Call during teardown.barcodeCountView.setFrame(rect, isUnderContent)— manually position using aRect. ReturnsPromise<void>. Use only when NOT usingconnectToElement.barcodeCountView.show()/barcodeCountView.hide()— returnsPromise<void>. Only use withsetFrame; throws if called with an element attached.
- Constructor pattern (≥7.6):
new Scandit.BarcodeCount(settings)followed bycontext.addMode(barcodeCount). The olderBarcodeCount.forDataCaptureContext(context, settings)wired context automatically; the new constructor does not. - Camera: Use
Scandit.BarcodeCount.createRecommendedCameraSettings()(≥7.6 Cordova). Obtain the camera withScandit.Camera.withSettings(cameraSettings), set it viacontext.setFrameSource(camera), and toggle withcamera.switchToDesiredState(Scandit.FrameSourceState.On/Off). - License placeholder: Always use the exact string
'-- ENTER YOUR SCANDIT LICENSE KEY HERE --'.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
-
Integrating MatrixScan Count from scratch (e.g. "add MatrixScan Count to my app", "set up BarcodeCount in Cordova", "how do I scan a list of items", "how do I show the count view", "how do I customize the toolbar or hints", "how do I use tap-to-uncount", "how do I enable status mode") → read
references/integration.mdand follow the instructions there. -
Migrating from an older BarcodeCount constructor pattern (e.g. "migrate from BarcodeCount.forDataCaptureContext", "update to the new constructor", "adopt status mode", "add not-in-list action settings to existing code") → read
references/migration.mdand follow the migration guide 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 — or if a runtime error occurs — 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.
Framework Variant Policy
Cordova is a WebView-based framework. Examples in this skill use plain JavaScript (with optional JSDoc type hints). The same API works in TypeScript — add a global.d.ts declaration file and write TypeScript syntax. This skill does not assume a TypeScript project by default. If the target project is clearly TypeScript (.ts files, tsconfig.json), adapt the final output to TypeScript; otherwise stay in plain JS.
References
Direct users to the right resource based on their question:
| Topic | Resource |
|---|---|
| Cordova integration | Get Started |
| Full API reference | BarcodeCount 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.
13matrixscan-batch-rn
Use when MatrixScan, MatrixScan Batch, BarcodeBatch, or BarcodeTracking (legacy alias) are involved in a React Native project — whether the user mentions these names directly, or the codebase already uses BarcodeBatch* classes and something needs to be added, changed, fixed, or extended. This includes adding MatrixScan Batch to a new React Native app, configuring BarcodeBatchSettings and symbologies, wiring BarcodeBatchListener.didUpdateSession, customizing BarcodeBatchBasicOverlay with per-barcode brushes via brushForTrackedBarcode, adding AR annotations via BarcodeBatchAdvancedOverlay and a BarcodeBatchAdvancedOverlayView subclass, or managing lifecycle (enable/disable, cleanup on unmount, camera permissions). If the project is React Native and MatrixScan / BarcodeBatch is in play, use this skill.
3label-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.
3