https://github.com/charlymr/irlpdfscancontent
A convenient class usable from UIKit view controller or SwiftUI to scan document & get UIImage or PDFDocument as result - Replacement of IRLDocumentScanner
https://github.com/charlymr/irlpdfscancontent
carthage cocoapods docc ios scan scanner spm swift swift-package-manager swiftui uikit visionkit
Last synced: 3 months ago
JSON representation
A convenient class usable from UIKit view controller or SwiftUI to scan document & get UIImage or PDFDocument as result - Replacement of IRLDocumentScanner
- Host: GitHub
- URL: https://github.com/charlymr/irlpdfscancontent
- Owner: charlymr
- License: mit
- Created: 2021-11-06T09:40:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-27T06:40:22.000Z (over 3 years ago)
- Last Synced: 2025-09-25T15:32:43.557Z (8 months ago)
- Topics: carthage, cocoapods, docc, ios, scan, scanner, spm, swift, swift-package-manager, swiftui, uikit, visionkit
- Language: Swift
- Homepage: https://irlpdfscancontent.irlmobile.com/documentation/
- Size: 1.21 MB
- Stars: 18
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# IRLPDFScanContent
Super easy `SwiftUI` & `UKKit` pakcage to scan: Images or PDF. It is also a replacement for [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner)
[](https://irlpdfscancontent.irlmobile.com/documentation/) [](https://sonarcloud.io/summary/new_code?id=charlymr_IRLPDFScanContent) [](http://cocoapods.org/pods/IRLPDFScanContent) [](http://cocoapods.org/pods/IRLPDFScanContent) [](https://github.com/Carthage/Carthage)
[](https://github.com/charlymr/IRLPDFScanContent/blob/main/LICENSE)
## Overview
A convenient class usable from `UIKit` view controller or `SwiftUI` to scan document & get `UIImage` or `PDFDocument` as result
**MINIMUM iOS REQUIREMENT: 13.0**
## Migration from [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner)
Migration from [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner) is feasible. Please check the tutorial available in the [documentation](https://irlpdfscancontent.irlmobile.com/documentation/).
#### You project should still work with depreciation warnings
Follow the [tutorial](https://irlpdfscancontent.irlmobile.com/documentation/) to see how to beneficiate from the new system & remove the depreciation warnings.
One quick note, the new system support multiple scan. In this tutorial we cover how to get 1 scan. It is very straigth forward to get eveything else, check the doc.
## Application plist requirement
As of iOS 10, you must povide a reason for using the camera in you Info.plist:
Please add the following to your plist:
**[NSCameraUsageDescription](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) : We need the camera to scan**
## Install
### Swift Package
Integrate the library via Swift Package (With Documentation)
#### In Xcode
Add the Package to your project, min version `5.5`, See [Apple Documentation](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app) for more details.
#### Manually
Create a Package.swift in a folder, then Drop the file on Xcode
```swift
// swift-tools-version:5.5
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "SPMDemo",
products: [
.library(
name: "SPMDemo",
targets: ["SPMDemo"]),
],
dependencies: [
.package(url: "git@github.com:charlymr/IRLPDFScanContent.git", from: "1.1.0"),
],
targets: [
.target( name: "SPMDemo",
dependencies: [
.product(name: "IRLPDFScanContent", package: "IRLPDFScanContent"),
])
]
)
```
### CocoaPods
Integrate the library via CocoaPods
#### Install CocoaPods
if not already available:
``` bash
$ [sudo] gem install cocoapods
$ pod setup
```
#### Update your Podfile
Change to the directory of your Xcode project, and Create and Edit your Podfile and add ``IRLPDFScanContent``:
``` bash
$ cd /path/to/MyProject
$ touch Podfile
## edit Podfile:
platform :ios, '13.0'
target "YOUR APP" do
pod 'IRLPDFScanContent'
use_frameworks!
end
```
#### Prepare project
run `pod update` or `pod install` to generate the Workspace
``` bash
$ pod update
```
### Carthage
Integrate the library via Carthage.
For more details on Cartage and how to use it, check the [Carthage Github](https://github.com/Carthage/Carthage) documentation
#### Install Carthage
Install [Carthage](https://github.com/Carthage/Carthage#installing-carthage) if not already available
#### Update your CartFile
Change to the directory of your Xcode project, and Create and Edit your CartFile and add [``IRLPDFScanContent``](https://irlpdfscancontent.irlmobile.com/documentation/):
``` bash
$ cd /path/to/MyProject
$ touch CartFile
## edit CartFile:
github "charlymr/IRLPDFScanContent" ~> 1.1.0
```
#### Prepare
``` bash
$ carthage update --use-xcframeworks
```
Drop the Carthage/Build/iOS `.xcframework` in your project.
## [Getting started](https://irlpdfscancontent.irlmobile.com)
IRLPDFScanContent is a convenient way to use PDFKit in SwiftUI allowing the user to scan multiple pages and create a PDF for you.
This tutorials will guides you through adding this functionality to a SwiftUI view or a UIVIewController. You will learn to build the view and hanlde the user input.
Chech the documentation (Essentials / Getting Started) here: [Documentation](https://irlpdfscancontent.irlmobile.com) for more details.
## SwiftUI example
- Initiate the object
- present you view ``present(animated:)``
- Observe the result of ``latestScan``
- Use the convenient method ``swiftUIPDFView`` to update your view
``` swift
import SwiftUI
import IRLPDFScanContent
struct ContentView: View {
@ObservedObject var scanner: IRLPDFScanContent = IRLPDFScanContent()
var body: some View {
NavigationView {
VStack() {
if let latestScan = scanner.latestScan {
latestScan.swiftUIPDFView
} else {
Text("Press the Scan button")
}
}
.padding()
.navigationBarItems(trailing: Button("Scan", action: {
scanner.present(animated: true, completion: nil)
}))
}
}
}
struct ContentView_Previews: PreviewProvider {
static var previews: some View {
ContentView()
}
}
```
## Authors
- Denis Martin-Bruilot | Web: [www.irlmobile.com](http://www.irlmobile.com) | LinkedIN: [denismartin](https://www.linkedin.com/in/denismartin/)
## Open Source
- Feel free to fork and modify this code. Pull requests are more than welcome!
## MIT License
Copyright (c) 2021 MARTIN-BRUILLOT Denis
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.