Merge pull request #56 from rvndsngwn/master

## 3.4.1

Author: itsarvinddev

.flutter-plugins

@@ -1,2 +1,2 @@
 # This is a generated file; do not edit or check into version control.
-mobile_scanner=/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.3.0/
+mobile_scanner=/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.4.1/

.flutter-plugins-dependencies

@@ -1 +1 @@
-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.3.0/","native_build":true,"dependencies":[]}],"android":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.3.0/","native_build":true,"dependencies":[]}],"macos":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.3.0/","native_build":true,"dependencies":[]}],"linux":[],"windows":[],"web":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.3.0/","dependencies":[]}]},"dependencyGraph":[{"name":"mobile_scanner","dependencies":[]}],"date_created":"2023-07-03 13:36:32.059509","version":"3.10.5"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.4.1/","native_build":true,"dependencies":[]}],"android":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.4.1/","native_build":true,"dependencies":[]}],"macos":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.4.1/","native_build":true,"dependencies":[]}],"linux":[],"windows":[],"web":[{"name":"mobile_scanner","path":"/Users/arvind/.pub-cache/hosted/pub.dev/mobile_scanner-3.4.1/","dependencies":[]}]},"dependencyGraph":[{"name":"mobile_scanner","dependencies":[]}],"date_created":"2023-10-02 23:08:02.151393","version":"3.13.6"}

CHANGELOG.md

@@ -1,3 +1,17 @@
+## 3.4.1
+
+- Jump to 3.4.1 to match the version of mobile_scanner
+- Dependency updates
+- mobile_scanner: ^3.4.1
+- readme updated
+- topics added
+- Major changes in AiBarcodeScanner class
+- allowDuplicates, hintMargin, hintPadding, hintBackgroundColor, errorText and successText removed
+- hintWidget => bottomBar
+- hintText => bottomBarText
+- hintTextStyle => bottomBarTextStyle
+- appBar added
+
 ## 0.0.7-dev.1
 
 - error widget fixed

README.md

@@ -3,19 +3,7 @@
 [![pub package](https://img.shields.io/pub/v/ai_barcode_scanner.svg)](https://pub.dev/packages/ai_barcode_scanner)
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/juliansteenbakker?label=Sponsor%20Julian%20Steenbakker!)](https://github.com/sponsors/juliansteenbakker)
 
-### Note:
-
-_This plugin is based on the [mobile_scanner](https://pub.dev/packages/mobile_scanner) plugin by [steenbakker.dev](https://pub.dev/publishers/steenbakker.dev/packages)._
-
-_Huge thanks to [Julian Steenbakker](https://github.com/sponsors/juliansteenbakker)_ 🙏
-
-An universal barcode and QR code scanner for Flutter based on MLKit. Uses CameraX on Android, AVFoundation on iOS and Apple Vision & AVFoundation on macOS.
-
-### What's deferent from [mobile_scanner](https://pub.dev/packages/mobile_scanner)?
-
-_The only difference is that this plugin provides a ready to use UI widget with customizable options._
-
-### Preview of the widget
+### Screenshots 
 
 <table>
   <tr>
@@ -28,45 +16,61 @@ _The only difference is that this plugin provides a ready to use UI widget with
 </tr>
 </table>
 
+
+## Features Supported
+
+See the example app for detailed implementation information.
+
+| Features               | Android            | iOS                | macOS | Web |
+|------------------------|--------------------|--------------------|-------|-----|
+| analyzeImage (Gallery) | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| returnImage            | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| scanWindow             | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+| barcodeOverlay         | :heavy_check_mark: | :heavy_check_mark: | :x:   | :x: |
+
 ## Platform Support
 
 | Android | iOS | macOS | Web | Linux | Windows |
-| ------- | --- | ----- | --- | ----- | ------- |
-| ✅      | ✅  | ✅    | ✅  | ❌    | ❌      |
+|---------|-----|-------|-----|-------|---------|
+| ✔       | ✔   | ✔     | ✔   | :x:   | :x:     |
 
-## Platform specific setup
 
-### Android
 
+## Platform specific setup
+### Android
 This packages uses the **bundled version** of MLKit Barcode-scanning for Android. This version is more accurate and immediately available to devices. However, this version will increase the size of the app with approximately 3 to 10 MB. The alternative for this is to use the **unbundled version** of MLKit Barcode-scanning for Android. This version is older than the bundled version however this only increases the size by around 600KB.
 To use this version you must alter the mobile_scanner gradle file to replace `com.google.mlkit:barcode-scanning:17.0.2` with `com.google.android.gms:play-services-mlkit-barcode-scanning:18.0.0`. Keep in mind that if you alter the gradle files directly in your project it can be overriden when you update your pubspec.yaml. I am still searching for a way to properly replace the module in gradle but have yet to find one.
 
 [You can read more about the difference between the two versions here.](https://developers.google.com/ml-kit/vision/barcode-scanning/android)
 
 ### iOS
-
 **Add the following keys to your Info.plist file, located in <project root>/ios/Runner/Info.plist:**
 NSCameraUsageDescription - describe why your app needs access to the camera. This is called Privacy - Camera Usage Description in the visual editor.
 
 **If you want to use the local gallery feature from [image_picker](https://pub.dev/packages/image_picker)**
 NSPhotoLibraryUsageDescription - describe why your app needs permission for the photo library. This is called Privacy - Photo Library Usage Description in the visual editor.
 
 Example,
+  ```
+  <key>NSCameraUsageDescription</key>
+  <string>This app needs camera access to scan QR codes</string>
+  
+  <key>NSPhotoLibraryUsageDescription</key>
+  <string>This app needs photos access to get QR code from photo library</string>
+  ```
 
-```
-<key>NSCameraUsageDescription</key>
-<string>This app needs camera access to scan QR codes</string>
-
-<key>NSPhotoLibraryUsageDescription</key>
-<string>This app needs photos access to get QR code from photo library</string>
-```
 
 ### macOS
-
 Ensure that you granted camera permission in XCode -> Signing & Capabilities:
 
 <img width="696" alt="Screenshot of XCode where Camera is checked" src="https://user-images.githubusercontent.com/24459435/193464115-d76f81d0-6355-4cb2-8bee-538e413a3ad0.png">
 
+## Web
+This package uses ZXing on web to read barcodes so it needs to be included in `index.html` as script.
+```html
+<script src="https://unpkg.com/@zxing/[email protected]" type="application/javascript"></script>
+```
+
 ## Usage ([ai_barcode_scanner](https://pub.dev/packages/ai_barcode_scanner))
 
 Import `package:ai_barcode_scanner/ai_barcode_scanner.dart`, and use the widget with or without the controller.
@@ -90,7 +94,9 @@ AiBarcodeScanner(
 
 /// Example of using the barcode scanner with a controller.
 AiBarcodeScanner(
-        controller: MobileScannerController(),
+        controller: MobileScannerController(
+             detectionSpeed: DetectionSpeed.noDuplicates,
+           ),
           onScan: (String value) {
             debugPrint(value);
           },
@@ -117,6 +123,9 @@ AiBarcodeScanner(
 
 ## Usage ([mobile_scanner](https://pub.dev/packages/mobile_scanner))
 
+
+## Usage
+
 Import `package:mobile_scanner/mobile_scanner.dart`, and use the widget with or without the controller.
 
 If you don't provide a controller, you can't control functions like the torch(flash) or switching camera.
@@ -279,14 +288,14 @@ import 'package:mobile_scanner/mobile_scanner.dart';
 The onDetect function returns a BarcodeCapture objects which contains the following items.
 
 | Property name | Type          | Description                       |
-| ------------- | ------------- | --------------------------------- |
+|---------------|---------------|-----------------------------------|
 | barcodes      | List<Barcode> | A list with scanned barcodes.     |
 | image         | Uint8List?    | If enabled, an image of the scan. |
 
 You can use the following properties of the Barcode object.
 
 | Property name | Type           | Description                         |
-| ------------- | -------------- | ----------------------------------- |
+|---------------|----------------|-------------------------------------|
 | format        | BarcodeFormat  |                                     |
 | rawBytes      | Uint8List?     | binary scan result                  |
 | rawValue      | String?        | Value if barcode is in UTF-8 format |
@@ -306,142 +315,117 @@ You can use the following properties of the Barcode object.
 
 ```dart
   /// Function that gets Called when barcode is scanned successfully
-  ///
-  final void Function(String) onScan;
-
-  /// Function that gets called when a Barcode is detected.
-  ///
-  /// [barcode] The barcode object with all information about the scanned code.
-  /// [args] Information about the state of the MobileScanner widget
-  final void Function(BarcodeCapture)? onDetect;
-
-  /// Validate barcode text with [ValidateType]
-  /// [validateText] and [validateType] must be set together.
-  /// [validateText] now deprecated, use [validator] instead.
-  @Deprecated('Use [validator] instead. This will be removed in next version.')
-  final String? validateText;
-
-  /// Validate type [ValidateType]
-  /// Validator working with single string value only.
-  /// [validateText] and [validateType] now deprecated, use [validator] instead.
-  @Deprecated('Use [validator] instead. This will be removed in next version.')
-  final ValidateType? validateType;
-
-  /// Validate barcode text with a function
-  final bool Function(String value)? validator;
-
-  /// Set to false if you don't want duplicate barcode to be detected
-  final bool allowDuplicates;
-
-  /// Fit to screen
-  final BoxFit fit;
-
-  /// Barcode controller (optional)
-  final MobileScannerController? controller;
+///
+final void Function(String) onScan;
 
-  /// Show overlay or not (default: true)
-  final bool showOverlay;
+/// Function that gets called when a Barcode is detected.
+///
+/// [barcode] The barcode object with all information about the scanned code.
+/// [args] Information about the state of the MobileScanner widget
+final void Function(BarcodeCapture)? onDetect;
 
-  /// Overlay border color (default: white)
-  final Color borderColor;
+/// Validate barcode text with a function
+final bool Function(String value)? validator;
 
-  /// Overlay border width (default: 10)
-  final double borderWidth;
+/// Fit to screen
+final BoxFit fit;
 
-  /// Overlay color
-  final Color overlayColor;
+/// Barcode controller (optional)
+final MobileScannerController? controller;
 
-  /// Overlay border radius (default: 10)
-  final double borderRadius;
+/// Show overlay or not (default: true)
+final bool showOverlay;
 
-  /// Overlay border length (default: 30)
-  final double borderLength;
+/// Overlay border color (default: white)
+final Color borderColor;
 
-  /// Overlay cut out width (optional)
-  final double? cutOutWidth;
+/// Overlay border width (default: 10)
+final double borderWidth;
 
-  /// Overlay cut out height (optional)
-  final double? cutOutHeight;
+/// Overlay color
+final Color overlayColor;
 
-  /// Overlay cut out offset (default: 0)
-  final double cutOutBottomOffset;
+/// Overlay border radius (default: 10)
+final double borderRadius;
 
-  /// Overlay cut out size (default: 300)
-  final double cutOutSize;
+/// Overlay border length (default: 30)
+final double borderLength;
 
-  /// Hint widget (optional) (default: Text('Scan QR Code'))
-  /// Hint widget will be replaced the bottom of the screen.
-  /// If you want to replace the bottom screen widget, use [hintWidget]
-  final Widget? hintWidget;
+/// Overlay cut out width (optional)
+final double? cutOutWidth;
 
-  /// Hint text (default: 'Scan QR Code')
-  final String hintText;
+/// Overlay cut out height (optional)
+final double? cutOutHeight;
 
-  /// Hint margin
-  final EdgeInsetsGeometry hintMargin;
+/// Overlay cut out offset (default: 0)
+final double cutOutBottomOffset;
 
-  /// Hint padding
-  final EdgeInsetsGeometry hintPadding;
+/// Overlay cut out size (default: 300)
+final double cutOutSize;
 
-  /// Hint background color (optional)
-  final Color? hintBackgroundColor;
+/// Hint widget (optional) (default: Text('Scan QR Code'))
+/// Hint widget will be replaced the bottom of the screen.
+/// If you want to replace the bottom screen widget, use [bottomBar]
+final Widget? bottomBar;
 
-  /// Hint text style
-  final TextStyle hintTextStyle;
+/// Hint text (default: 'Scan QR Code')
+final String bottomBarText;
 
-  /// Show error or not (default: true)
-  final bool showError;
+/// Hint text style
+final TextStyle bottomBarTextStyle;
 
-  /// Error color (default: red)
-  final Color errorColor;
+/// Show error or not (default: true)
+final bool showError;
 
-  /// Error text (default: 'Invalid BarCode')
-  final String errorText;
+/// Error color (default: red)
+final Color errorColor;
 
-  /// Show success or not (default: true)
-  final bool showSuccess;
+/// Show success or not (default: true)
+final bool showSuccess;
 
-  /// Success color (default: green)
-  final Color successColor;
+/// Success color (default: green)
+final Color successColor;
 
-  /// Success text (default: 'BarCode Found')
-  final String successText;
+/// Can auto back to previous page when barcode is successfully scanned (default: true)
+final bool canPop;
 
-  /// Can auto back to previous page when barcode is successfully scanned (default: true)
-  final bool canPop;
+/// The function that builds an error widget when the scanner
+/// could not be started.
+///
+/// If this is null, defaults to a black [ColoredBox]
+/// with a centered white [Icons.error] icon.
+final Widget Function(BuildContext, MobileScannerException, Widget?)?
+errorBuilder;
 
-  /// The function that builds an error widget when the scanner
-  /// could not be started.
-  ///
-  /// If this is null, defaults to a black [ColoredBox]
-  /// with a centered white [Icons.error] icon.
-  final Widget Function(BuildContext, MobileScannerException, Widget?)?
-      errorBuilder;
+/// The function that builds a placeholder widget when the scanner
+/// is not yet displaying its camera preview.
+///
+/// If this is null, a black [ColoredBox] is used as placeholder.
+final Widget Function(BuildContext, Widget?)? placeholderBuilder;
 
-  /// The function that builds a placeholder widget when the scanner
-  /// is not yet displaying its camera preview.
-  ///
-  /// If this is null, a black [ColoredBox] is used as placeholder.
-  final Widget Function(BuildContext, Widget?)? placeholderBuilder;
+/// The function that signals when the barcode scanner is started.
+final void Function(MobileScannerArguments?)? onScannerStarted;
 
-  /// The function that signals when the barcode scanner is started.
-  final void Function(MobileScannerArguments?)? onScannerStarted;
+/// Called when this object is removed from the tree permanently.
+final void Function()? onDispose;
 
-  /// Called when this object is removed from the tree permanently.
-  final void Function()? onDispose;
+/// if set barcodes will only be scanned if they fall within this [Rect]
+/// useful for having a cut-out overlay for example. these [Rect]
+/// coordinates are relative to the widget size, so by how much your
+/// rectangle overlays the actual image can depend on things like the
+/// [BoxFit]
+final Rect? scanWindow;
 
-  /// if set barcodes will only be scanned if they fall within this [Rect]
-  /// useful for having a cut-out overlay for example. these [Rect]
-  /// coordinates are relative to the widget size, so by how much your
-  /// rectangle overlays the actual image can depend on things like the
-  /// [BoxFit]
-  final Rect? scanWindow;
+/// Only set this to true if you are starting another instance of mobile_scanner
+/// right after disposing the first one, like in a PageView.
+///
+/// Default: false
+final bool? startDelay;
 
-  /// Only set this to true if you are starting another instance of mobile_scanner
-  /// right after disposing the first one, like in a PageView.
-  ///
-  /// Default: false
-  final bool? startDelay;
+/// Appbar widget
+/// you can use this to add appbar to the scanner screen
+///
+final PreferredSizeWidget? appBar;
 
 ```