qrscan_plus 2.0.0

A Plug-in for dart, which help you scanning and Generating barcode and qrcode with Android and IOS Device.

qrscan_plus

A lightweight Flutter plugin for scanning QR codes & barcodes via camera or gallery,
and generating QR code images — with full Android & iOS support. No JitPack required.

---

✨ Features

• 📷 Camera scan — launch the device camera to scan any QR code or barcode in real time
• 🖼 Gallery scan — pick an image with the system photo picker and decode it (no storage permissions)
• 📁 Path scan — decode a barcode from a local file path
• 🔢 Bytes scan — decode a barcode directly from raw Uint8List bytes
• 🏗 QR code generator — generate a QR code image from any string
• ✅ No JitPack — Android dependencies are on Maven Central; no extra Gradle config needed
• 🍎 iOS 13+ with native AVFoundation & Vision — Swift Package Manager and CocoaPods supported

---

📋 Requirements

	Minimum	Notes
Flutter	3.38 (Dart 3.10)	Tested on Flutter 3.41 and 3.47
Android	API 24 (Android 7.0)	Compiled against API 36 (Android 16); Java 17
iOS	13.0	Tested with Xcode 26 / iOS 26 SDK

---

📱 Platform Support

Method	Android	iOS	Description
scan()	✅	✅	Scan via live camera
scanPhoto()	✅	✅	Scan from gallery image
scanPath(path)	✅	✅	Scan from a file path
scanBytes(bytes)	✅	✅	Scan from raw byte data
generateBarCode(text)	✅	✅	Generate a QR code image

Note: generateBarCode returns PNG bytes on both platforms.

---

🚀 Installation

Add to your pubspec.yaml:

dependencies:
  qrscan_plus: ^2.0.0

Then run:

flutter pub get

---

🤖 Android Setup

No additional Gradle repository setup is needed. All dependencies are on Maven Central.

Make sure your app's minSdk is at least 24 (the Flutter default).

Permissions

The plugin's manifest already declares the camera permission. The camera permission is requested at runtime when scan() opens the scanner.

scanPhoto() uses the system photo picker on Android 13+ (and the gallery picker on older versions) — no storage or media permissions are required for this plugin. If your app directly accesses files or media, handle runtime permissions based on your Android version separately.

---

🍎 iOS Setup

Minimum deployment target: iOS 13.0

Add the following key to your ios/Runner/Info.plist:

<key>NSCameraUsageDescription</key>
<string>This app needs camera access to scan QR codes and barcodes.</string>

scanPhoto() uses the system photo picker, which runs outside your app, so NSPhotoLibraryUsageDescription is not required.

---

📖 Usage

Import

import 'package:qrscan_plus/qrscan_plus.dart' as scanner;

Scan via Camera

final String? result = await scanner.scan();
if (result != null) {
  print('Scanned: $result');
}

Scan from Gallery

final String? result = await scanner.scanPhoto();
if (result != null) {
  print('From gallery: $result');
}

Scan from File Path

final String? result = await scanner.scanPath('/storage/emulated/0/Download/qr.png');
if (result != null) {
  print('From path: $result');
}

Scan from Bytes

// e.g. bytes from image_picker or a network image
final Uint8List bytes = ...;
final String? result = await scanner.scanBytes(bytes);
if (result != null) {
  print('From bytes: $result');
}

Generate a QR Code Image

final Uint8List? qrImage = await scanner.generateBarCode('https://github.com/itxmubi/qrscan_plus');

// Display it in your app:
if (qrImage != null) {
  Image.memory(qrImage);
}

---

🛡 Error Handling

The scan methods return null when the user cancels or no code is found. Wrap calls in a try-catch to handle permission and image errors gracefully:

import 'package:flutter/services.dart';

try {
  final String? result = await scanner.scan();
  if (result != null) {
    // handle result
  }
} on PlatformException catch (e) {
  print('Error code: ${e.code}');
  print('Error message: ${e.message}');
}

Common error codes:

Code	Meaning
PERMISSION_DENIED	Camera permission was denied (iOS)
BUSY	A scan() or scanPhoto() call is already in progress
INVALID_ARGUMENT / INVALID_PATH	Null or empty input passed to scanBytes / scanPath
INVALID_IMAGE / INVALID_IMAGE_BYTES / IMAGE_LOAD_FAILED	The image could not be decoded
SCAN_FAILED	Reading the selected image failed

---

⬆️ Migrating from 1.x

• All scan methods now return Future<String?> and generateBarCode() returns Future<Uint8List?>. Handle null (cancelled / nothing found) instead of catching a TypeError.
• Raise your Android minSdk to 24 and your iOS deployment target to 13.0 if they are lower.
• You can remove NSPhotoLibraryUsageDescription from Info.plist if nothing else in your app needs it.

---

🆚 Why qrscan_plus?

Feature	qrscan_plus	qr_code_scanner_plus	mobile_scanner
No JitPack required	✅	❌	✅
scanBytes() support	✅	❌	❌
scanPath() support	✅	❌	❌
QR code generation	✅	❌	❌
iOS 13+ support	✅	✅	✅
Zero native iOS dependencies	✅	❌	❌
Maven Central only (Android)	✅	❌	✅

---

🗂 Changelog

See CHANGELOG.md for the full version history.

Latest — v2.0.0:

• Updated for the latest Flutter (3.47), Android 16 (API 36) and iOS 26
• Nullable return types — null when a scan is cancelled or no code is found
• Android 13+ system photo picker; iOS PHPickerViewController — no photo permissions needed
• Swift Package Manager support and privacy manifest on iOS

---

🤝 Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

1. Fork the repository
2. Create your feature branch: git checkout -b feature/my-feature
3. Commit your changes: git commit -m 'feat: add my feature'
4. Push to the branch: git push origin feature/my-feature
5. Open a Pull Request

---

📬 Links

• 📦 pub.dev package
• 🐛 Issue tracker
• 📖 API reference
• 💻 Repository

---

📄 License

MIT © itxmubi

See LICENSE for full details.