/HapticFeedbackKit

SwiftUI library for managing haptic feedback

Primary LanguageSwiftMIT LicenseMIT

HapticFeedbackKit

Swift Package Manager GitHub stars GitHub forks GitHub contributors Pull Requests Badge Issues Badge

Description

HapticFeedbackKit is a SwiftUI library for managing haptic feedback.
The primary purpose of this package is to provide users with the ability to enable or disable haptic feedback within the application.


Requirements

  • iOS: 17.0 or later.
  • macOS: 14.0 or later.

Installation

You can install HapticFeedbackKit using the Swift Package Manager.

  1. In Xcode, select "File" > "Add Package Dependencies".
  2. Copy & paste the following into the "Search or Enter Package URL" search bar.
https://github.com/JamesSedlacek/HapticFeedbackKit.git
  1. Xcode will fetch the repository & the "HapticFeedbackKit" library will be added to your project.

Usage

  1. Use .hapticFeedback() instead of .sensoryFeedback().
import HapticFeedbackKit
import SwiftUI

struct ContentView: View {
    @State private var taskIsComplete = false

    var body: some View {
        Button("Mark Complete") {
            taskIsComplete = true
        }
        .hapticFeedback(.success, trigger: taskIsComplete)
    }
}

  1. Use a HapticFeedbackToggle() in the settings screen in your project.
import HapticFeedbackKit
import SwiftUI

struct SettingsView {
    var body: some View {
        VStack {
            HapticFeedbackToggle()
        }
    }
}

Author

James Sedlacek, find me on X/Twitter or LinkedIn