Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liyanan2004/swiftui-haptics
A set of super-light modifiers and functions that adds haptic feedbacks to any SwiftUI View.
https://github.com/liyanan2004/swiftui-haptics
haptic-feedback swift swiftui
Last synced: 21 days ago
JSON representation
A set of super-light modifiers and functions that adds haptic feedbacks to any SwiftUI View.
- Host: GitHub
- URL: https://github.com/liyanan2004/swiftui-haptics
- Owner: LiYanan2004
- License: mit
- Created: 2023-01-04T14:23:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T11:24:12.000Z (11 months ago)
- Last Synced: 2024-12-19T07:21:30.889Z (21 days ago)
- Topics: haptic-feedback, swift, swiftui
- Language: Swift
- Homepage:
- Size: 20.5 KB
- Stars: 21
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftUI-Haptics
[](https://swiftpackageindex.com/LiYanan2004/SwiftUI-Haptics)
[](https://swiftpackageindex.com/LiYanan2004/SwiftUI-Haptics)
`Haptics` has a set of super-light modifiers and functions that adds haptic feedbacks to any SwiftUI `View`, for example, when the specific property changes or equals to a specific value, the feedback will be triggered automatically.
```swift
import SwiftUI
import Haptics
⋮
⋮
YourView()
.hapticFeedback(.selection, trigger: isSelected)
```
or using the function programmatically
```swift
HapticGenerator.performFeedback(.selection)
```
## Platforms
- iOS 14.0+
- watchOS 7.0+
- macOS 11.0+
## Haptic Feedbacks
- `start`: Indicates that an activity started. **(watchOS only)**
- `stop`: Indicates that an activity stopped. **(watchOS only)**
- `alignment`: Indicates the alignment of a dragged item. **(macOS only)**
- `decrease`: Indicates that an important value decreased below a significant threshold. **(watchOS only)**
- `increase`: Indicates that an important value increased above a significant threshold. **(watchOS only)**
- `levelChange`: Indicates movement between discrete levels of pressure. **(macOS only)**
- `selection`: Indicates that a UI element’s values are changing. **(iOS & watchOS)**
- `success`: Indicates that a task or action has completed. **(iOS & watchOS)**
- `warning`: Indicates that a task or action has produced a warning of some kind. **(iOS & watchOS)**
- `error`: Indicates that an error has occurred. **(iOS & watchOS)**
- `impact`: Provides a physical metaphor you can use to complement a visual experience. **(iOS & watchOS)**
## Value-based Haptic Feedbacks
Play haptic feedbacks when the value changes.
```swift
YourView()
.hapicFeedback(.selection, trigger: isSelected)
```
## Dynamic Haptic Feedbacks
If the value being monitored changes, returns a `HapticFeedback` to be performed.
Return `nil` means **DO NOT** perform any haptics.
You can provide different haptic feedbacks based on your trigger value.
```swift
YourView()
.hapicFeedback(trigger: workStatus) { _, newValue in
return switch {
case .success: .success
case .failure: .error
default: nil
}
}
.hapicFeedback(.impact, trigger: cameraSession.capturedPhoto) { _, newValue in
return newValue == true // Only plays feedback when photo has been taken
}
```
## Looks familiar?
Yeah.
If you want to use `.sensoryFeedback` API but need to support older platform, `SwiftUI-Haptics` is a better solution.
Replace `sensoryFeedback` to `hapticFeedback`.
Everything just works.
## Swift Package Manager
In your `Package.swift` Swift Package Manager manifest, add the following dependency to your `dependencies` argument:
```swift
.package(url: "https://github.com/LiYanan2004/SwiftUI-Haptics.git", .branch("main")),
```
Add the dependency to any targets you've declared in your manifest:
```swift
.target(name: "MyTarget", dependencies: ["Haptics"]),
```