\n\n\n## Features\n\nHigh performance barcode scanner for React Native using VisionCamera.\n\n- **Modern and future-proof:** Built on [react-native-vision-camera](https://github.com/mrousavy/react-native-vision-camera) with minimal native dependencies for each platforms to minimize future build-failure risk.\n\n- **Minimal footprint:** Leverages [Google's MLKit BarcodeScanner](https://developers.google.com/android/reference/com/google/mlkit/vision/barcode/package-summary) on Android and [Apple's Vision VNDetectBarcodesRequest](https://developer.apple.com/documentation/vision/vndetectbarcodesrequest).\n\n- **Powerful & Performant:** The implementation has been tailored for advanced use cases where performance is critical. Scanning barcodes is butter smooth at 30fps, and you can customize the detection speed loop (detection fps).\n\n- **Hooks based:** Exposes easy-to-use hooks [`useBarcodeScanner`](./src/hooks/useBarcodeScanner.ts) to quickly get started\n\n\n\n## Demo\n\n\n\nA working project can be found at [vision-camera-barcode-scanner-example](./example)\n\n## Install\n\n> [!WARNING]\n> The project is currently trying to closely track the [react-native-vision-camera v4](https://github.com/mrousavy/react-native-vision-camera/releases),\n> The latest 0.11+ releases are made to work with the latest react-native-vision-camera release only (currently 4.0.0)\n\n```bash\nnpm install @mgcrea/vision-camera-barcode-scanner\n# or\nyarn add @mgcrea/vision-camera-barcode-scanner\n# or\npnpm add @mgcrea/vision-camera-barcode-scanner\n```\n\n### Dependencies\n\nThis package relies on:\n\n- [react-native-vision-camera@>=3](https://github.com/mrousavy/react-native-vision-camera)\n- [react-native-worklets-core](https://github.com/margelo/react-native-worklets-core)\n\nYou must add them as dependencies to your project:\n\n```bash\nnpm install react-native-vision-camera react-native-worklets-core\n# or\nyarn add react-native-vision-camera react-native-worklets-core\n# or\npnpm add react-native-vision-camera react-native-worklets-core\n```\n\nThen you must follow their respective installation instructions:\n\n- [react-native-worklets-core](https://github.com/margelo/react-native-worklets-core#installation)\n\n## Quickstart\n\n```tsx\nimport {\n CameraHighlights,\n useBarcodeScanner,\n} from \"@mgcrea/vision-camera-barcode-scanner\";\nimport type { FunctionComponent } from \"react\";\nimport { StyleSheet } from \"react-native\";\n\nexport const App: FunctionComponent = () => {\n // @NOTE you must properly ask for camera permissions first!\n // You should use `PermissionsAndroid` for Android and `Camera.requestCameraPermission()` on iOS.\n\n const { props: cameraProps, highlights } = useBarcodeScanner({\n fps: 5,\n barcodeTypes: [\"qr\", \"ean-13\"], // optional\n onBarcodeScanned: (barcodes) => {\n \"worklet\";\n console.log(\n `Scanned ${barcodes.length} codes with values=${JSON.stringify(\n barcodes.map(({ value }) => value),\n )} !`,\n );\n },\n });\n\n const devices = useCameraDevices();\n const device = devices.find(({ position }) => position === \"back\");\n const format = useCameraFormat(device, [\n { videoResolution: { width: 1920, height: 1080 } },\n ]);\n if (!device) {\n return null;\n }\n\n return (\n \n \n \n \n );\n};\n```\n\n## Credits\n\nInspired by:\n\n- [rodgomesc/vision-camera-code-scanner](https://github.com/rodgomesc/vision-camera-code-scanner)\n\n## Authors\n\n- [Olivier Louvignes](https://github.com/mgcrea) <>\n\n## License\n\n```txt\nThe MIT License\n\nCopyright (c) 2023 Olivier Louvignes \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n```\n","readmeFilename":"README.md"}
![\"logo\"](\"./.github/assets/logo.png\"){kind=logo}
\n \n![\"npm](\"https://img.shields.io/npm/v/@mgcrea/vision-camera-barcode-scanner.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dt/@mgcrea/vision-camera-barcode-scanner.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/@mgcrea/vision-camera-barcode-scanner.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/l/@mgcrea/vision-camera-barcode-scanner.svg?style=for-the-badge\")
\n \n ![\"build](\"https://img.shields.io/github/actions/workflow/status/mgcrea/vision-camera-barcode-scanner/main.yml?style=for-the-badge&branch=master\")
![\"dependencies](\"https://img.shields.io/depfu/dependencies/github/mgcrea/vision-camera-barcode-scanner?style=for-the-badge\")