matrixscan-ar-cordova
Installation
SKILL.md
MatrixScan AR Cordova Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The BarcodeAr API is new in Cordova plugin 8.2 — it did not exist in v6 or v7 for Cordova. There is no migration history to reference.
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.
Cordova-specific gotchas worth flagging:
- The Scandit SDK is exposed on the global
window.Scanditobject. The npm package names (scandit-cordova-datacapture-*) are plugin manifests — they are not runtime ES modules. Do not emitimport { ... } from 'scandit-cordova-datacapture-*'in user code that will run in the WebView; useScandit.X(with an optionalglobal.d.tsfor typing) instead. Only Ionic/Angular/Webpack-bundled projects import from the packages directly. document.addEventListener('deviceready', ...)is the only safe gate for Scandit APIs. Do not run any Scandit call at module load time — it will fail because the Cordova bridge is not ready yet.BarcodeArViewin Cordova uses a DOM-overlay model: the native AR view is sized and positioned to mirror a plain HTML<div>element. You must callbarcodeArView.connectToElement(element)after construction to link the view to a DOM node, andbarcodeArView.detachFromElement()when tearing down.new Scandit.BarcodeAr(settings)— this is the Cordova constructor (notBarcodeAr.forContext). Context is wired separately viacontext.setFrameSource(camera).- Camera is managed manually in BarcodeAr on Cordova: obtain it with
Scandit.Camera.withSettings(Scandit.BarcodeAr.createRecommendedCameraSettings()), set it as the frame source, and callcamera.switchToDesiredState(Scandit.FrameSourceState.On/Off)to start/stop. - Highlight and annotation providers return
Promise<BarcodeArHighlight | null>andPromise<BarcodeArAnnotation | null>respectively — make the methodsasyncor return a Promise explicitly. - After changing plugin versions, run
cordova prepare(and reinstall the platform if needed) to propagate the new native artifacts.