Haptico
Haptico is easy to use iOS haptic feedback generator. Besides default haptic feedbacks it can play patterns! Checkout Example project.
Table of contents
Example
To run the example project, clone the repo, and run pod install from the Example directory first.
How to use
First of all you will need to import Haptico module into your class:
import Haptico
Also keep in mind that depending on the device you are using - the feedback might be different. Starting from iPhone 7 all the iPhones are coming with haptic engine. Prior to iPhone 7 Haptico will use standard vibration. Also Pattern play and impacts are not supported on devices prior to iPhone 7 and iOS 10
1. Generating predefined default feedbacks.
With Haptico you can generate three default types of haptic notifications:
public enum HapticoNotification {
case success
case warning
case error
}
Here is small example how can you generate Success, Warning and Error feedbacks:
@IBAction func generateSuccess(_ sender: Any) {
Haptico.shared().generate(.success)
}
@IBAction func generateWarning(_ sender: Any) {
Haptico.shared().generate(.warning)
}
@IBAction func generateError(_ sender: Any) {
Haptico.shared().generate(.error)
}
2. Generating impact feedbacks
Besides default haptic notifications, Haptico can also generate impact notifications. The library supports three types of impact notifications (available in iOS10+ and staring from iPhone 7):
public enum HapticoImpact {
case light
case medium
case heavy
}
And to use them call:
Haptico.shared().generate(.medium)
Easy, huh?
3. Pattern play
And now something special - Pattern Play. Haptico can play patterns, "coded" as String. Let's take a look at small example:
Haptico.shared().generateFeedbackFromPattern("..oO-Oo..", delay: 0.1)
Each character in this string represents some specific haptic impact:
- "O" (capital "o") - heavy impact
- "o" - medium impact
- "." - light impact
- "-" - delay which has duration of 0.1 second
4. UI extensions
Haptico comes with a couple of UI Extensions: HapticoButton (which is subclass of UIButton) and UIAlertController extension with haptic feedback.
In order to start using HapticoButton - just set the class name in your Storyboard to HapticoButton. Then with UIControlEvents.touchDown event you will get heavy impact feedback and with UIControlEvents.touchUpInside and UIControlEvents.touchUpOutside you will get light impact feedback.
To use Haptico together with UIAlertController follow this simple example:
func showSuccessAlert() {
let alert = UIAlertController(title: "Alert Title", message: "Alert Message", preferredStyle: .alert)
alert.addAction(UIAlertAction(title: "Ok", style: .default, handler: nil))
present(alert, animated: true, hapticNotification: .success)
}
Installation
Haptico is available through CocoaPods, Carthage and Swift Package Manager.
Cocoapods
To install it using CocoaPods, simply add the following line to your Podfile:
pod 'Haptico'
Carthage
To install it via Carthage, add the following line to your Cartfile and follow the instructions to adding frameworks to an application:
github "iSapozhnik/Haptico"
Swift Package Manager
To install it using the Swift Package Manager, either directly add it to your project using Xcode 11, or specify it as dependency in the Package.swift file:
// ...
dependencies: [
.package(url: "https://github.com/iSapozhnik/Haptico.git", from: "1.1.0"),
],
//...
Mentions
Author
isapozhnik, [email protected]
Donation
If you like this project and it helps you to reduce time to develop, you can give me a cup of
License
Haptico is available under the MIT license. See the LICENSE file for more info.
253 Oct 28, 2022
3.2k Dec 30, 2022
4.3k Jan 2, 2023
628 Dec 27, 2022
1 Jan 31, 2022
33 Sep 22, 2022
702 Jan 1, 2023
60 Dec 12, 2022
2 Feb 9, 2022
1.4k Dec 10, 2021
150 Dec 23, 2021
5 Nov 23, 2022
55 Nov 29, 2021
119 Dec 29, 2022
1.1k Jan 6, 2023
410 Sep 9, 2022