BarcodeScanner docs overhaul: simplified guide, restructured API reference#488
Merged
Tom-Dynamsoft merged 3 commits intomainfrom Jan 27, 2026
Merged
BarcodeScanner docs overhaul: simplified guide, restructured API reference#488Tom-Dynamsoft merged 3 commits intomainfrom
Tom-Dynamsoft merged 3 commits intomainfrom
Conversation
…structure - Streamline Quick Start examples to show one-liner patterns - Separate "Building a Multi-Barcode Scanner Step by Step" section - Move installation options to appendix (CDN, npm/yarn, Self-Hosting) - Clarify unique barcode definition (format + text, 3-second window) - Update API reference with consistent descriptions for duplicateForgetTime and onUniqueBarcodeScanned
…dings - Replace tables with #### headings for all config properties (BarcodeScannerConfig, ScannerViewConfig, ResultViewConfig, etc.) - Each property now has its own anchor for direct linking - Add missing barcodeImage property to BarcodeScanResult - Fix incorrect optional marker on status property - Update intro to align with user guide messaging
- Update duplicateForgetTime and engineResourcePaths links in user guide - Update showUploadImageButton, showCloseButton, showFlashButton, cameraSwitchControl, duplicateForgetTime links in customization guide
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Major documentation improvements for BarcodeScanner JavaScript Edition:
Key changes
Intro page (index.md)
User guide (user-guide/index.md)
API reference (barcode-scanner.md)
####headingsbarcodeImageproperty to BarcodeScanResultstatuspropertyCustomization guide
Test plan