Add option to hide/show navigation bar

Author: jpvinod

Package.swift

@@ -24,8 +24,7 @@ let package = Package(
         .target(
             name: "SwiftQRCodeScanner",
             dependencies: [],
-            path: "Sources",
-            exclude: ["Info.plist"]
+            path: "Sources"
          ),
     ],
     swiftLanguageVersions: [.v5]

README.md

@@ -75,11 +75,11 @@ self.present(scanner, animated: true, completion: nil)
 ```
 And finally implement delegate methods to get result:
 ```Swift
-func qrScanner(_ controller: UIViewController, scanDidComplete result: String) {
+func qrScanner(_ controller: UIViewController, didScanQRCodeWithResult result: String) {
     print("result:\(result)")
 }
 
-func qrScannerDidFail(_ controller: UIViewController, error: QRCodeError) {
+func qrScanner(_ controller: UIViewController, didFailWithError error: SwiftQRCodeScanner.QRCodeError) {
     print("error:\(error.localizedDescription)")
 }
 
@@ -118,13 +118,13 @@ class ViewController: UIViewController {
 
 }
 
-extension ViewController: QRScannerCodeDelegate {
-    func qrScannerDidFail(_ controller: UIViewController, error: QRCodeError) {
-        print("error:\(error.localizedDescription)")
+extension ViewController: QRScannerCodeDelegate {    
+    func qrScanner(_ controller: UIViewController, didScanQRCodeWithResult result: String) {
+        print("result:\(result)")
     }
 
-    func qrScanner(_ controller: UIViewController, scanDidComplete result: String) {
-        print("result:\(result)")
+    func qrScanner(_ controller: UIViewController, didFailWithError error: SwiftQRCodeScanner.QRCodeError) {
+        print("error:\(error.localizedDescription)")
     }
 
     func qrScannerDidCancel(_ controller: UIViewController) {
@@ -151,6 +151,7 @@ You can use following **QRScannerConfiguration** properties:
 | readQRFromPhotos | true | Hide/show "Upload From photos" button|
 | cancelButtonTitle | "Cancel" | Title for cancel button |
 | cancelButtonTintColor | nil | Color for cancel button |
+| hideNavigationBar| false | Hide/show navigation bar |
 
 ## Author
 

Sources/SwiftQRCodeScanner/Configuration.swift

@@ -10,6 +10,9 @@ import Foundation
 import UIKit
 
 public struct QRScannerConfiguration {
+    
+    // MARK: - Properties
+    
     public var title: String
     public var hint: String?
     public var invalidQRCodeAlertTitle: String
@@ -25,54 +28,52 @@ public struct QRScannerConfiguration {
     public var readQRFromPhotos: Bool
     public var cancelButtonTitle: String
     public var cancelButtonTintColor: UIColor?
+    public var hideNavigationBar: Bool
+    
+    // MARK: - Initializers
 
     public init(title: String = "Scan QR Code",
-                hint: String = "Align QR code within frame to scan",
+                hint: String? = "Align QR code within frame to scan",
                 uploadFromPhotosTitle: String = "Upload from photos",
                 invalidQRCodeAlertTitle: String = "Invalid QR Code",
                 invalidQRCodeAlertActionTitle: String = "OK",
                 cameraImage: UIImage? = nil,
                 flashOnImage: UIImage? = nil,
+                galleryImage: UIImage? = nil,
                 length: CGFloat = 20.0,
                 color: UIColor = .green,
                 radius: CGFloat = 10.0,
                 thickness: CGFloat = 5.0,
                 readQRFromPhotos: Bool = true,
                 cancelButtonTitle: String = "Cancel",
-                cancelButtonTintColor: UIColor? = nil) {
+                cancelButtonTintColor: UIColor? = nil,
+                hideNavigationBar: Bool = false) {
         self.title = title
         self.hint = hint
         self.uploadFromPhotosTitle = uploadFromPhotosTitle
         self.invalidQRCodeAlertTitle = invalidQRCodeAlertTitle
         self.invalidQRCodeAlertActionTitle = invalidQRCodeAlertActionTitle
         self.cameraImage = cameraImage
         self.flashOnImage = flashOnImage
+        self.galleryImage = galleryImage
         self.length = length
         self.color = color
         self.radius = radius
         self.thickness = thickness
         self.readQRFromPhotos = readQRFromPhotos
         self.cancelButtonTitle = cancelButtonTitle
         self.cancelButtonTintColor = cancelButtonTintColor
+        self.hideNavigationBar = hideNavigationBar
     }
 }
 
+// MARK: - Default Configuration
+
 extension QRScannerConfiguration {
     public static var `default`: QRScannerConfiguration {
-        QRScannerConfiguration(title: "Scan QR Code",
-                               hint: "Align QR code within frame to scan",
-                               uploadFromPhotosTitle: "Upload from photos",
-                               invalidQRCodeAlertTitle: "Invalid QR Code",
-                               invalidQRCodeAlertActionTitle: "OK",
-                               cameraImage: nil,
-                               flashOnImage: nil,
-                               length: 20.0,
-                               color: .green,
-                               radius: 10.0,
-                               thickness: 5.0,
-                               readQRFromPhotos: true,
-                               cancelButtonTitle: "Cancel",
-                               cancelButtonTintColor: nil)
+        .init()
     }
 }
+
 #endif
+

Sources/SwiftQRCodeScanner/ImagePicker.swift

@@ -10,28 +10,45 @@ import Foundation
 import UIKit
 import PhotosUI
 
+/// A protocol that defines the delegate method for handling the selected image.
 public protocol ImagePickerDelegate: AnyObject {
+    /// Called when an image is selected from the image picker.
+    ///
+    /// - Parameter image: The selected image, or nil if no image was selected.
     func didSelect(image: UIImage?)
 }
 
-
+/// A class that provides a system-provided interface for selecting an image from the camera roll or photo library.
 class PhotoPicker: NSObject {
 
+    // The image picker controller used to present the system interface.
     private let pickerController: UIImagePickerController
+    
+    // A weak reference to the view controller that presents the image picker.
     private weak var presentationController: UIViewController?
+    
+    // A weak reference to the delegate that will handle the selected image.
     private weak var delegate: ImagePickerDelegate?
 
-    public init(presentationController: UIViewController, delegate: ImagePickerDelegate) {
+    /// Initializes a new instance of the `PhotoPicker` class.
+    ///
+    /// - Parameters:
+    ///   - presentationController: The view controller that will present the image picker.
+    ///   - delegate: The delegate that will handle the selected image.
+    public init(presentationController: UIViewController,
+                delegate: ImagePickerDelegate) {
 
         self.pickerController = UIImagePickerController()
         super.init()
         self.presentationController = presentationController
         self.delegate = delegate
         self.pickerController.delegate = self
         self.pickerController.allowsEditing = false
-        
     }
 
+    /// Presents the image picker interface from the specified source view.
+    ///
+    /// - Parameter sourceView: The view from which the image picker should be presented.
     public func present(from sourceView: UIView) {
 
         let alertController = UIAlertController(title: nil, message: nil, preferredStyle: .actionSheet)
@@ -56,19 +73,29 @@ class PhotoPicker: NSObject {
         self.presentationController?.present(alertController, animated: true)
     }
 
+    // A private method that handles the selected image and notifies the delegate.
     private func pickerController(_ controller: UIImagePickerController, didSelect image: UIImage?) {
         controller.dismiss(animated: true, completion: nil)
         self.delegate?.didSelect(image: image)
     }
 }
 
+// MARK: - UIImagePickerControllerDelegate
+
 extension PhotoPicker: UIImagePickerControllerDelegate {
 
+    /// Called when the image picker is canceled.
+    ///
+    /// - Parameter picker: The image picker controller that was canceled.
     public func imagePickerControllerDidCancel(_ picker: UIImagePickerController) {
-        
         picker.dismiss(animated: true)
     }
 
+    /// Called when an image has been selected from the image picker.
+    ///
+    /// - Parameters:
+    ///   - picker: The image picker controller that selected the image.
+    ///   - info: A dictionary containing information about the selected media.
     public func imagePickerController(_ picker: UIImagePickerController,
                                       didFinishPickingMediaWithInfo info: [UIImagePickerController.InfoKey: Any]) {
         guard let image = info[.originalImage] as? UIImage else {
@@ -78,17 +105,33 @@ extension PhotoPicker: UIImagePickerControllerDelegate {
     }
 }
 
+// MARK: - UINavigationControllerDelegate
+
 extension PhotoPicker: UINavigationControllerDelegate {}
 
+// MARK: - PHPhotoPicker (Available on iOS 14 and later)
+
 @available(iOS 14, *)
-extension PHPhotoPicker: UINavigationControllerDelegate{}
+extension PHPhotoPicker: UINavigationControllerDelegate {}
 
+/// A class that provides an interface for selecting an image using the Photos UI on iOS 14 and later.
 @available(iOS 14, *)
 class PHPhotoPicker: NSObject {
+    
+    // The Photos UI picker controller used to present the interface.
     private let pickerController: PHPickerViewController
+    
+    // A weak reference to the view controller that presents the Photos UI picker.
     private weak var presentationController: UIViewController?
+    
+    // A weak reference to the delegate that will handle the selected image.
     private weak var delegate: ImagePickerDelegate?
 
+    /// Initializes a new instance of the `PHPhotoPicker` class.
+    ///
+    /// - Parameters:
+    ///   - presentationController: The view controller that will present the Photos UI picker.
+    ///   - delegate: The delegate that will handle the selected image.
     public init(presentationController: UIViewController, delegate: ImagePickerDelegate) {
         var phPickerConfiguration = PHPickerConfiguration(photoLibrary: .shared())
         phPickerConfiguration.selectionLimit = 1
@@ -100,26 +143,32 @@ class PHPhotoPicker: NSObject {
         self.delegate = delegate
     }
 
+    /// Requests authorization to access the photo library and presents the Photos UI picker if authorized.
     public func present() {
-        PHPhotoLibrary.requestAuthorization({
-            (newStatus) in
+        PHPhotoLibrary.requestAuthorization({ (newStatus) in
             DispatchQueue.main.async {
                 if newStatus ==  PHAuthorizationStatus.authorized {
-                    
-                    self.presentationController?.present(self.pickerController, animated: true)
+                    self.presentationController?.present(self.pickerController,
+                                                         animated: true)
                 }
             }
         })
     }
-    
 }
 
+// MARK: - PHPickerViewControllerDelegate
+
 @available(iOS 14, *)
 extension PHPhotoPicker: PHPickerViewControllerDelegate {
 
-    func picker(_ picker: PHPickerViewController, didFinishPicking results: [PHPickerResult]) {
+    /// Called when an image has been selected from the Photos UI picker.
+    ///
+    /// - Parameters:
+    ///   - picker: The Photos UI picker controller that selected the image.
+    ///   - results: An array of `PHPickerResult` objects representing the selected images.
+    func picker(_ picker: PHPickerViewController,
+                didFinishPicking results: [PHPickerResult]) {
         picker.dismiss(animated: true, completion: nil)
-        
         for result in results {
             result.itemProvider.loadObject(ofClass: UIImage.self, completionHandler: { (object, error) in
                 if let image = object as? UIImage {
@@ -130,8 +179,6 @@ extension PHPhotoPicker: PHPickerViewControllerDelegate {
             })
         }
     }
-    
 }
 
 #endif
-

Sources/SwiftQRCodeScanner/QRCodeError.swift

@@ -7,43 +7,25 @@
 
 import Foundation
 
-public enum QRCodeError: Error {
+public enum QRCodeError: Error, Equatable {
     case inputFailed
-    case outoutFailed
+    case outputFailed
     case emptyResult
 }
 
-extension QRCodeError: CustomStringConvertible {
-    public var description: String {
+extension QRCodeError: CustomStringConvertible, LocalizedError {
+    public var errorDescription: String? {
         switch self {
         case .inputFailed:
-            return "Failed to add input."
-        case .outoutFailed:
-            return "Failed to add output."
+            return NSLocalizedString("Failed to add input.", comment: "Failed to add input.")
+        case .outputFailed:
+            return NSLocalizedString("Failed to add output.", comment: "Failed to add output.")
         case .emptyResult:
-            return "Empty string found."
+            return NSLocalizedString("Empty string found", comment: "Empty string found.")
         }
     }
-}
 
-extension QRCodeError: LocalizedError {
-    public var errorDescription: String? {
-        switch self {
-        case .inputFailed:
-            return NSLocalizedString(
-                "Failed to add input.",
-                comment: "Failed to add input."
-            )
-        case .outoutFailed:
-            return NSLocalizedString(
-                "Failed to add output.",
-                comment: "Failed to add output."
-            )
-        case .emptyResult:
-            return NSLocalizedString(
-                "Empty string found.",
-                comment: "Empty string found."
-            )
-        }
+    public var description: String {
+        return errorDescription ?? ""
     }
 }

Sources/SwiftQRCodeScanner/QRScannerFrame.swift

@@ -5,11 +5,9 @@
 //  Created by Vinod Jagtap on 12/22/19.
 //
 
-
 #if os(iOS)
 import UIKit
 
-
 open class QRScannerFrame: UIView {
 
     var length: CGFloat = 25.0 {
@@ -81,7 +79,6 @@ open class QRScannerFrame: UIView {
         path.lineWidth = thickness
         path.stroke()
     }
-    
 }
 
 #endif