https://github.com/kanecheshire/hapticgenerator
Easy peasy haptic generation in iOS.
https://github.com/kanecheshire/hapticgenerator
haptics ios ipad iphone uifeedbackgenerator
Last synced: over 1 year ago
JSON representation
Easy peasy haptic generation in iOS.
- Host: GitHub
- URL: https://github.com/kanecheshire/hapticgenerator
- Owner: KaneCheshire
- License: mit
- Created: 2017-04-25T12:54:38.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2020-06-16T13:57:18.000Z (about 6 years ago)
- Last Synced: 2025-04-13T02:35:35.652Z (over 1 year ago)
- Topics: haptics, ios, ipad, iphone, uifeedbackgenerator
- Language: Swift
- Size: 88.9 KB
- Stars: 35
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HapticGenerator
Easy peasy haptic generation in iOS.
[](https://travis-ci.org/kanecheshire/HapticGenerator)
[](http://cocoapods.org/pods/HapticGenerator)
[](http://cocoapods.org/pods/HapticGenerator)
[](http://cocoapods.org/pods/HapticGenerator)
## Installation
### Swift Package Manager
HapticGenerator supports SPM, simply add HapticGenerator as a package dependency in Xcode 11 or newer.
### Cocoapods
Add the following to your podfile:
```ruby
pod 'HapticGenerator'
```
and then run `pod update` in Terminal.
### Manual
Or you can just add `HapticGenerator.swift` to your project manually.
## Migrating from HapticGenerator 2 to HapticGenerator 3
**HapticGenerator 3.0.0 significantly simplifies naming, but will be a breaking change requiring you to update your app.**
In **HapticGenerator 3**, the line of code to generate a haptic has been simplified:
```swift
Haptic.selection.generate()
Haptic.selection.generate(prepareForReuse: true)
```
Compared to **HapticGenerator 2** which was a bit too verbose for no real good reason:
```swift
HapticGenerator.selection.generateHaptic()
HapticGenerator.selection.generateHaptic(prepareForReuse: true)
```
## Usage
**HapticGenerator** now comes with convenience constants so generating haptics is even easier:
```swift
Haptic.selection.generate()
```
Alternatively, if you'd rather create the generators yourself simply create a new generator like so:
```swift
let selection = Haptic(.selection)
let lightImpact = Haptic(.impact(.light))
let warning = Haptic(.notification(.warning))
```
And then generate a haptic like so:
```swift
selection.generate()
```
Optionally, you can tell the system to prepare the engine for (re)use.
**HapticGenerator** has two ways to do this, either after you generate a haptic by setting `prepareForReuse` to `true`:
```swift
Haptic.selection.generate(prepareForReuse: true)
```
Or if you know in advance before generating a haptic that you'll need to use it soon (after a screen appears for example),
then you can `prepareForUse` manually:
```swift
Haptic.selection.prepareForUse()
```
> **Note:** Haptics should only be generated and prepared for reuse on the main thread.
## Why use this?
Apple's `UIFeedbackGenerator` subclasses are not difficult to use, but they _are_ messy.
**HapticGenerator** tidies this up and makes the process of creating different types of haptics on iOS easy and coherent.
See the difference between creating and using generators of different types Apple's way, and the **HapticGenerator** way:
```swift
// Apple's way of using a selection feedback generator:
let selection = UISelectionFeedbackGenerator()
// Generate the haptic:
selection.selectionChanged()
// Apple's way of using an impact feedback generator:
let lightImpact = UIImpactFeedbackGenerator(style: .light)
lightImpact.impactOccurred()
// Apple's way of using a notification feedback generator:
let success = UINotificationFeedbackGenerator()
success.notificationOccurred(.success)
```
Compared to the **HapticGenerator** way:
```swift
Haptic.selection.generate()
Haptic.lightImpact.generate()
Haptic.success.generate()
```
**HapticGenerator** is significantly less code to write and easier to follow.
Furthermore, if you support any iOS version prior to iOS 10, you won't have ugly availability checks throughout your code because it is all contained within **HapticGenerator**.