Fix duplicate QR scanner initialization on page navigation #997
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When navigating between pages in applications using Html5QrcodeScanner, multiple instances of the scanner were being created without proper cleanup. This resulted in:
The issue occurred because:
render()was called multiple timesclear()methodSolution
Implemented minimal, surgical changes to
Html5QrcodeScannerclass:1. Duplicate Prevention
Added state tracking to prevent multiple
render()calls on the same instance:2. Automatic Cleanup
Added listeners for page navigation events that automatically clean up scanner instances:
3. Complete State Reset
Enhanced
clear()method to fully reset all state, allowing proper re-initialization:isRenderedflagChanges Made
Files Modified:
src/html5-qrcode-scanner.ts- All changes (67 lines added).gitignore- Added build artifactsNew Fields:
isRendered: boolean- Tracks initialization stateunloadListener: () => void- Stores cleanup listenerEnhanced Methods:
render()- Added duplicate prevention + automatic cleanup setupclear()- Added complete state reset + listener cleanupsetupAutomaticCleanup()- Registers page unload listenersremoveAutomaticCleanup()- Safely removes listenersVerification
✅ Before Fix: Multiple scanner UI elements visible
✅ After Fix: Single clean scanner interface
Test Results:
render()calls properly blockedBackwards Compatibility
✅ Fully backwards compatible - existing code continues to work unchanged, only adds protective measures against duplicate initialization.
Fixes #986.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.