TestsTested | โ |
LangLanguage | SwiftSwift |
License | MIT |
ReleasedLast Release | Oct 2017 |
SwiftSwift Version | echo "4.0" > .swift-version |
SPMSupports SPM | โ |
Maintained by Ahmed Bekhit.
NotchToolkit is a framework for iOS that allow developers use the iPhone X notch space in creative ways.
Inspired by
I was working on this idea of blending app design with the #iPhoneX notch.
โ Luboลก Volkov๐ฒ ๐ค pic.twitter.com/lj2AhxWNeEโก๏ธ (@0therplanet) September 18, 2017
Table of Contents | Description |
---|---|
Documentation | Describes the configuration options NotchToolkit offers |
Preview | Displays preview images of NotchToolkit features |
Compatibility | Describes the NotchToolkit device and iOS compatibality |
Example Project | Explains how to run the example project provided in this repository |
Installation | Describes the CocoaPods, Carthage, and Manual options to install NotchToolkit |
Implementation | Lists the steps needed to implement NotchToolkit into your project |
More Options | Describes an extra feature NotchToolkit supports |
License | Describes NotchToolkit license |
NotchImageView
Although NotchToolkit
is made for iPhone X, it can be implemented in older iPhone devices. This framework was tested on:
NotchToolkit
requires
NotchToolkit
has options to customize your Toolbar and UIView,
check Documentation and More Options for more details.
To try the example project, simply download this repo then open NotchToolkit-Example.xcworkspace
project file, found in the Example
folder.
Terminal
$ sudo gem install cocoapods
Terminal
$ cd YOUR_PROJECT_FILE_PATH
Terminal
$ pod init
pod 'NotchToolkit'
Terminal
and install the pod$ pod install
Cartfile
in your project directorygithub "AFathi/NotchToolkit"
$ carthage update
Drag the NotchToolkit.xcodeproj
file into your project then add NotchToolkit
as an embedded binary of your targets.
import NotchToolkit
in a UIViewController
classNotchToolbarDelegate
in the delegate sectionclass ViewController: UIViewController, NotchToolbarDelegate
//A protocol method that's triggered when the device rotates.
func deviceDidRotate() {
}
//A protocol method that's triggered when an icon is selected.
func didTapToolIcon(_ tools: UICollectionView, toolIndex: IndexPath, section: Int, row: Int) {
}
NotchToolbar
global variablelet toolbar = NotchToolbar()
toolbar
in viewDidLoad
toolbar.notch.isVisible = true
toolbar.notch.height = 250
toolbar.toolList = [
//[icon image, title]
[UIImage(named:"pikachusquare")!, "Pikachu"],
//only image icons
UIImage(named:"spongebob")!,
//only string icons (mainly for emojis ๐)
"๐ค", "๐ค",
"๐ฑ", "๐ฉโ๐ป",
"๐จโ๐ป", "โ
", "๐ฅ"]
toolbar.delegate = self
toolbar.initializeToolbar(self)
autoResize()
method in the deviceDidRotate
delegate methodfunc deviceDidRotate() {
toolbar.autoResize()
}
You're all set!
toolbar
This method allows you to show and hide the NotchToolbar
. You can call this method in an IBAction
that handles showing/hiding the toolbar.
@IBAction func buttonClicked(_ sender: UIButton) {
toolbar.showOrHide()
}
NotchToolbar
delegate to self
.didTapToolIcon
delegate method:func didTapToolIcon(_ tools: UICollectionView, toolIndex: IndexPath, section: Int, row: Int) {
if row == 0 {
print("first icon")
}else if row == 1 {
print("second icon")
}
}
This framework include a UIView
extension that allow you draw a notch bezier path to any UIView
class or subclass.
This is a UIView extension that allows you add ovals and rounded corners to any UIView.
oval
, set curve
scale from 1.0 - 10.0.corner
, curve
is the radius size.curveType
& curvePosition
for more info.//horizontalSides draws an oval-based bezier path vertically on the right & left sides of a view.
myView.draw(.oval, position: .horizontalSides, curve: 1.5)
//diagonalAC draws rounded rectangle corners diagonally from topLeft to bottomRight of a view.
myView.draw(.corner, position: .diagonalAC, curve: 35)
NotchToolkit
is under MIT license. Check the LICENSE file for more details.