Legacy v0.9.1 fork of the React Native plugin for document scanning
npm install react-native-document-scanner-plugin-legacyForked version of react-native-document-scanner-plugin v0.9.1 with fixes for Huawei devices and certain Android versions. Modified to allow simultaneous use with v1.0.1 in the same project
This is a React Native plugin that lets you scan documents using Android and iOS. You can use it to create
apps that let users scan notes, homework, business cards, receipts, or anything with a rectangular shape.
| iOS | Android |
| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| !Dollar-iOS | !Dollar Android |
``bash`
npm install react-native-document-scanner-plugin
After installing the plugin, you need to follow the steps below
1. Open ios/Podfile and set platform :ios to 13 or higher
2. iOS requires the following usage description be added and filled out for your app in Info.plist:
- NSCameraUsageDescription (Privacy - Camera Usage Description)
3. Install pods by running
`bash`
cd ios && pod install && cd ..
1. Open android/gradle.properties and add org.gradle.jvmargs=-Xmx2048m
Note: You don't need to prompt the user to accept camera permissions for this plugin to work unless you're using another plugin that requires the user to accept camera permissions. See Android Camera Permissions.
- Basic Example
- Limit Number of Scans
- Remove Cropper
`javascript
import React, { useState, useEffect } from 'react';
import { Image } from 'react-native';
import DocumentScanner from 'react-native-document-scanner-plugin';
export default () => {
const [scannedImage, setScannedImage] = useState();
const scanDocument = async () => {
// start the document scanner
const { scannedImages } = await DocumentScanner.scanDocument();
// get back an array with scanned image file paths
if (scannedImages.length > 0) {
// set the img src, so we can view the first scanned image
setScannedImage(scannedImages[0]);
}
};
useEffect(() => {
// call scanDocument on load
scanDocument();
}, []);
return (
style={{ width: '100%', height: '100%' }}
source={{ uri: scannedImage }}
/>
);
};
`
Here's what this example looks like with several items
You can limit the number of scans. For example if your app lets a user scan a business
card you might want them to only capture the front and back. In this case you can set
maxNumDocuments to 2. This only works on Android.
`javascript
import React, { useState, useEffect } from 'react';
import { Image } from 'react-native';
import DocumentScanner from 'react-native-document-scanner-plugin';
export default () => {
const [scannedImage, setScannedImage] = useState();
const scanDocument = async () => {
// start the document scanner
const { scannedImages } = await DocumentScanner.scanDocument({
maxNumDocuments: 2,
});
// get back an array with scanned image file paths
if (scannedImages.length > 0) {
// set the img src, so we can view the first scanned image
setScannedImage(scannedImages[0]);
}
};
useEffect(() => {
// call scanDocument on load
scanDocument();
}, []);
return (
style={{ width: '100%', height: '100%' }}
source={{ uri: scannedImage }}
/>
);
};
`
You can automatically accept the detected document corners, and prevent the user from
making adjustments. Set letUserAdjustCrop to false to skip the crop screen. This limits
the max number of scans to 1. This only works on Android.
`javascript
import React, { useState, useEffect } from 'react';
import { Image } from 'react-native';
import DocumentScanner from 'react-native-document-scanner-plugin';
export default () => {
const [scannedImage, setScannedImage] = useState();
const scanDocument = async () => {
// start the document scanner
const { scannedImages } = await DocumentScanner.scanDocument({
letUserAdjustCrop: false,
});
// get back an array with scanned image file paths
if (scannedImages.length > 0) {
// set the img src, so we can view the first scanned image
setScannedImage(scannedImages[0]);
}
};
useEffect(() => {
// call scanDocument on load
scanDocument();
}, []);
return (
style={{ width: '100%', height: '100%' }}
source={{ uri: scannedImage }}
/>
);
};
`
- scanDocument(...)
- Interfaces
- Enums
`typescript`
scanDocument(options?: ScanDocumentOptions | undefined) => Promise
Opens the camera, and starts the document scan
| Param | Type |
| ------------- | ------------------------------------------------------------------- |
| options | ScanDocumentOptions |
Returns: Promise<ScanDocumentResponse>
---
#### ScanDocumentResponse
| Prop | Type | Description |
| ------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| scannedImages | string[] | This is an array with either file paths or base64 images for the document scan. |
| status | ScanDocumentResponseStatus | The status lets you know if the document scan completes successfully, or if the user cancels before completing the document scan. |
#### ScanDocumentOptions
| Prop | Type | Description | Default |
| ------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
| croppedImageQuality | number | The quality of the cropped image from 0 - 100. 100 is the best quality. | : 100 |
| letUserAdjustCrop | boolean | Android only: If true then once the user takes a photo, they get to preview the automatically detected document corners. They can then move the corners in case there needs to be an adjustment. If false then the user can't adjust the corners, and the user can only take 1 photo (maxNumDocuments can't be more than 1 in this case). | : true |
| maxNumDocuments | number | Android only: The maximum number of photos an user can take (not counting photo retakes) | : 24 |
| responseType | ResponseType | The response comes back in this format on success. It can be the document scan image file paths or base64 images. | : ResponseType.ImageFilePath |
#### ScanDocumentResponseStatus
| Members | Value | Description |
| ------------- | ---------------------- | --------------------------------------------------------------------------------------------------------- |
| Success | 'success' | The status comes back as success if the document scan completes successfully. |
| Cancel | 'cancel' | The status comes back as cancel if the user closes out of the camera before completing the document scan. |
#### ResponseType
| Members | Value | Description |
| ------------------- | ---------------------------- | ------------------------------------------------------------------------------- |
| Base64 | 'base64' | Use this response type if you want document scan returned as base64 images. |
| ImageFilePath | 'imageFilePath' | Use this response type if you want document scan returned as inmage file paths. |
This plugin doesn't run in Expo Go. It works with Expo, and you can avoid manually changing iOS and Android files by following these steps.
`bash`
npx expo install react-native-document-scanner-plugin
Add react-native-document-scanner-plugin to plugins in app.json or app.config.json.
`javascript`
{
"name": "my expo app",
"plugins": [
[
"react-native-document-scanner-plugin",
{
"cameraPermission": "We need camera access, so you can scan documents"
}
]
]
}
`bash`
npx expo prebuild
or
`bash`
eas build
You don't need to request camera permissions unless you're using another camera plugin that adds to the application's AndroidManifest.xml.
In that case if you don't request camera permissions you get this error
Error: error - error opening camera: Permission Denial: starting Intent { act=android.media.action.IMAGE_CAPTURE
Here's an example of how to request camera permissions.
`javascript
import React, { useState, useEffect } from 'react';
import { Platform, PermissionsAndroid, Image, Alert } from 'react-native';
import DocumentScanner from 'react-native-document-scanner-plugin';
export default () => {
const [scannedImage, setScannedImage] = useState();
const scanDocument = async () => {
// prompt user to accept camera permission request if they haven't already
if (
Platform.OS === 'android' &&
(await PermissionsAndroid.request(
PermissionsAndroid.PERMISSIONS.CAMERA
)) !== PermissionsAndroid.RESULTS.GRANTED
) {
Alert.alert(
'Error',
'User must grant camera permissions to use document scanner.'
);
return;
}
// start the document scanner
const { scannedImages } = await DocumentScanner.scanDocument();
// get back an array with scanned image file paths
if (scannedImages.length > 0) {
// set the img src, so we can view the first scanned image
setScannedImage(scannedImages[0]);
}
};
useEffect(() => {
// call scanDocument on load
scanDocument();
}, []);
return (
style={{ width: '100%', height: '100%' }}
source={{ uri: scannedImage }}
/>
);
};
``
Copyright 2022 David Marcus
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.