@lrnwebcomponents/barcode-reader

<barcode-reader>

Reader

Element to read barcodes and QR codes through a video stream

Usage

To use this web component in your project you can utilize one of the following styles of syntax.

/* In an existing JS module / web component */
import '@lrnwebcomponents/barcode-reader/barcode-reader.js';
/* At top of an application with build routine */
<script type="module" src="@lrnwebcomponents/barcode-reader/barcode-reader.js"></script>
/* Alternatives for top of application */
<script type="module">
  import '@lrnwebcomponents/barcode-reader/barcode-reader.js';
  // imperative form
  import {BarcodeReader} from '@lrnwebcomponents/barcode-reader';
  // if you don't have a build routine and need to reference directly
  import './node_modules/@lrnwebcomponents/barcode-reader/barcode-reader.js';
</script>
// via unpkg CDN (good for testing)
<script type="module" src="https://unpkg.com/@lrnwebcomponents/barcode-reader/barcode-reader.js"></script>

Usage after imported

barcode-reader will give controls to show/hide and start the scanner, but the submit button to utilize the data is left up to the website.

Component Specific Attributes

value Value of the result. scale Scale of the video as a number, no percentage sign. hideinput Include value to hide the input tag and result. Shown by default.

Develop / Demo

Run yarn start will start a local development server, open your default browser to display it, open your finder to the correct window and start watching the /src directory for changes and automatically rebuilding the element and documentation site for the demo.

$ yarn start

Test

$ yarn run test

Build

Builds ensure that wcfactory can correctly compile your web component project to work on the maximum number of browsers possible.

$ yarn run build

Contributing

1. Fork it! git clone https://github.com/elmsln/lrnwebcomponents.git
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Code style

Reader (and all lrnwebcomponents) use Prettier to auto-format JS and JSON. The style rules get applied when you commit a change. If you choose to, you can integrate your editor with Prettier to have the style rules applied on every save.

License

Apache-2.0 License