Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrodrig/vue-scandit
VueJS wrapper component for Scandit's Web SDK
https://github.com/mrodrig/vue-scandit
barcode scandit scanner vue vuejs
Last synced: 23 days ago
JSON representation
VueJS wrapper component for Scandit's Web SDK
- Host: GitHub
- URL: https://github.com/mrodrig/vue-scandit
- Owner: mrodrig
- Created: 2020-08-19T01:53:42.000Z (over 4 years ago)
- Default Branch: stable
- Last Pushed: 2020-12-06T22:46:35.000Z (about 4 years ago)
- Last Synced: 2024-11-21T19:19:46.693Z (about 1 month ago)
- Topics: barcode, scandit, scanner, vue, vuejs
- Language: Vue
- Homepage:
- Size: 305 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Vue Scandit Component
This library serves as a convienence wrapper for the Scandit Web SDK in order
to provide a simpler integration with VueJS.
## Installation
```
npm install --save vue-scandit
```
## Usage
Import the module via one of the following methods:
```javascript
import Vue from 'vue';
import VScandit from 'vue-scandit';
Vue.use(VScandit);
```
```html
```
### Options:
#### License-Key
Type: `String`
This value is the license key string that you will have from your account dashboard, either from a purchased license, or from an active trial.
If no license key is provided, then a default demo license key is used to provide a demo of the Scandit SDK functionality. This should not be abused and is not guaranteed to work as the license key matches the key that is provided in Scandit's Web SDK Demo.
#### Configuration Options
Type: `Object`
Default:
```json
{
"engineLocation": "https://cdn.jsdelivr.net/npm/[email protected]/build/"
}
```
This value is the options object passed to the `ScanditSDK.configure` method. Additional options and documentation for this method can be found on Scandit's Documentation site:
[ScanditSDK.configure() Documentation](https://docs.scandit.com/stable/web/globals.html#configure)
#### Scan Settings
Type: `Object`
Default:
```json
{
"enabledSymbologies": ["ean8", "ean13", "upca", "upce"]
}
```
This value is the barcode scanner options object passed to the `ScanditSDK.BarcodePicker.create` method, specifically under the `scanSettings` option that's passed to the `create` method.
Additional options and documentation for this method and the available `ScanSettings` fields can be found on Scandit's Documentation site:
[ScanditSDK.BarcodePicker.create() Documentation](https://docs.scandit.com/stable/web/classes/barcodepicker.html#create)
[ScanditSDK.ScanSettings() Documentation](https://docs.scandit.com/stable/web/classes/scansettings.html)
#### Barcode Picker Event
`v-on:barcodePicker="onBarcodePicker"`
This event is emitted when an instance of `ScanditSDK.BarcodePicker` has been instantiated and returned during the initialization process.
This provides a hook into the workflow of the barcode scanner so that customizations may be made.
#### Scan Event
`v-on:scan="onScan"`
This event is emitted when a barcode is scanned by the `ScanditSDK`.
The barcode will be provided as a `String` argument to the function that is provided.
## Contributing
```
# Install Dependencies
npm install
# Serve the v-scandit.vue component with hot reload functionality
npm run dev
# Build the updated files for distribution
npm run build
```
If you find a bug, or would like to contribute new functionality, please open a pull request with your changes and a brief description of the new functionality or fix that was added. Thanks!
## License
This library is provided for use under the GNU GPL v3 license.
## Disclaimer
It is in no way affiliated with Scandit AG and is provided without warranty or
any assurances. The contributors of this project provide no warranty and are not
liable for incorrect or misuse of this library.