docs: fix README defaults, examples, and prop table placement - #804
Open
ZayanKhan-12 wants to merge 1 commit into
Open
docs: fix README defaults, examples, and prop table placement#804ZayanKhan-12 wants to merge 1 commit into
ZayanKhan-12 wants to merge 1 commit into
Conversation
All verified against the native sources: - frameColor default is white on iOS (CameraView.swift: ScannerInterfaceView(frameColor: .white)) and green on Android (CKCamera.kt: Color.GREEN), not yellow; the scanner example earlier in the README already said white. - scanThrottleDelay sat under the 'iOS only' table section but is implemented on Android (CKCamera.kt). onCaptureButtonPressIn/Out also sat there while their own descriptions cover Android volume/ camera buttons. Moved all three to the cross-platform section. - The capture() example referenced destFilePath, which is not defined anywhere in the snippet; use the moveFile destination. - allowedBarcodeTypes example listed 'code-128' twice; replace the duplicate with 'qr'. - zoomMode row said to avoid setting 'zoomMode' to allow pinch to zoom; the CameraProps docstring says to avoid setting 'zoom'. - AndroidManifest.xml path is android/app/src/main/ (as in the example app), and the manifest snippet is XML, not Java. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
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.
Documentation fixes, each verified against the native sources:
frameColordefaultyellow; actual is.whiteon iOS (CameraView.swift) andColor.GREENon Android (CKCamera.kt). The scanner example earlier in the README already says white.scanThrottleDelayplacementCKCamera.kt:112, 753). Moved to the cross-platform section.onCaptureButtonPressIn/Outplacementcapture()exampledestFilePath, which is not defined anywhere in the snippet (ReferenceError as written). Replaced with themoveFiledestination.allowedBarcodeTypesexample'code-128'appears at both ends of the list; replaced the duplicate with'qr', which was missing.zoomModerowzoomMode" to allow pinch-to-zoom; theCameraPropsdocstring says to avoid settingzoom— as written, the advice disables the gesture being enabled.android/src/main/→android/app/src/main/(matches the example app), and the manifest snippet is now fenced asxmlinstead ofjava.🤖 Generated with Claude Code