barcode_scan2 - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #go #android #linux #docker #java #kubernetes #vue #awesome-list #security

barcode_scan2

(★ 98)

[reborned barcode_scan] A flutter plugin for reading 2D barcodes and QR codes.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - publish.yml
- FUNDING.yml
- launch.json
- .gitignore
- build.gradle
- gradle.properties
- proguard-rules.pro
- settings.gradle
- - .gitignore
  - build.gradle.kts
  - gradle.properties
  - settings.gradle.kts
- - .gitignore
  - Podfile
  - Podfile.lock
- - main.dart
- - .keep
- .gitignore
- .metadata
- analysis_options.yaml
- pubspec.yaml
- README.md
- - .gitkeep
- - Package.swift
- .gitignore
- barcode_scan2.podspec
- - android_options.dart
  - model.dart
  - scan_options.dart
  - scan_result.dart
- barcode_scan2.dart
- platform_wrapper.dart
- android_configuration.proto
- barcode_format.proto
- configuration.proto
- protos.proto
- scan_result.proto
- .keep
.gitignore
.metadata
analysis_options.yaml
CHANGELOG.md
generate_proto.sh
LICENSE
pubspec.lock
pubspec.yaml
README.md
UPGRADE.md

# Installation Guide

1. Get the code

git clone https://github.com/mono0926/barcode_scan2

Downloads the entire project code from GitHub to your computer.

cd barcode_scan2

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![GitHub license](https://img.shields.io/github/license/mono0926/barcode_scan2.svg)](https://github.com/mono0926/barcode_scan2/blob/master/LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/mono0926/barcode_scan2)](https://github.com/mono0926/barcode_scan2/stargazers)
[![Pub](https://img.shields.io/pub/v/barcode_scan2.svg)](https://pub.dartlang.org/packages/barcode_scan2)
[![GitHub forks](https://img.shields.io/github/forks/mono0926/barcode_scan2)](https://github.com/mono0926/barcode_scan2/network)

## Reborned🎉

Original [barcode_scan](https://pub.dev/packages/barcode_scan) was discontinued, so [barcode_scan2](https://pub.dev/packages/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](https://kotlinlang.org/docs/tutorials/kotlin-android.html#installing-the-kotlin-plugin).

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

```groovy
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:

```groovy
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:

```yaml
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

```xml
<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

```dart
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:

```dart
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:

```bash
$ brew install protobuf
$ brew install swift-protobuf
```

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

Activate the protobuf dart plugin:

```bash
$ flutter pub global activate protoc_plugin
```

Install the`Protobuf 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](https://stackoverflow.com/a/53358817))