Skip to content

README.md

Latest commit

 

History

History
118 lines (80 loc) · 3.11 KB

README.md

File metadata and controls

118 lines (80 loc) · 3.11 KB
Raw

ThatCamThing

Welcome to ThatCamThing! A lightweight, powerful, and easy-to-use camera library for SwiftUI. This package provides a simple way to integrate a custom camera interface into your iOS app, with built-in controls and extensive customization options.

📸 Features

  • Simple SwiftUI Integration: A CameraView that works seamlessly within your SwiftUI layouts.
  • Customizable Overlays: Replace the default camera UI with your own custom SwiftUI view.
  • Custom Error Screens: Provide a custom view to display when camera errors occur.
  • Full Camera Control: Programmatically manage flash, camera position (front/back), lens type (wide/ultra-wide), zoom, and frame rate.
  • Image Capture: A simple closure-based callback to receive captured UIImage objects.
  • Default UI Included: Comes with a sleek, modern, and ready-to-use DefaultCameraOverlay.

📋 Requirements

  • iOS 15.0+
  • Swift 5.5+
  • Xcode 13.0+

📦 Installation

You can add ThatCamThing to your Xcode project using the Swift Package Manager.

  1. In Xcode, open your project and navigate to File > Add Packages...
  2. The Swift Package Manager dialog will appear.
  3. In the search bar, enter the repository URL: https://github.com/your-username/CamaragePackageV2.git (Please replace with your actual repository URL).
  4. Choose the version you want to use and click Add Package.
  5. Select the ThatCamThing library to be added to your app target.

🚀 How to Use

Integrating ThatCamThing into your SwiftUI view takes just a few steps.

🧩 Step 1: Import the Library

import ThatCamThing

🔐 Step 2: Add Camera Permissions

In your Info.plist, add:

<key>NSCameraUsageDescription</key>
<string>We need access to your camera for capturing photos.</string>

📸 Step 3: Use CameraView with Defaults

The library provides default overlay and error views to get started quickly:

CameraView()
    .setOverlayScreen(DefaultCameraOverlay.init)
    .setErrorScreen(DefaultCameraErrorView.init)

🎛️ Customizing Camera Attributes

To customize the camera behavior, you can configure CameraManagerAttributes:

CameraView()
    .setOverlayScreen(DefaultCameraOverlay.init)
    .setErrorScreen(DefaultCameraErrorView.init)
    .setAttributes(CameraManagerAttributes(
        cameraPosition: .back,
        frameRate: 60,
        flashMode: .auto,
        resolution: .hd4K3840x2160,
        lensType: .wide
    ))
    .onImageCaptured { image in
        // Handle captured UIImage
    }

🧪 Custom Overlays

You can customize the UI by providing your own views:

✅ Custom Overlay Screen

To use your own camera overlay, conform to the CameraOverlay protocol:

struct MyOverlay: CameraOverlay {
   
}

❗ Custom Error Screen

To display a custom error view, conform to the CameraErrorOverlay protocol:

struct MyErrorView: CameraErrorOverlay {
    
}

Then apply them like this:

CameraView()
    .setOverlayScreen(MyOverlay.init)
    .setErrorScreen(MyErrorView.init)