Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fluttercandies/scan_barcode
Barcode/QRCode scan, base of google mikit.
https://github.com/fluttercandies/scan_barcode
dart flutter flutter-plugin qrcode
Last synced: 2 months ago
JSON representation
Barcode/QRCode scan, base of google mikit.
- Host: GitHub
- URL: https://github.com/fluttercandies/scan_barcode
- Owner: fluttercandies
- License: apache-2.0
- Created: 2023-01-31T07:09:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T10:18:02.000Z (7 months ago)
- Last Synced: 2024-06-24T11:54:49.303Z (7 months ago)
- Topics: dart, flutter, flutter-plugin, qrcode
- Language: Dart
- Homepage:
- Size: 398 KB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# scan_barcode
The plugin is a plugin for scanning barcodes. Only support android and ios. Because the plugin is based on Google mlkit.
See apk in [release](https://github.com/fluttercandies/scan_barcode/releases)
## Getting Started
```yaml
dependencies:
scan_barcode: ^0.2.0
```
```yaml
scan_barcode:
git:
url: https://github.com/FlutterCandies/scan_barcode.git
ref: git-ref
```
```yaml
scan_barcode:
git:
url: https://gitee.com/kikt/scan_barcode.git
ref: git-ref
```
See the package [scan_barcode](https://pub.dev/packages/scan_barcode) for more version.
`import 'package:scan_barcode/scan_barcode.dart';`
The plugin is developed by version 3.7.0 of flutter, so it is recommended to use version 3.1.0 or above.
If you want to use the package of Flutter 2.x, click [here](#using-in-flutter-2x).
## Contents
The package has the following important classes:
- [BarcodeWidget](#barcodewidget)
- [BarcodeConfig](#barcodeconfig)
### BarcodeWidget
In most cases, we will use this component to complete code scanning.
### BarcodeConfig
This class is used to configure the scanning config. And, hold instance to update config.
The config has the following parts:
- CameraConfig: The camera config.
- BarcodeConfig: The barcode config.
- UIConfig: The UI config.
## Example
See the [example](./example/lib/examples) for more examples.
### One shot scan code
If you want to scan a code once, you can use the example.
Click to expand code
```dart
Future _scanBarcode() async {
final barcodes = await Navigator.push>(
context,
MaterialPageRoute(
builder: (context) => const ScanAndPopPageExample(),
),
);
if (barcodes == null) return;
showBarcodeListDialog(context, barcodes); // show barcode list dialog to display barcode.
}
```
```dart
import 'package:flutter/material.dart';
import 'package:scan_barcode/scan_barcode.dart';
class ScanAndPopPageExample extends StatefulWidget {
const ScanAndPopPageExample({Key? key}) : super(key: key);
@override
State createState() => _ScanAndPopPageExampleState();
}
class _ScanAndPopPageExampleState extends State {
var isPop = false;
@override
Widget build(BuildContext context) {
return BarcodeWidget(
onHandleBarcodeList: (List barcode) async {
if (isPop) { // Prevent multiple pop
return;
}
if (barcode.isEmpty) return;
isPop = true;
Navigator.of(context).pop(barcode);
},
scanValue: ScanValue(),
);
}
}
```
### Scan and show dialog in current page
Click to expand code
```dart
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:scan_barcode/scan_barcode.dart';
class ShowDialogExample extends StatelessWidget {
const ShowDialogExample({
Key? key,
}) : super(key: key);
@override
Widget build(BuildContext context) {
return BarcodeScanPage(
title: 'Show dialog when scanned',
onHandleBarcodeList: (List barCode) async {
if (barCode.isEmpty) return;
await showBarcodeListDialog(
context, barCode); // The await is important, if you don't await, multiple dialogs will be shown.
},
);
}
Future showBarcodeListDialog(BuildContext context, List barCode) async {
await showDialog(
context: context,
builder: (context) =>
AlertDialog(
title: const Text('Barcode list'),
content: Column(
mainAxisSize: MainAxisSize.min,
children: [
for (final barcode in barCode)
ListTile(
title: Text(barcode.rawValue ?? ''),
subtitle:
Text('type: ${barcode.type}, format: ${barcode.format}'),
trailing: IconButton(
icon: const Icon(Icons.copy),
onPressed: () {
Clipboard.setData(
ClipboardData(text: barcode.rawValue ?? ''),
);
},
),
),
],
),
actions: [
ElevatedButton(
onPressed: () {
Navigator.of(context).pop();
},
child: const Text('OK'),
),
],
),
);
}
}
```
### Examples
- [How to change config](example/lib/examples/change_camera_config_example.dart)
- [How to custom barcode rect](example/lib/examples/change_qrcode_rect.dart)
- [One shot scan](example/lib/examples/scan_and_pop_page_example.dart)
- [Show the barcode list dialog when scanned](example/lib/examples/show_dialog_example.dart)
## dependencies
- [flutter](https://github.com/flutter/flutter)
- [camera](https://pub.dev/packages/camera)
- [google_mlkit_barcode_scanning](https://pub.dev/packages/google_mlkit_barcode_scanning)
## Common
### Using in flutter 2.x
Because of the upstream API modification, only `0.1.0` can be used on Flutter 2.x.x.
Add the following code to your `pubspec.yaml`:
```yaml
dependencies:
scan_barcode: ^0.1.0
dependency_overrides:
google_mlkit_barcode_scanning:
git:
url: https://gitee.com/kikt/Google-Ml-Kit-plugin.git
ref: barcode-0.5.0-forked
path: packages/google_mlkit_barcode_scanning
```
## LICENSE
Apache License 2.0