Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

html5-qrcode

Package Overview
Dependencies
Maintainers
1
Versions
63
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

html5-qrcode - npm Package Compare versions

Comparing version 2.0.9 to 2.0.10

15

package.json
{
"name": "html5-qrcode",
"version": "2.0.9",
"version": "2.0.10",
"description": "A cross platform HTML5 QR Code & bar code scanner",

@@ -9,3 +9,4 @@ "main": "dist/html5-qrcode.min.js",

"build": "./scripts/build-default.sh",
"test": "./scripts/test.sh"
"test": "./scripts/test.sh",
"lint-md": "remark ."
},

@@ -41,7 +42,15 @@ "repository": {

"promise-polyfill": "^8.1.3",
"remark-cli": "^9.0.0",
"remark-preset-lint-recommended": "^5.0.0",
"rewire": "^5.0.0",
"ts-loader": "^9.1.2",
"webpack": "^5.37.0",
"webpack-cli": "^4.7.0"
"webpack-cli": "^4.7.0",
"typescript": "^4.3.2"
},
"remarkConfig": {
"plugins": [
"remark-preset-lint-recommended"
]
},
"files": [

@@ -48,0 +57,0 @@ "dist/*"

64

README.md

@@ -6,15 +6,15 @@ # Html5-QRCode

Use this lightweight library to easily / quickly integrate QR code, bar code, and other common code scanning capabilities to your web application.
- Supports easy scanning using an integrated webcam or camera in smartphones (Android / IOS).
- Supports easy scanning using an integrated webcam or camera in smartphones (Android / IOS).
- Supports scanning codes from files or default cameras on smartphones.
- Supports scanning codes from files or default cameras on smartphones.
- **<u>Recently Added</u>** Supports bar code scanning in various formats.
- **<u>Recently Added</u>** Supports bar code scanning in various formats.
- Supports two kind of APIs
- `Html5QrcodeScanner` - End-to-end scanner with UI, integrate with less than ten lines of code.
- `Html5Qrcode` - Powerful set of APIs you can use to build your UI without worrying about camera setup, handling permissions, reading codes, etc.
- Supports two kind of APIs
- `Html5QrcodeScanner` - End-to-end scanner with UI, integrate with less than ten lines of code.
- `Html5Qrcode` - Powerful set of APIs you can use to build your UI without worrying about camera setup, handling permissions, reading codes, etc.
> Support for scanning local files on the device is a new addition and helpful for the web browser which does not support inline web-camera access in smartphones. **Note:** This doesn't upload files to any server - everything is done locally.
[![Build Status](https://travis-ci.org/mebjas/html5-qrcode.svg?branch=master)](https://travis-ci.org/mebjas/html5-qrcode) [![GitHub issues](https://img.shields.io/github/issues/mebjas/html5-qrcode)](https://github.com/mebjas/html5-qrcode/issues) [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/mebjas/html5-qrcode)](https://github.com/mebjas/html5-qrcode/releases) ![GitHub](https://img.shields.io/github/license/mebjas/html5-qrcode)
[![Build Status](https://travis-ci.org/mebjas/html5-qrcode.svg?branch=master)](https://travis-ci.org/mebjas/html5-qrcode) [![GitHub issues](https://img.shields.io/github/issues/mebjas/html5-qrcode)](https://github.com/mebjas/html5-qrcode/issues) [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/mebjas/html5-qrcode)](https://github.com/mebjas/html5-qrcode/releases) ![GitHub](https://img.shields.io/github/license/mebjas/html5-qrcode) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/51e4f0ef8b0b42e1b93ce29875dd23a0)](https://www.codacy.com/gh/mebjas/html5-qrcode/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mebjas/html5-qrcode&amp;utm_campaign=Badge_Grade)

@@ -34,4 +34,4 @@ [![npm](https://nodei.co/npm/html5-qrcode.png)](https://www.npmjs.com/package/html5-qrcode)

**Legends**
- ![](assets/done.png) Means full support - inline webcam and file based
- ![](assets/partial.png) Means partial support - only file based, webcam in progress
- ![](assets/done.png) Means full support - inline webcam and file based
- ![](assets/partial.png) Means partial support - only file based, webcam in progress

@@ -91,12 +91,12 @@ ### PC / Mac

Supports:
- Querying camera on the device (with user permissions)
- Rendering live camera feed, with easy to use user interface for scanning
- Supports scanning a different kind of QR codes, bar codes and other formats
- Supports selecting image files from the device for scanning codes
- Querying camera on the device (with user permissions)
- Rendering live camera feed, with easy to use user interface for scanning
- Supports scanning a different kind of QR codes, bar codes and other formats
- Supports selecting image files from the device for scanning codes
## How to use?
## How to use
> For full information [read this article](https://blog.minhazav.dev/HTML5-QR-Code-scanning-launched-v1.0.1/).
Download the script from [release page](https://github.com/mebjas/html5-qrcode/releases) or `npm` with:
```
```sh
npm i html5-qrcode

@@ -305,4 +305,6 @@ ```

Check these articles on how to use this library:
- [HTML5 QR Code scanning - launched v1.0.1 without jQuery dependency and refactored Promise based APIs](https://blog.minhazav.dev/HTML5-QR-Code-scanning-launched-v1.0.1/).
- [HTML5 QR Code scanning with javascript - Support for scanning the local file and using default camera added (v1.0.5)](https://blog.minhazav.dev/HTML5-QR-Code-scanning-support-for-local-file-and-default-camera/)
<!-- TODO(mebjas) Mirgate this link to blog.minhazav.dev -->
- [QR and barcode scanner using HTML and Javascript](https://minhazav.medium.com/qr-and-barcode-scanner-using-html-and-javascript-2cdc937f793d)
- [HTML5 QR Code scanning - launched v1.0.1 without jQuery dependency and refactored Promise based APIs](https://blog.minhazav.dev/HTML5-QR-Code-scanning-launched-v1.0.1/).
- [HTML5 QR Code scanning with javascript - Support for scanning the local file and using default camera added (v1.0.5)](https://blog.minhazav.dev/HTML5-QR-Code-scanning-support-for-local-file-and-default-camera/)

@@ -566,4 +568,4 @@ ## Screenshots

By default, the scanner can scan for horizontally flipped QR Codes. This also enables scanning QR code using the front camera on mobile devices which are sometimes mirrored. This is `false` by default and I recommend changing this only if:
- You are sure that the camera feed cannot be mirrored (Horizontally flipped)
- You are facing performance issues with this enabled.
- You are sure that the camera feed cannot be mirrored (Horizontally flipped)
- You are facing performance issues with this enabled.

@@ -648,17 +650,17 @@ Here's an example of a normal and mirrored QR Code

4. Testing
- Run `npm test`
- Run the tests before sending a pull request, all tests should run.
- Please add tests for new behaviors sent in PR.
4. Testing
- Run `npm test`
- Run the tests before sending a pull request, all tests should run.
- Please add tests for new behaviors sent in PR.
5. Send a pull request
- Include code changes only to `./src`. **Do not change `./dist` manually.**
- In the pull request add a comment like
```
@all-contributors please add @mebjas for this new feature or tests
```
For calling out your contributions - the bot will update the contributions file.
- Code will be built & published by the author in batches.
5. Send a pull request
- Include code changes only to `./src`. **Do not change `./dist` manually.**
- In the pull request add a comment like
```text
@all-contributors please add @mebjas for this new feature or tests
```
For calling out your contributions - the bot will update the contributions file.
- Code will be built & published by the author in batches.
## Credits
The decoder used for the QRcode reading is from `Zxing-js` https://github.com/zxing-js/library<br>

Sorry, the diff of this file is too big to display

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc