Flutter plugin for scanning and generating QR codes using the ZXing library, supporting Android, iOS, and desktop platforms
flutterbarcode-generatorbarcode-scannergeneratorqrqrcodeqrcode-generatorqrcode-scannerscannerzxingbarcodezxscanner
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Khoren Markosyan
fae705a1de
|
2 years ago | |
---|---|---|
.github | 2 years ago | |
.vscode | 2 years ago | |
android | 2 years ago | |
example | 2 years ago | |
ios | 2 years ago | |
lib | 2 years ago | |
test | 2 years ago | |
zxscanner | 2 years ago | |
.gitignore | 3 years ago | |
.metadata | 3 years ago | |
CHANGELOG.md | 2 years ago | |
LICENSE | 3 years ago | |
README.md | 2 years ago | |
analysis_options.yaml | 2 years ago | |
init.sh | 2 years ago | |
init_win.ps1 | 2 years ago | |
melos.yaml | 2 years ago | |
pubspec.yaml | 2 years ago |
README.md
flutter_zxing
A barcode and QR code scanner based on ZXing C++ library natively in Flutter with Dart FFI.
Demo Screenshots
Supported Barcode Formats
1D product | 1D industrial | 2D |
---|---|---|
UPC-A | Code 39 | QR Code |
UPC-E | Code 93 | DataMatrix |
EAN-8 | Code 128 | Aztec |
EAN-13 | Codabar | PDF417 |
DataBar | ITF | MaxiCode (beta) |
DataBar Expanded |
Features
- Scan barcode from camera stream, image path or url
- Scan multiple barcodes from camera stream, image path or url
- Create barcode from text
- Return scanned barcode position points
- Flashlight and pinch to zoom support
Todo
- Write tests
Getting Started
To read barcode
import 'package:flutter_zxing/flutter_zxing.dart';
// Use ReaderWidget to quickly read barcode from camera image
@override
Widget build(BuildContext context) {
return Scaffold(
body: ReaderWidget(
onScan: (result) async {
// Do something with the result
},
),
),
);
// Or use flutter_zxing plugin methods
// To read barcode from camera image directly
await zx.startCameraProcessing(); // Call this in initState
cameraController?.startImageStream((image) async {
Code result = await zx.processCameraImage(image);
if (result.isValid) {
debugPrint(result.text);
}
return null;
});
zx.stopCameraProcessing(); // Call this in dispose
// To read barcode from XFile, String, url or Uint8List bytes
XFile 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);
To create barcode
import 'package:flutter_zxing/flutter_zxing.dart';
import 'dart:typed_data';
import 'package:image/image.dart' as imglib;
// Use WriterWidget to quickly create barcode
@override
Widget build(BuildContext context) {
return Scaffold(
body: WriterWidget(
onSuccess: (result, bytes) {
// Do something with the result
},
onError: (error) {
// Do something with the error
},
),
),
);
// Or use FlutterZxing to create barcode directly
final Encode result = zx.encodeBarcode(
contents: 'Text to encode',
params: EncodeParams(
format: Format.QRCode,
width: 120,
height: 120,
margin: 10,
eccLevel: EccLevel.low,
),
);
if (result.isValid) {
final img = imglib.Image.fromBytes(width, height, result.bytes);
final encodedBytes = Uint8List.fromList(imglib.encodeJpg(img));
// use encodedBytes as you wish
}
License
MIT License. See LICENSE.