sparkscan-cordova
SparkScan Cordova Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit SDK APIs. The SparkScan API changes significantly between major SDK versions — properties get renamed, removed, or restructured, and the Cordova plugin surface (global Scandit namespace, plugin install commands, deviceready timing) has also evolved.
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.- After changing plugin versions, run
cordova prepare(and reinstall the platform if needed) to propagate the new native artifacts. Skipping this yields a runtime version mismatch.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
- Integrating SparkScan from scratch (e.g. "add SparkScan to my app", "set up barcode scanning", "how do I use SparkScan in Cordova", "how do I handle feedback in SparkScan") → read
references/integration.mdand follow the instructions there. - Migrating or upgrading an existing SparkScan integration (e.g. "upgrade from v6 to v7", "migrate my SparkScan", "bump the Scandit plugins to v8", "what changed between SDK versions") → read
references/migration.mdand follow the instructions there.
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.
23sparkscan-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.
15matrixscan-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.
5label-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.
5sparkscan-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.
5sparkscan-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.
5