Flutter ZXing is a high-performance Flutter plugin for scanning and generating QR codes and barcodes. Built on the powerful ZXing C++ library, it provides fast and reliable barcode processing capabilities for Flutter applications. Whether you need to scan barcodes from the camera or generate custom QR codes, Flutter ZXing makes it seamless and efficient.
Left: Barcode Scanner, Right: QR Code Creator
- Scan QR codes and barcodes from the camera stream (on mobile platforms only), image file, or URL.
- Scan multiple barcodes at once from the camera stream (on mobile platforms only), image file, or URL.
- Generate QR codes with customizable content and size.
- Return the position points of the scanned barcode.
- Customizable scanner frame size and color, and the ability to enable or disable features like torch and pinch to zoom.
| Linear product | Linear industrial | Matrix |
|---|---|---|
| UPC-A | Code 39 | QR Code |
| UPC-E | Code 93 | Micro QR Code |
| EAN-8 | Code 128 | rMQR Code |
| EAN-13 | Codabar | Aztec |
| DataBar | DataBar Expanded | DataMatrix |
| ITF | PDF417 | |
| MaxiCode (partial) |
| Platform | Status | Notes |
|---|---|---|
| Android | ✅ Fully Supported | Minimum API level 21 |
| iOS | ✅ Fully Supported | Minimum iOS 11.0 |
| MacOS | Without Camera support | |
| Linux | Without Camera support | |
| Windows | Without Camera support | |
| Web | ❌ Not Supported | Dart FFI is not available on the web |
Note: Flutter ZXing relies on the Dart FFI feature, making it unsupported on the web. Camera-based scanning is only available on mobile platforms.
ZXScanner is a free QR code and barcode scanner app for Android and iOS. It is built using Flutter and the flutter_zxing plugin.
- Fast and reliable QR code and barcode scanning.
- Built-in support for multiple barcode formats.
- Fully open-source and customizable.
To learn more or contribute, visit the ZXScanner repository.
To clone the flutter_zxing project from Github which includes submodules, use the following command:
git clone --recursive https://github.com/khoren93/flutter_zxing.gitUse Melos to install the dependencies of the flutter_zxing project. Melos is a tool that helps you manage multiple Dart packages in a single repository. To install Melos, use the following command:
flutter pub global activate melosTo install the dependencies of the flutter_zxing project, use the following command:
melos bootstrapTo allow the building on iOS and MacOS, you need to run the following command:
./scripts/update_ios_macos_src.shTo run the integration tests:
cd example
flutter test integration_testNow you can run the flutter_zxing example app on your device or emulator.
If you want to use a forked version of the flutter_zxing library in your project, you can specify it using dependency_overrides in your pubspec.yaml. However, be aware that flutter_zxing relies on the ZXing C++ code included as a git submodule. When using dependency_overrides with a git repository, these submodules are not automatically included, and the update_ios_macos_src.sh script is not run, which can lead to errors, especially on iOS.
Your project might build but encounter runtime errors due to missing library exports that appear as an error like this: flutter: type 'ArgumentError' is not a subtype of type 'Code' in type cast
To ensure all necessary files are present, it's recommended to add your forked repository as a git submodule, initialize the submodules recursively, and reference it using a local path. Follow these steps:
- In your project add your fork as a submodule and initialize it recursively.
git submodule add https://github.com/YourUsername/flutter_zxing.git flutter_zxing
git submodule update --init --recursive- Add your submodule to your
pubspec.yamlfile as apathdependency override.
dependency_overrides:
flutter_zxing:
path: ./flutter_zxing- Run
flutter pub getto install the dependencies. - Run the
scripts/update_ios_macos_src.shscript to update the iOS and MacOS source files. (Or add it to your own projects build process) - Run
flutter cleanto clear the build cache. - Build and run your project.
Referencing your forked repo as a direct git reference in the depenency_overrides section of the pubspec.yaml does not include submodules or run the update_ios_macos_src.sh script. Manually running these steps in the .pub-cache directory is not practical, since the path changes with each commit.
import'package:flutter_zxing/flutter_zxing.dart';
// Use ReaderWidget to quickly read barcode from camera image@overrideWidgetbuild(BuildContext context) {
returnScaffold(
body:ReaderWidget(
onScan: (result) async {
// Do something with the result
},
),
);
}
// Or use flutter_zxing plugin methods // To read barcode from camera image directlyawait zx.startCameraProcessing(); // Call this in initState
cameraController?.startImageStream((image) async {
Code result =await zx.processCameraImage(image);
if (result.isValid) {
debugPrint(result.text);
}
returnnull;
});
zx.stopCameraProcessing(); // Call this in dispose// To read barcode from XFile, String, url or Uint8List bytesXFile xFile =XFile('Your image path');
Code? resultFromXFile =await zx.readBarcodeImagePath(xFile);
String path ='Your local image path';
Code? resultFromPath =await zx.readBarcodeImagePathString(path);
String url ='Your remote image url';
Code? resultFromUrl =await zx.readBarcodeImageUrl(url);
Uint8List bytes =Uint8List.fromList(yourImageBytes);
Code? resultFromBytes =await zx.readBarcode(bytes);import'package:flutter_zxing/flutter_zxing.dart';
import'dart:typed_data';
import'package:image/image.dart'as imglib;
// Use WriterWidget to quickly create barcode@overrideWidgetbuild(BuildContext context) {
returnScaffold(
body:WriterWidget(
onSuccess: (result, bytes) {
// Do something with the result
},
onError: (error) {
// Do something with the error
},
),
);
}
// Or use FlutterZxing to create barcode directlyfinalEncode result = zx.encodeBarcode(
contents:'Text to encode',
params:EncodeParams(
format:Format.QRCode,
width:120,
height:120,
margin:10,
eccLevel:EccLevel.low,
),
);
if (result.isValid && result.data !=null) {
final img = imglib.Image.fromBytes(width, height, result.data!.buffer, numChannels:1);
finalUint8List encodedBytes = imglib.encodePng(img);
// use encodedBytes as you wish
}MIT License. See LICENSE.