Awesome Open Source
Awesome Open Source

NotchToolkit

NotchToolkit is a framework for iOS that allow developers use the iPhone X notch space in creative ways. Inspired by

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

Preview

NotchImageView

imageViewPreview

NotchToolbar

toolbarPreview

Draw Notch

drawPreview

Compatibility

Although NotchToolkit is made for iPhone X, it can be implemented in older iPhone devices. This framework was tested on:

  1. iPhone X
  2. iPhone 8 plus, 7 plus, 6s plus and 6 plus
  3. iPhone 8, 7, 6s and 6
  4. iPhone SE and 5s

NotchToolkit requires

  • iOS 11
  • Swift 3.2 or higher

NotchToolkit has options to customize your Toolbar and UIView,

check Documentation and More Options for more details.

Example Project

To try the example project, simply download this repo then open NotchToolkit-Example.xcworkspace project file, found in the Example folder.

Installation

CocoaPods

  1. Download CocoaPods using this command in Terminal
$ sudo gem install cocoapods
  1. Redirect to your project folder in Terminal
$ cd YOUR_PROJECT_FILE_PATH
  1. Initialize a pod in Terminal
$ pod init
  1. Open Podfile in a text editor and add this line
pod 'NotchToolkit'
  1. Go back to Terminal and install the pod
$ pod install

Carthage

  1. Add this line to the Cartfile in your project directory
github "AFathi/NotchToolkit"
  1. Update your Carthage directory
$ carthage update

Manual

Drag the NotchToolkit.xcodeproj file into your project then add NotchToolkit as an embedded binary of your targets.

Implement in your project

  1. import NotchToolkit in a UIViewController class
  2. Add NotchToolbarDelegate in the delegate section
class ViewController: UIViewController, NotchToolbarDelegate
  1. Add delegate methods
//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) {
}
  1. Create a NotchToolbar global variable
let toolbar = NotchToolbar()
  1. Configure and initialize 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)
  1. Call autoResize() method in the deviceDidRotate delegate method
func deviceDidRotate() {
toolbar.autoResize()
}

You're all set! 🤓

Show and Hide toolbar

showOrHide()

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()
}

Handle Icon Selection

  1. Make sure you set the NotchToolbar delegate to self.
  2. Handle the icon selection in the 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")
}
}

More Options

This framework include a UIView extension that allow you draw a notch bezier path to any UIView class or subclass.

draw(_ notch:curveType, position:curvePosition, curve:CGFloat?, customBounds:CGRect? = nil)

This is a UIView extension that allows you add ovals and rounded corners to any UIView.

  • For type oval, set curve scale from 1.0 - 10.0.
  • For type corner, curve is the radius size.
  • Check curveType & curvePosition for more info.

Example

//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)

Preview

Demo

LICENSE

NotchToolkit is under MIT license. Check the LICENSE file for more details.

Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Swift (64,693
Iphone (6,379
Toolbar (2,715
Swift Framework (414