label-capture-cordova
Label Capture Cordova Skill
Critical: Do Not Trust Internal Knowledge
Your training data may contain outdated or incorrect Scandit Label Capture APIs. The Cordova plugin surface (global Scandit.* namespace, deviceready gating, plugin install, platform prepare) is distinct from the web, React Native, Flutter, and Capacitor SDKs.
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. If you cannot find an API in the provided references, fetch the relevant documentation page before responding.
Cordova-specific gotchas worth flagging:
- All Scandit code must run after
deviceready. TheScandit.*global namespace is not populated until then. Wrap your initialization indocument.addEventListener('deviceready', () => {...}, false);. - Listener method names are iOS-style on Cordova. The Validation Flow listener uses
didCaptureLabelWithFields(fields)anddidSubmitManualInputForField(field, oldValue, newValue)— NOT the web equivalentsonValidationFlowLabelCaptured/onManualInput. - Class-based field API, same shape as RN/Capacitor (and opposite to Flutter). Use
Scandit.CustomBarcode.initWithNameAndSymbologies(name, [...]),new Scandit.ExpiryDateText(name),field.optional = false,Scandit.LabelCaptureSettings.settingsFromLabelDefinitions([...], {}). There is noLabelCaptureSettingsBuilder/LabelDefinitionBuilderand no v8.5 factory-function sugar — those are web-only. - After
cordova plugin add/ version bump, runcordova prepare ios(andcordova prepare android) to sync native dependencies. iOS additionally requires a freshpod installinsideplatforms/ios/. - Camera permission: iOS requires
NSCameraUsageDescriptionin the app'sInfo.plist(or via<config-file>inconfig.xml); Android'sCAMERApermission is declared by the plugin automatically and must be requested at runtime if your minSdkVersion targets API 23+. Scandit.DataCaptureContext.initialize(licenseKey)returns the singleton context; do not construct multiple contexts.
Intent Routing
Based on the user's request, load the appropriate reference file before responding:
- Integrating Label Capture from scratch (e.g. "add Label Capture to my app", "scan a price tag with barcode and expiry date", "how do I use Smart Label Capture", "how do I enable the Validation Flow") → read
references/integration.mdand follow the instructions there. - Migrating or upgrading an existing Label Capture integration (e.g. "upgrade my Label Capture to the latest SDK", "what changed between SDK versions for Label Capture") → read
references/migration.mdand 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 — 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 (e.g. the Advanced Configurations page) contains a direct hyperlink to it.
- If no direct link was found, fetch the API index (see Full API reference in the table below), 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
Examples in this skill are written in plain JavaScript (ES6+) because that is the default for Cordova templates and the official LabelCaptureSimpleSample. If the target project uses TypeScript (some Cordova projects do), keep the same imports/structure and add type annotations as needed — do not change the global Scandit.* access pattern, do not switch to ES module imports, and do not assume bundler features.
References
| Topic | Resource |
|---|---|
| Cordova integration | Get Started · Sample (LabelCaptureSimpleSample) |
| Label Definitions (fields, regex, presets) | Label Definitions |
| Advanced topics (Validation Flow customization, adaptive recognition, custom overlays) | Advanced Configurations |
| Full API reference | Label Capture 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