Need help with CodeScanner?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

twostraws
313 Stars 98 Forks MIT License 64 Commits 13 Opened issues

Description

A SwiftUI view that is able to scan barcodes, QR codes, and more, and send back what was found.

Services available

!
?

Need anything else?

Contributors list

# 11,446
Swift
Xcode
glsl
appkit
5 commits
# 119,942
Objecti...
Shell
C++
4 commits
# 416,504
Swift
iOS
particl...
Objecti...
2 commits
# 344,945
React
CSS
Node.js
scaffol...
2 commits
# 10,045
Swift
rxswift
alamofi...
swift4
1 commit
# 316,842
Swift
Objecti...
iOS
iphone
1 commit
# 285,955
osx
decrypt
pem
mac
1 commit
# 64,691
JavaScr...
CSS
1 commit
# 366,776
iphone
HTML
CSS
Xcode
1 commit
# 186,445
Ruby
swiftui
mina
Rails
1 commit
# 248,878
Go
React
TypeScr...
React N...
1 commit
# 43,721
source-...
hlsl
Windows
macOS
1 commit

CodeScanner

Twitter: @twostraws

CodeScanner is a simple wrapper SwiftUI framework that makes it easy to scan codes such as QR codes and barcodes. It provides a struct,

CodeScannerView
, that can be shown inside a sheet so that all scanning occurs in one place.

Usage

You should create an instance of

CodeScannerView
with three parameters: an array of the types to scan for, some test data to send back when running in the simulator, and a closure that will be called when a result is ready. This closure must accept a
Result
, where the string is the code that was found on success and
ScanError
will be either
badInput
(if the camera cannot be accessed) or
badOutput
(if the camera is not capable of detecting codes.)

Important: iOS requires you to add the "Privacy - Camera Usage Description" key to your Info.plist file, providing a reason for why you want to access the camera.

Examples

Here's some example code to create a QR code-scanning view that prints the code that was found or any error. If it's used in the simulator it will return a name, because that's provided as the simulated data:

CodeScannerView(codeTypes: [.qr], simulatedData: "Paul Hudson") { result in                    
    switch result {
    case .success(let code):
        print("Found code: \(code)")
    case .failure(let error):
        print(error.localizedDescription)
    }
}

Your completion closure is probably where you want to dismiss the

CodeScannerView
.

Here's an example on how to present the QR code-scanning view as a sheet and how the scanned barcode can be passed to the next view in a NavigationView:

struct QRCodeScannerExampleView: View {
    @State var isPresentingScanner = false
    @State var scannedCode: String?

var body: some View {
    NavigationView {
        VStack(spacing: 10) {
            if self.scannedCode != nil {
                NavigationLink("Next page", destination: NextView(scannedCode: scannedCode!), isActive: .constant(true)).hidden()
            }
            Button("Scan Code") {
                self.isPresentingScanner = true
            }
            .sheet(isPresented: $isPresentingScanner) {
                self.scannerSheet
            }
            Text("Scan a QR code to begin")
        }

    }
}

var scannerSheet : some View {
    CodeScannerView(
        codeTypes: [.qr],
        completion: { result in
            if case let .success(code) = result {
                self.scannedCode = code
                self.isPresentingScanner = false
            }
        }
    )
}

}

Credits

CodeScanner was made by Paul Hudson, who writes free Swift tutorials over at Hacking with Swift. It’s available under the MIT license, which permits commercial use, modification, distribution, and private use.

License

MIT License.

Copyright (c) 2019 Paul Hudson

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.