Skip to content

docs: fix README defaults, examples, and prop table placement - #804

Open
ZayanKhan-12 wants to merge 1 commit into
teslamotors:masterfrom
ZayanKhan-12:readme-fixes
Open

docs: fix README defaults, examples, and prop table placement#804
ZayanKhan-12 wants to merge 1 commit into
teslamotors:masterfrom
ZayanKhan-12:readme-fixes

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Documentation fixes, each verified against the native sources:

Item Issue
frameColor default Table says yellow; actual is .white on iOS (CameraView.swift) and Color.GREEN on Android (CKCamera.kt). The scanner example earlier in the README already says white.
scanThrottleDelay placement Sat under iOS only, but it's implemented on Android (CKCamera.kt:112, 753). Moved to the cross-platform section.
onCaptureButtonPressIn/Out placement Also under iOS only while their own descriptions cover Android volume/camera buttons. Moved.
capture() example References destFilePath, which is not defined anywhere in the snippet (ReferenceError as written). Replaced with the moveFile destination.
allowedBarcodeTypes example 'code-128' appears at both ends of the list; replaced the duplicate with 'qr', which was missing.
zoomMode row Says to "avoid setting zoomMode" to allow pinch-to-zoom; the CameraProps docstring says to avoid setting zoom — as written, the advice disables the gesture being enabled.
AndroidManifest path android/src/main/android/app/src/main/ (matches the example app), and the manifest snippet is now fenced as xml instead of java.

🤖 Generated with Claude Code

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant