Search packages, repositories and app categories

Package detailsv4.9.0

barcode_scan2

A flutter plugin for scanning 2D barcodes and QRCodes via camera.

AndroidiOS
30-day downloads
20.5K
Likes
307
Pub points
160

Install package

flutter pub add barcode_scan2

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

barcode_scan2 is a Flutter plugin that enables scanning of 2D barcodes and QR codes using the device's camera. It provides a simple, reliable interface for integrating barcode scanning functionality into Flutter applications. The plugin supports both Android and iOS platforms, making it suitable for cross-platform mobile development. With minimal setup, developers can quickly add scanning capabilities to apps used in retail, logistics, ticketing, and more. The source code is publicly available on GitHub for transparency and customization.

Use cases

  • Retail inventory management
  • Event ticket scanning
  • Product information lookup
  • Logistics tracking
  • User authentication via QR codes

Key features

  • Real-time barcode scanning
  • Support for 2D barcodes and QR codes
  • Cross-platform compatibility (Android & iOS)
  • Simple integration with Flutter
  • Open-source and customizable

Suitable for

  • Mobile apps needing barcode scanning
  • Developers building inventory or ticketing systems
  • Projects requiring quick QR code data retrieval
  • Apps targeting both Android and iOS users

Considerations

  • Requires camera permissions on both platforms
  • May need additional UI components for optimal user experience
  • Performance depends on device camera quality

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

GitHub license GitHub stars Pub GitHub forks

Reborned🎉

Original barcode_scan was discontinued, so barcode_scan2 was borned with sound null safety support🎉

barcode_scan2

A flutter plugin for scanning 2D barcodes and QR codes.

This provides a simple wrapper for two commonly used iOS and Android libraries:

  • iOS: https://github.com/mikebuss/MTBBarcodeScanner
  • Android: https://github.com/dm77/barcodescanner
Features
  • [x] Scan 2D barcodes
  • [x] Scan QR codes
  • [x] Control the flash while scanning
  • [x] Permission handling

Getting Started

Android

For Android, you must do the following before you can use the plugin:

  • Add the camera permission to your AndroidManifest.xml

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

  • This plugin is written in Kotlin. Therefore, you need to add Kotlin support to your project. See installing the Kotlin plugin.

Edit your project-level build.gradle file to look like this:

buildscript {
    ext.kotlin_version = '1.3.61'
    // ...
    dependencies {
        // ...
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}
// ...

Edit your app-level build.gradle file to look like this:

apply plugin: 'kotlin-android'
// ...
dependencies {
    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
    // ...
}

Now you can depend on the barcode_scan plugin in your pubspec.yaml file:

dependencies:
    # ...
    barcode_scan2: any

Click "Packages get" in Android Studio or run flutter packages get in your project folder.

iOS

To use on iOS, you must add the the camera usage description to your Info.plist

<dict>
    <!-- ... -->
    <key>NSCameraUsageDescription</key>
    <string>Camera permission is required for barcode scanning.</string>
    <!-- ... -->
</dict>
iOS 26+ Compatibility

This fork includes a fix for the 10-15 second delay when dismissing the scanner on iOS 26+. The fix is built-in - no additional configuration required.

Usage

import 'package:barcode_scan2/barcode_scan2.dart';

void main() async {
  var result = await BarcodeScanner.scan();

  print(result.type); // The result type (barcode, cancelled, failed)
  print(result.rawContent); // The barcode content
  print(result.format); // The barcode format (as enum)
  print(result.formatNote); // If a unknown format was scanned this field contains a note
}

Advanced usage

You can pass options to the scan method:

import 'package:barcode_scan2/barcode_scan2.dart';

void main() async {

  var options = ScanOptions(
    // set the options
  );

  var result = await BarcodeScanner.scan(options: options);

  // ...
}
Supported options
Option Type Description Supported by
strings.cancel String The cancel button text on iOS iOS only
strings.flash_on String The flash on button text iOS + Android
strings.flash_off String The flash off button text iOS + Android
restrictFormat BarcodeFormat[] Restrict the formats which are recognized iOS + Android
useCamera int The index of the camera which is used for scanning (See BarcodeScanner.numberOfCameras) iOS + Android
autoEnableFlash bool Enable the flash when start scanning iOS + Android
android.aspectTolerance double Enable auto focus on Android Android only
android.useAutoFocus bool Set aspect ratio tolerance level used in calculating the optimal Camera preview size Android only
android.appBarTitle String Sets the text of the app bar Android only

Development setup

Setup protobuf

Mac:

$ brew install protobuf
$ brew install swift-protobuf

Windows / Linux: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation

Activate the protobuf dart plugin:

$ flutter pub global activate protoc_plugin

Install theProtobuf Support plugin for IDEA / Android Studio or vscode-proto3 for VS Code

If you changed the protos.proto you've to execute the ./generate_proto.sh to update the dart / swift sources

Common problems

Android "Could not find org.jetbrains.kotlin:kotlin-stdlib-jre..."

Change org.jetbrains.kotlin:kotlin-stdlib-jre to org.jetbrains.kotlin:kotlin-stdlib-jdk (StackOverflow)

Categories

Dependencies

Dependency list 1 items

Source repository

Projects using this package