0.1.1 • Published 2 years ago

react-native-barcodes-detector v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Header

Detect different barcodes in static images directly on React Native. This library has a TypeScript-first support and uses Google ML Kit under the hood 🤖.

The supported barcodes are:

🏗 Installation

# Install
npm install react-native-barcodes-detector

# Link
cd ios && pod install

⚡️ Usage

Take a look at the example to see a use-case with react-native-image-picker (it's really short, I promise 🙏).

Anyway, this is the tl;dr:

import { detectBarcodes, BarcodeFormat } from "react-native-barcodes-detector";

// This is the local image url usually retrieved
// through libraries like `react-native-image-picker`.
const imageUrl = "file://..."

// The `detectBarcodes` function needs the image url and
// a list of formats to detect. Using an empty array all
// the supported formats will be used making the detection
// process slower 🐌.
const formats = [BarcodeFormat.QR_CODE]

detectBarcodes(imageUrl, formats)
  .then(barcodes => {
    // Here `barcodes` will contain a list
    // of detected barcodes.
  })

🙋 FAQ

Where is the detection process actually done?

This library uses Google ML Kit to recognize barcodes, and this process is completely done on the physical device.

Why I can't detect a Data Matrix code?

For a Data Matrix to be recognized it must intersect the center of the image, as stated here. This means that only one Data Matrix code can be recognized per image.

⚖️ License

React Native Barcodes Detector is under the MIT license.