Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/efremidze/haptica
Easy Haptic Feedback Generator 📳
https://github.com/efremidze/haptica
apple carthage cocoapods feedback generator haptic ios ios10 notes patterns swift taptic uibutton vibrate
Last synced: 1 day ago
JSON representation
Easy Haptic Feedback Generator 📳
- Host: GitHub
- URL: https://github.com/efremidze/haptica
- Owner: efremidze
- License: mit
- Created: 2017-03-31T22:09:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-08-28T01:25:50.000Z (about 2 years ago)
- Last Synced: 2024-10-19T03:04:14.483Z (26 days ago)
- Topics: apple, carthage, cocoapods, feedback, generator, haptic, ios, ios10, notes, patterns, swift, taptic, uibutton, vibrate
- Language: Swift
- Homepage:
- Size: 703 KB
- Stars: 771
- Watchers: 10
- Forks: 42
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/efremidze/Haptica)
[](https://github.com/Carthage/Carthage)
[](https://swift.org)
[](http://cocoapods.org/pods/Haptica)
[](http://cocoapods.org/pods/Haptica)
[](http://cocoapods.org/pods/Haptica)
**Haptica** is an easy haptic feedback generator.
```
$ pod try Haptica
```
## Requirements
- iOS 9.0+
- Xcode 8.0+
- Swift 5 (Haptica 3.x), Swift 4 (Haptica 2.x), Swift 3 (Haptica 1.x)
### Haptic Feedback Requirements:
- A device with a supported Taptic Engine.
- App is running in the foreground.
- System Haptics setting is enabled.
## Usage
Generate using a haptic feedback type.
```swift
Haptic.impact(.light).generate()
```
### Feedback Types
* **Impact**: ([UIImpactFeedbackStyle](https://developer.apple.com/reference/uikit/uiimpactfeedbackstyle)) - Use impact feedback generators to indicate that an impact has occurred. For example, you might trigger impact feedback when a user interface object collides with something or snaps into place.
* light
* medium
* heavy
* **Notification**: ([UINotificationFeedbackType](https://developer.apple.com/reference/uikit/uinotificationfeedbacktype)) - Use notification feedback to communicate that a task or action has succeeded, failed, or produced a warning of some kind.
* success
* warning
* error
* **Selection** - Use selection feedback to communicate movement through a series of discrete values.
### Vibration Patterns
Play a custom vibration pattern:
```swift
Haptic.play("..oO-Oo..", delay: 0.1)
```
Use pattern symbols to represent custom vibrations.
- `O` - heavy impact
- `o` - medium impact
- `.` - light impact
- `X` - rigid impact
- `x` - soft impact
- `-` - wait 0.1 second
Or play a symphony of notes:
```swift
Haptic.play([.haptic(.impact(.light)), .haptic(.impact(.heavy)), .wait(0.1), .haptic(.impact(.heavy)), .haptic(.impact(.light))])
```
### UIButton Extension
To enable haptic feedback on buttons, set these properties:
- `isHaptic` - enables haptic feedback
- `hapticType` - haptic feedback type
```swift
button.isHaptic = true
button.hapticType = .impact(.light)
```
or use these functions to set the haptic feedback type for control events:
- `addHaptic()` - add haptic feedback for control events
- `removeHaptic()` - remove haptic feedback for control events
```swift
button.addHaptic(.selection, forControlEvents: .touchDown)
button.removeHaptic(forControlEvents: .touchDown)
```
#### Functions/Properties
```swift
var isHaptic: Bool // enables haptic feedback
var hapticType: Haptic? // haptic feedback type
var hapticControlEvents: UIControl.Event? // haptic feedback control events
func addHaptic(_ haptic: Haptic, forControlEvents events: UIControl.Event) {} // add haptic feedback for control events
func removeHaptic(forControlEvents events: UIControl.Event) {} // remove haptic feedback for control events
```
### Sound Effects
Add sound effects to Haptica using [Peep](https://github.com/efremidze/Peep).
```swift
Peep.play(sound: KeyPress.tap)
```
## Installation
### CocoaPods
To install with [CocoaPods](http://cocoapods.org/), simply add this in your `Podfile`:
```ruby
use_frameworks!
pod "Haptica"
```
### Carthage
To install with [Carthage](https://github.com/Carthage/Carthage), simply add this in your `Cartfile`:
```ruby
github "efremidze/Haptica"
```
## Communication
- If you **found a bug**, open an issue.
- If you **have a feature request**, open an issue.
- If you **want to contribute**, submit a pull request.
## Mentions
- [Fresh Swift](http://freshswift.net/post/-kj8ocn5j9lt_ljpffm4/)
## License
Haptica is available under the MIT license. See the LICENSE file for more info.