TapticEngine generates haptic feedback vibrations on iOS device.
Switch branches/tags
Nothing to show
Clone or download
Latest commit bd95a0b Aug 12, 2018

README.md

TapticEngine

License Swift Carthage compatible CocoaPods compatible Downloads with CocoaPods Awesome

Overview

TapticEngine generates haptic feedback vibrations on iOS device. This library wrapps on UIImpactFeedbackGenerator, UISelectionFeedbackGenerator, UINotificationFeedbackGenerator.

demo_screenshot

Demo

Build Xcode project.

  1. Open TapticEngine.xcodeproj.
  2. Change Scheme to TapticEngineDemo
  3. Run

Usage

// Triggers an impact feedback between small, light user interface elements. (`UIImpactFeedbackStyle.light`)
TapticEngine.impact.feedback(.light)

// Triggers an impact feedback between moderately sized user interface elements. (`UIImpactFeedbackStyle.medium`)
TapticEngine.impact.feedback(.medium)

// Triggers an impact feedback between large, heavy user interface elements.  (`UIImpactFeedbackStyle.heavy`)
TapticEngine.impact.feedback(.heavy)

// Triggers a selection feedback to communicate movement through a series of discrete values.
TapticEngine.selection.feedback()

// Triggers a notification feedback, indicating that a task has completed successfully. (`UINotificationFeedbackType.success`)
TapticEngine.notification.feedback(.success)

// Triggers a notification feedback, indicating that a task has produced a warning. (`UINotificationFeedbackType.warning`)
TapticEngine.notification.feedback(.warning)

// Triggers a notification feedback, indicating that a task has failed. (`UINotificationFeedbackType.error`)
TapticEngine.notification.feedback(.error)

// Prepare an impact feedback for `UIImpactFeedbackStyle.light`.
TapticEngine.impact.prepare(.light)

// Prepare a selection feedback.
TapticEngine.selection.prepare()

// Prepare a notification feedback.
TapticEngine.notification.prepare()

Requirements

  • Swift 4.0+
  • iOS 9.0+ (But it works on iOS 10 or later. On iOS 9, it does nothing.)

Installation

Carthage

TapticEngine is available through Carthage. To install it, simply add the following line to your Cartfile:

github "WorldDownTown/TapticEngine"

CocoaPods

TapticEngine is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'TapticEngine'

Manually

Download and drop TapticEngine/Sources folder in your project.

Author

WorldDownTown, WorldDownTown@gmail.com

License

TapticEngine is available under the MIT license. See the LICENSE file for more info.