Skip to content

Commit 1c84400

Browse files
LiYanan2004LiYanan2004
committed
Update API style to match the new sensoryFeedback while supporting old systems
1 parent 6ab900a commit 1c84400

11 files changed

+498
-289
lines changed

‎.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Package.swift

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ let package = Package(
77
name: "SwiftUI-Haptics",
88
platforms: [
99
.iOS(.v14),
10-
.watchOS(.v7)
10+
.watchOS(.v7),
11+
.macOS(.v11)
1112
],
1213
products: [
1314
.library(name: "Haptics", targets: ["Haptics"]),

‎README.md

+47-22
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,73 @@ import Haptics
1111
⋮
1212
⋮
1313
YourView()
14-
.haptics(onChangeOf: value, type: .soft)
14+
.hapticFeedback(.selection, trigger: isSelected)
1515
```
1616
or using the function programmatically
1717
```swift
18-
@Environment(\.hapticGenerator) var generator
19-
⋮
20-
generator.hapticFeedbackOccurred(type: .click)
18+
HapticGenerator.performFeedback(.selection)
2119
```
2220

23-
## Feedback Types
24-
25-
- Notification Feedback
26-
- Impact Feedback
27-
- Selection Feedback
28-
- WKHaptic
29-
30-
## Platforms
21+
## Platforms
3122

3223
- iOS 14.0+
3324
- watchOS 7.0+
34-
35-
## Conditional Haptics
25+
- macOS 11.0+
3626

37-
Sometimes, you just want to play haptic feedbacks only at a specific state. At this time, `.haptics(when:equalsTo:type:)` plays a role.
27+
## Haptic Feedbacks
3828

39-
Of course, you can create multiple haptics on a single view:
29+
- `start`: Indicates that an activity started. **(watchOS only)**
30+
- `stop`: Indicates that an activity stopped. **(watchOS only)**
31+
- `alignment`: Indicates the alignment of a dragged item. **(macOS only)**
32+
- `decrease`: Indicates that an important value decreased below a significant threshold. **(watchOS only)**
33+
- `increase`: Indicates that an important value increased above a significant threshold. **(watchOS only)**
34+
- `levelChange`: Indicates movement between discrete levels of pressure. **(macOS only)**
35+
- `selection`: Indicates that a UI element’s values are changing. **(iOS & watchOS)**
36+
- `success`: Indicates that a task or action has completed. **(iOS & watchOS)**
37+
- `warning`: Indicates that a task or action has produced a warning of some kind. **(iOS & watchOS)**
38+
- `error`: Indicates that an error has occurred. **(iOS & watchOS)**
39+
- `impact`: Provides a physical metaphor you can use to complement a visual experience. **(iOS & watchOS)**
40+
41+
## Value-based Haptic Feedbacks
42+
43+
Play haptic feedbacks when the value changes.
4044

4145
```swift
4246
YourView()
43-
.haptics(when: value, equalsTo: .success, type: .success)
44-
.haptics(when: value, equalsTo: .failure, type: .error)
47+
.hapicFeedback(.selection, trigger: isSelected)
4548
```
49+
50+
## Dynamic Haptic Feedbacks
4651

47-
## onAppear Haptics
52+
If the value being monitored changes, returns a `HapticFeedback` to be performed.
4853

49-
You can play a one-time haptic feedback when a view appears.
54+
Return `nil` means **DO NOT** perform any haptics.
55+
56+
You can provide different haptic feedbacks based on your trigger value.
5057

5158
```swift
52-
Text("I love haptics.")
53-
.triggersHapticFeedbackWhenAppear()
59+
YourView()
60+
.hapicFeedback(trigger: workStatus) { _, newValue in
61+
return switch {
62+
case .success: .success
63+
case .failure: .error
64+
default: nil
65+
}
66+
}
67+
.hapicFeedback(.impact, trigger: cameraSession.capturedPhoto) { _, newValue in
68+
return newValue == true // Only plays feedback when photo has been taken
69+
}
5470
```
5571

72+
## Looks familiar?
73+
74+
Yeah.
75+
76+
If you want to use `.sensoryFeedback` API but need to support older platform, `SwiftUI-Haptics` is a better solution.
77+
78+
Replace `sensoryFeedback` to `hapticFeedback`.
79+
80+
Everything just works.
5681

5782
## Swift Package Manager
5883

‎Sources/Haptics/HapticFeedback+SwiftUI.swift

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
import SwiftUI
2+
3+
extension View {
4+
@ViewBuilder
5+
/// Plays the specified `feedback` when the provided `trigger` value changes.
6+
///
7+
/// - Parameters:
8+
/// - feedback: Which type of feedback to play.
9+
/// - trigger: A value to monitor for changes to determine when to play.
10+
///
11+
/// For example, you could play feedback when a state value changes:
12+
///
13+
/// ```swift
14+
/// struct MyView: View {
15+
/// @State private var showAccessory = false
16+
///
17+
/// var body: some View {
18+
/// ContentView()
19+
/// .hapticFeedback(.selection, trigger: showAccessory)
20+
/// .onLongPressGesture {
21+
/// showAccessory.toggle()
22+
/// }
23+
///
24+
/// if showAccessory {
25+
/// AccessoryView()
26+
/// }
27+
/// }
28+
/// }
29+
/// ```
30+
public func hapticFeedback<T: Equatable>(
31+
_ feedback: HapticFeedback,
32+
trigger: T
33+
) -> some View {
34+
if #available(iOS 17.0, macOS 14.0, watchOS 10.0, tvOS 17.0, macCatalyst 17.0, visionOS 1.0, *) {
35+
onChange(of: trigger) {
36+
feedback.perform()
37+
}
38+
} else {
39+
onChange(of: trigger) { _ in
40+
feedback.perform()
41+
}
42+
}
43+
}
44+
45+
@ViewBuilder
46+
/// Plays feedback when returned from the `feedback` closure after the provided `trigger` value changes.
47+
///
48+
/// - Parameters:
49+
/// - trigger: A value to monitor for changes to determine when to play.
50+
/// - feedback: A closure to determine whether to play the feedback and what type of feedback to play when trigger changes.
51+
///
52+
/// For example, you could play different feedback for different state transitions:
53+
///
54+
/// ```swift
55+
/// struct MyView: View {
56+
/// @State private var phase = Phase.inactive
57+
///
58+
/// var body: some View {
59+
/// ContentView(phase: $phase)
60+
/// .hapticFeedback(trigger: phase) { old, new in
61+
/// switch (old, new) {
62+
/// case (.inactive, _): return .success
63+
/// case (_, .expanded): return .impact
64+
/// default: return nil
65+
/// }
66+
/// }
67+
/// }
68+
///
69+
/// enum Phase {
70+
/// case inactive
71+
/// case preparing
72+
/// case active
73+
/// case expanded
74+
/// }
75+
/// }
76+
/// ```
77+
public func hapticFeedback<T: Equatable>(
78+
trigger: T,
79+
_ feedback: @escaping (T, T) -> HapticFeedback?
80+
) -> some View {
81+
if #available(iOS 17.0, macOS 14.0, watchOS 10.0, tvOS 17.0, macCatalyst 17.0, visionOS 1.0, *) {
82+
onChange(of: trigger) { oldValue, newValue in
83+
feedback(oldValue, newValue)?.perform()
84+
}
85+
} else {
86+
onChange(of: trigger) { [oldValue = trigger] newValue in
87+
feedback(oldValue, newValue)?.perform()
88+
}
89+
}
90+
}
91+
92+
@ViewBuilder
93+
/// Plays the specified `feedback` when the provided `trigger` value changes and the `condition` closure returns `true`.
94+
/// - Parameters:
95+
/// - feedback: Which type of feedback to play.
96+
/// - trigger: A value to monitor for changes to determine when to play.
97+
/// - condition: A closure to determine whether to play the feedback when trigger changes.
98+
///
99+
/// For example, you could play feedback for certain state transitions:
100+
///
101+
/// ```swift
102+
/// struct MyView: View {
103+
/// @State private var phase = Phase.inactive
104+
///
105+
/// var body: some View {
106+
/// ContentView(phase: $phase)
107+
/// .hapticFeedback(.selection, trigger: phase) { old, new in
108+
/// old == .inactive || new == .expanded
109+
/// }
110+
/// }
111+
///
112+
/// enum Phase {
113+
/// case inactive
114+
/// case preparing
115+
/// case active
116+
/// case expanded
117+
/// }
118+
/// }
119+
/// ```
120+
public func hapticFeedback<T: Equatable>(
121+
_ feedback: HapticFeedback,
122+
trigger: T,
123+
condition: @escaping (T, T) -> Bool
124+
) -> some View {
125+
if #available(iOS 17.0, macOS 14.0, watchOS 10.0, tvOS 17.0, macCatalyst 17.0, visionOS 1.0, *) {
126+
onChange(of: trigger) { oldValue, newValue in
127+
condition(oldValue, newValue) ? feedback.perform() : ()
128+
}
129+
} else {
130+
onChange(of: trigger) { [oldValue = trigger] newValue in
131+
condition(oldValue, newValue) ? feedback.perform() : ()
132+
}
133+
}
134+
}
135+
}

‎Sources/Haptics/HapticFeedback.swift

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import Foundation
2+
3+
protocol Haptic: Sendable {
4+
@MainActor var performHapticFeedback: @Sendable () async -> Void { get }
5+
}
6+
7+
public struct HapticFeedback: Haptic {
8+
internal var label: String
9+
internal var performHapticFeedback: @Sendable () async -> Void
10+
11+
init(_ label: String, performHapticFeedback: @MainActor @escaping @Sendable () -> Void) {
12+
self.label = label
13+
self.performHapticFeedback = performHapticFeedback
14+
}
15+
16+
func perform() {
17+
Task { @MainActor in
18+
await self.performHapticFeedback()
19+
}
20+
}
21+
}
22+
23+
extension HapticFeedback {
24+
public enum Flexibility: Int, Sendable {
25+
case rigid, solid, soft
26+
}
27+
28+
public enum Weight: Int, Sendable {
29+
case light, medium, heavy
30+
}
31+
}
32+
33+
extension HapticFeedback: Equatable {
34+
public static func == (lhs: HapticFeedback, rhs: HapticFeedback) -> Bool {
35+
lhs.label == rhs.label
36+
}
37+
}

‎Sources/Haptics/HapticGenerator+SwiftUI.swift

-18
This file was deleted.

‎Sources/Haptics/HapticGenerator.swift

+7-48
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,12 @@
11
import SwiftUI
22

3-
public class HapticGenerator {
4-
static public var `default` = HapticGenerator()
3+
/// Trigger haptic feedback programmatically.
4+
class HapticGenerator {
5+
private init() { }
56

6-
#if os(watchOS)
7-
internal let device = WKInterfaceDevice.current()
8-
#endif
9-
}
10-
11-
#if os(iOS)
12-
public extension HapticGenerator {
13-
/// Triggers a selection feedback programmatically.
14-
///
15-
/// You can also use ``.haptics(onChangeOf:)`` on your `View`.
16-
func hapticFeedbackOccurred() {
17-
let generator = UISelectionFeedbackGenerator()
18-
generator.prepare()
19-
generator.selectionChanged()
20-
}
21-
22-
/// Triggers a notification feedback programmatically.
23-
///
24-
/// You can also use ``.haptics(onChangeOf:type:)`` on your `View`.
25-
func hapticFeedbackOccurred(type: UINotificationFeedbackGenerator.FeedbackType) {
26-
let generator = UINotificationFeedbackGenerator()
27-
generator.prepare()
28-
generator.notificationOccurred(type)
29-
}
30-
31-
/// Triggers an impact feedback programmatically.
32-
///
33-
/// You can also use ``.haptics(onChangeOf:type:)`` on your `View`.
34-
func hapticFeedbackOccurred(type: UIImpactFeedbackGenerator.FeedbackStyle) {
35-
let generator = UIImpactFeedbackGenerator(style: type)
36-
generator.prepare()
37-
generator.impactOccurred()
38-
}
39-
}
40-
#elseif os(watchOS)
41-
public extension HapticGenerator {
42-
/// Triggers a haptic feedback programmatically.
43-
///
44-
/// If you want to perform different kinds of feedbacks accordingly, this function might be useful.
45-
///
46-
/// You can also use ``.haptics(onChangeOf:type:)`` on your `View`.
47-
func hapticFeedbackOccurred(type: WKHapticType) {
48-
device.play(type)
7+
/// Perform provided `feedback` instantly.
8+
/// - Parameter feedback: Which type of feedback to play.
9+
static func performFeedback(_ feedback: HapticFeedback) {
10+
feedback.perform()
4911
}
5012
}
51-
#endif
52-
53-
let generator = HapticGenerator.default

‎Sources/Haptics/Haptics+XcodeLibrary.swift

-26
This file was deleted.

0 commit comments

Comments
 (0)