GitHub repositoryeliasteeny/flutter_document_scanner

flutter_document_scanner

Document scanner plugin ported from react native to flutter

flutter_document_scanner project cover
Stars
41
Forks
27
Last push (UTC)
Jun 29, 2023
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

document_scanner

A platform view plugin for Flutter apps that adds document scanning functionality on Android/IOS.

Warning

Document Scanner customization options aren't working for now

Setup

Handle camera access permission

IOS

Add a boolean property to the app's Info.plist file with the key io.flutter.embedded_views_preview and the value true to enable embedded views preview.

<key>io.flutter.embedded_views_preview</key>
<true/>

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 Permission Description</string>
Android

minSdkVersion should be at least 19

How to use ?

first add as a dependency in pubspec.yaml

import:

import 'package:document_scanner/document_scanner.dart';

then use it as a widget:

File scannedDocument;

DocumentScanner(
    onDocumentScanned: (ScannedImage scannedImage) {
        print("document : " + scannedImage.croppedImage);
        scannedDocument = scannedImage.getScannedDocumentAsFile();
    },
                          
)

Credits

This is a React Native package implemented on Flutter.

Reference to the React Native package : https://github.com/Michaelvilleneuve/react-native-document-scanner

Contributing

Step 1
  • Fork this project's repo : https://github.com/eliasteeny/flutter_document_scanner
Step 2
  • Create a new pull request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

eliasteeny GitHub avatar
GitHub author

eliasteeny ↗

LanguagesJavaObjective-CDartRuby

Packages published by this repository

Dependencies used

Dependency list 3 items

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗