Skip to content

Improve HTML5-QRCode examples with better error handling and consistent API usage #998

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Improve HTML5-QRCode examples with better error handling and consistent API usage #998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41ef1f1
Initial plan
Copilot Jul 23, 2025
6907ee8
Improve HTML5-QRCode examples with better error handling and consiste…
Copilot Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions examples/electron/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,17 @@ function onScanSuccess(decodedText, decodedResult) {
// Handle on success condition with the decoded message.
console.log(`Scan result ${decodedText}`, decodedResult);
}

function onScanFailure(error) {
// Handle scan failure, usually better to ignore and keep scanning.
// console.warn(`Code scan error = ${error}`);
}

var html5QrcodeScanner = new Html5QrcodeScanner(
"reader", { fps: 10, qrbox: 250 });
html5QrcodeScanner.render(onScanSuccess);
"reader",
{ fps: 10, qrbox: {width: 250, height: 250} },
/* verbose= */ false);
html5QrcodeScanner.render(onScanSuccess, onScanFailure);
```

## Run the app
Expand Down
12 changes: 10 additions & 2 deletions examples/html5/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,18 @@ function onScanSuccess(decodedText, decodedResult) {
lastResult = decodedText;
// Handle on success condition with the decoded message.
console.log(`Scan result ${decodedText}`, decodedResult);
resultContainer.innerHTML = `<div>Scan result: ${decodedText}</div>`;
}
}

function onScanFailure(error) {
// Handle scan failure, usually better to ignore and keep scanning.
// console.warn(`Code scan error = ${error}`);
}

var html5QrcodeScanner = new Html5QrcodeScanner(
"qr-reader", { fps: 10, qrbox: 250 });
html5QrcodeScanner.render(onScanSuccess);
"qr-reader",
{ fps: 10, qrbox: {width: 250, height: 250} },
/* verbose= */ false);
html5QrcodeScanner.render(onScanSuccess, onScanFailure);
```
89 changes: 58 additions & 31 deletions examples/html5/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,66 @@
<html>
<head>
<title>Html-Qrcode Demo</title>
<body>
<div id="qr-reader" style="width:500px"></div>
<div id="qr-reader-results"></div>
</body>
<script src="/html5-qrcode.min.js"></script>
<script>
function docReady(fn) {
// see if DOM is already available
if (document.readyState === "complete"
|| document.readyState === "interactive") {
// call on next available tick
setTimeout(fn, 1);
} else {
document.addEventListener("DOMContentLoaded", fn);
<title>Html5-QRCode Demo</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 20px;
}
#qr-reader {
width: 500px;
border: 1px solid #ccc;
}
}
#qr-reader-results {
margin-top: 20px;
padding: 10px;
background-color: #f0f0f0;
border-radius: 5px;
}
</style>
</head>
<body>
<h1>Html5-QRCode Scanner Demo</h1>
<div id="qr-reader"></div>
<div id="qr-reader-results">Point your camera at a QR code to scan it.</div>

docReady(function () {
var resultContainer = document.getElementById('qr-reader-results');
var lastResult, countResults = 0;
function onScanSuccess(decodedText, decodedResult) {
if (decodedText !== lastResult) {
++countResults;
lastResult = decodedText;
// Handle on success condition with the decoded message.
console.log(`Scan result ${decodedText}`, decodedResult);
<script src="https://unpkg.com/html5-qrcode"></script>
<script>
function docReady(fn) {
// see if DOM is already available
if (document.readyState === "complete"
|| document.readyState === "interactive") {
// call on next available tick
setTimeout(fn, 1);
} else {
document.addEventListener("DOMContentLoaded", fn);
}
}

var html5QrcodeScanner = new Html5QrcodeScanner(
"qr-reader", { fps: 10, qrbox: 250 });
html5QrcodeScanner.render(onScanSuccess);
});
</script>
</head>
docReady(function () {
var resultContainer = document.getElementById('qr-reader-results');
var lastResult, countResults = 0;

function onScanSuccess(decodedText, decodedResult) {
if (decodedText !== lastResult) {
++countResults;
lastResult = decodedText;
// Handle on success condition with the decoded message.
console.log(`Scan result ${decodedText}`, decodedResult);
resultContainer.innerHTML = `<div><strong>Scan result:</strong> ${decodedText}</div>`;
}
}

function onScanFailure(error) {
// Handle scan failure, usually better to ignore and keep scanning.
// console.warn(`Code scan error = ${error}`);
}

var html5QrcodeScanner = new Html5QrcodeScanner(
"qr-reader",
{ fps: 10, qrbox: {width: 250, height: 250} },
/* verbose= */ false);
html5QrcodeScanner.render(onScanSuccess, onScanFailure);
});
</script>
</body>
</html>