• Stars
    star
    502
  • Rank 87,851 (Top 2 %)
  • Language
    Swift
  • License
    MIT License
  • Created over 7 years ago
  • Updated almost 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A button that is triggered based on the 3D Touch pressure, similar to the iOS 11 control center.

buddybuild Carthage License Platform Twitter: @BalestraPatrick

HapticButton

๐Ÿ“– Description

HapticButton replicates the behavior of the buttons in the iOS 10 and 11 Control Center as well as in the Home app. A device with 3D Touch is required to fully experience the haptic feedback on supported devices. It is implemented as a subclass of UIControl, so feel free to further customize it to your needs.

The user is required to press the button and activate 3D Touch with a minimum pressure threshold (you can specify the minimum value to trigger the button via the feedbackThreshold property). This allows for a cool interaction that gives a haptic feedback to the user when the button is triggered. ๐Ÿ‘

For the best experience, install the example on a device. ๐Ÿ“ฑ

The example project shows how to set up HapticButton in a few different ways.

  • Create a button with a UILabel. Use the HapticButtonDelegate to be notified when the button is triggered.
@IBOutlet weak var button: HapticButton!
button.mode = .label(text: "Hello! ๐Ÿ‘‹")
// Use the delegate method to be notified when the button is pressed.
button.delegate = self
  • Create a button with a UIImageView and a blur background. Use the standard UIControl event to subscribe to the touch up inside event.
let blurButton = HapticButton(mode: .image(image: #imageLiteral(resourceName: "swift")))
blurButton.addBlurView(style: .light)
// Add custom target selector to the touch up inside event.
blurButton.addTarget(self, action: #selector(blurButtonPressed(_:)), for: .touchUpInside)
  • Create a button with a customized UILabel and dark blur background. Subcribe to the button events through a closure.
let blurButton = HapticButton(mode: .label(text: "Hello Blur!"))
darkBlurButton.textLabel.textColor = .white
darkBlurButton.addBlurView(style: .dark)
// Pass closure to be invoked when the button is pressed.
darkBlurButton.onPressed = {
	print("Dark blur button pressed.")
}

๐ŸŽจ Customizations

These are the public properties that allow you to customize the control. In case you are thinking to modify HapticButton even further, consider creating a Pull Request! ๐Ÿ‘๐Ÿป

public weak var delegate: HapticButtonDelegate?

/// The closure invoked when the button is pressed.
public var onPressed: Callback?

/// The minimum pressure that the button press has to receive in order to trigger the related haptic feedback. The value has to be between 0 and 1 and the default is 0.25.
public var feedbackThreshold = 0.25

/// If the button is in mode `label`, this `UILabel` is part of the button hierarchy. Modify this object directly for more customizations on the displayed text.
public lazy var textLabel: UILabel

/// If the button is in mode `image`, this `UIImageView` is part of the button hierarchy. Modify this object directly for more customizations on the displayed image.
public lazy var imageView: UIImageView

/// The current mode of the button.
public var mode = HapticButtonMode.label(text: "Title")

๐Ÿ”ž Requirements

iOS 10.0 and Swift 3.2 are required.

If you are using Swift 4, please use the swift4 branch.

๐Ÿ›  Installation

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

pod "HapticButton"

You can also use Carthage if you prefer. Add this line to your Cartfile.

github "BalestraPatrick/HapticButton"

๐Ÿ‘จโ€๐Ÿ’ป Author

I'm Patrick Balestra.

Email: [email protected]

Twitter: @BalestraPatrick.

License

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

More Repositories

1

WhatsNew

Showcase new features after an app update similar to Pages, Numbers and Keynote.
Swift
1,503
star
2

ParticlesLoadingView

A customizable SpriteKit particles animation on the border of a view.
Swift
971
star
3

SquishButton

A button that squishes when pressed. As seen in the Clips app.
Swift
396
star
4

ValueStepper

A Stepper object that displays its value.
Swift
393
star
5

RealmVideo

An iOS app to watch Realm videos and slides at the same time on your phone.
Swift
322
star
6

Stryng

Swift strings taken to a whole new syntax level.
Swift
257
star
7

VideoToGIF

A simple Mac app to easily convert videos to GIF.
Swift
190
star
8

CleanClosureXcode

An Xcode Source Editor extension to clean the closure syntax.
Swift
185
star
9

AppleWatchCalculator

A calculator for your Apple Watch but only if you have fingers small enough to press the buttons.
Objective-C
152
star
10

OpenIt

An iOS app and a notification widget that allows the launch of other apps from the notification center.
Objective-C
111
star
11

Tweetometer

An app to see who is tweeting in your timeline.
Swift
89
star
12

ClangFormatter

Xcode Source Editor Extension for clang-format
Swift
86
star
13

HomeKitty

A Vapor 3 website to easily browse HomeKit accessories.
Swift
74
star
14

BadgesGenerator

A Swift playground to automatically generate personalized conference badges.
Swift
36
star
15

FlightUtilities

A small app that uses the private FlightUtilities.framework to show information about any flight.
Objective-C
31
star
16

appbuilders18app

The App Builders 2018 iOS and Android app built as an experiment in React Native.
JavaScript
29
star
17

SwiftBlog

A simple Swift app that reads the official Apple Swift Blog via RSS.
Swift
22
star
18

EmergencyAPI

An API written in Swift for the world emergency phone numbers.
Swift
16
star
19

AppleWatchProductHunt

An Apple watchapp that displays the top posts from Product Hunt.
Swift
15
star
20

iTunesConnectReports-Extension

A very simple Today View extension for iOS 8 to check if today's iTunes Connect reports are already released.
Objective-C
15
star
21

RxTableViewExample

A simple UITableView example implemented with RxSwift and RxDataSources.
Swift
12
star
22

Animoke

Animoji Karaoke for your iPhone X.
Swift
11
star
23

ios-links

A list of all the useful links I find, for my and your future reference.
9
star
24

TwitterKit-Rx

RxSwift extension to interact with the Twitter API via TwitterKit.
Swift
8
star
25

SlacKick

A script to kick and re-add a user from all channels in a Slack group.
Swift
8
star
26

WWDC-2015-Scholarship

This is my WWDC 2015 student scholarship application built in SceneKit and UIKit.
Swift
8
star
27

PebbleConfigurationExample

A simple Pebble app and a website to demonstrate how to create a configuration page for your app.
7
star
28

WWDC-2014-Scholarship

This is my entry for a WWDC 214 Scholarship. It's an iPad app about me!
Objective-C
7
star
29

SpeechRecognitionDemo

The companion project for the Tuts+ tutorial "Using the Speech Recognition API in iOS 10".
Swift
6
star
30

WatchKitSettingsBundle

A demo project that shows how to use the WatchKit Settings Bundle feature.
Swift
6
star
31

SiriKitDemo

The companion project for the Tuts+ tutorial "Create SiriKit Extensions in iOS 10".
Swift
6
star
32

PebbleRetreatSchedule

The perfect watch app to attend the Pebble Developer Retreat 2014.
C
5
star
33

PebblePasscodeWindow

A Passcode Window to make your Pebble watchapp safer.
C
3
star
34

NewInSwift4

The companion project for the Tuts+ tutorial "What's New in Swift 4".
Swift
3
star
35

WatchKitLayoutSystemDemo

Demo project for my tutorial written for Tuts+ about the WatchKit layout system.
Objective-C
2
star
36

WWDC-2014-Pebble-Watchface

A countdown/watchface for WWDC 2014 on your Pebble.
C
2
star
37

RandomDroplr

Just a small iPhone app developed in a few hours for fun. The app builds a random 4 characters string to generate a droplr link so every time you click next, you can see a new file.
2
star
38

PlaygroundXcode8

Contains the demo code and blog post about Playground in Xcode 8.
Swift
1
star
39

PasswordAutoFill

The companion project for the Tuts+ tutorial "Password AutoFill in iOS 11".
Swift
1
star
40

AppleSearch

A Vapor app consisting in a simple search engine built for my information retrieval course project.
Swift
1
star
41

PageControlIntroduction

A small demo on how to create an Introduction for an iOS app with a UIScrollView.
1
star
42

SpotlightEffectDemo

SpotlightEffectDemo
Objective-C
1
star
43

PebbleAppStoreHearts

A simple app to retrieve the number of hearts an app has in the Pebble App Store given its App ID. It sends a push notification when the number changes too.
1
star
44

SBBZurichHB

HackZurich 2016 project that may allow to receive Zurich SBB station loudspeaker messages on your phone.
HTML
1
star
45

RocketCorgi

A flying corgi with a rocket jetpack as our Computer Graphics final project. ๐Ÿถ๐Ÿš€
C++
1
star
46

lunchtime-USI

A Mac application written in Racket to browse the canteen menu for the USI university
Racket
1
star