Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-native-code-scanner

Zvukamar19MIT1.0.6TypeScript support: included

react-native-code-scanner is a powerful and flexible library for scanning barcodes and QR codes in React Native applications.

react-native, code-scanner, barcode-scanner, scanner, qr-scanner, native-modules, ios, android, vision-camera

readme

React Native Code Scanner

React Native Code Scanner is a package designed to provide barcode scanning functionality within your React Native applications using the react-native-vision-camera library. With this package, you can easily integrate barcode scanning features into your mobile applications.

Inspiration

React Native Code Scanner was inspired by react-native-vision-camera and @mgcrea/vision-camera-barcode-scanner, you are Awesome!

Installation

To install React Native Code Scanner,
you must to first to install:

  • react-native-vision-camera
  • react-native-worklets-core
  • @mgcrea/vision-camera-barcode-scanner
  • react-native-reanimated
yarn add react-native-vision-camera
yarn add react-native-worklets-core
yarn add @mgcrea/vision-camera-barcode-scanner
yarn add react-native-reanimated

---- or via npm -----

npm i react-native-vision-camera
npm i react-native-worklets-core
npm i @mgcrea/vision-camera-barcode-scanner
npm i react-native-reanimated

Then you must follow worklets-core and reanimated respective installation instructions:

Then run

npx pod-install

iOS

To use the Camera you must first specify that your app requires camera permissions.
Open your project's Info.plist and add the following lines inside the outermost <dict> tag:

<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) needs access to your Camera.</string>

Android

<uses-permission android:name="android.permission.CAMERA" />

Usage

Importing the Scanner Component

import { CodeScanner } from 'react-native-code-scanner';

Example Usage

<CodeScanner
  barcodeTypes=['aztec' , 'codabar' , 'code-128' , 'code-39' , 'code-93' , 'data-matrix' , 'ean-13' , 'ean-8' , 'gs1-databar' , 'itf' , 'msi-plessey' , 'pdf-417' , 'qr' , 'upc-a' , 'upc-e']
  onScan={(barcode: string) => {
    console.log(barcode);
  }}
/>

Props

onScan: (barcode: string) => void;
barcodeTypes?: BarcodeType[];

Contributing

Contributions are welcome! If you find any issues or want to suggest improvements, feel free to open an issue or submit a pull request in the GitHub repository.

License

React Native Code Scanner is licensed under the MIT License.