/document_scanner_kit

Flutter Document Scanner Plugin that uses MLKit for android and VisionKit for iOS.

Primary LanguageDart

Document Scanner Kit

pub package coverage style: very good analysis License: MIT

Generated by the Very Good CLI 🤖

Plugin is under development right now.

Flutter plugin that scans documents with using MLKit for Android and VisionKit for iOS.

Project Setup

Follow the steps below to set up your Flutter project on Android and iOS

Android

Requirements

  • minSdkVersion: 21
  • targetSdkVersion: 33
  • compileSdkVersion: 34

iOS

Minimum Version Configuration

Ensure you meet the minimum version requirements to run the application on iOS devices. In the ios/Podfile file, make sure the iOS platform version is at least 13.0:

platform :ios, '13.0'

Permission Configuration

Add a String property to the app's Info.plist file with the key NSCameraUsageDescription and the value as the description for why your app needs camera access.

<key>NSCameraUsageDescription</key>
<string>Camera Usage is Required</string>

Using

import 'package:document_scanner_kit/document_scanner_kit.dart' as DocumentScanner;

// Check Permissions before use for iOS, Android doesn't need camera usage permission.

try {
    final result = await DocumentScanner.scan();
    if(result != null) {
        // Do whatever you need with paths.
    } else {
        // Scan process canceled
    }
} catch (e) {
    // Handle Error
}

[fluttium_install]: https://fluttium.dev/docs/getting-started/installing-cli# document_scanner_kit