Typist is a small, drop-in Swift UIKit keyboard manager for iOS apps. It helps you manage keyboard's screen presence and behavior without notification center and Objective-C.
You can use CocoaPods to install Typist
by adding it to your Podfile
:
platform :ios, '10.0'
use_frameworks!
pod 'Typist'
Import Typist
wherever you plan to listen to keyboard events. Usually in your UIViewController
subclasses.
import UIKit
import Typist
Create a Cartfile
that lists the framework and run carthage update
. Follow the instructions to add $(SRCROOT)/Carthage/Build/iOS/Typist.framework
to an iOS project.
github "totocaster/Typist"
Download and drop Typist.swift
in your project.
Declare what should happen on what event and start()
listening to keyboard events. That's it.
let keyboard = Typist.shared
func configureKeyboard() {
keyboard
.on(event: .didShow) { (options) in
print("New Keyboard Frame is \(options.endFrame).")
}
.on(event: .didHide) { (options) in
print("It took \(options.animationDuration) seconds to animate keyboard out.")
}
.start()
}
Usage of both—singleton, or your own instance of Typist
—is considered to be OK depending on what you want to accomplish.
You must call start()
for callbacks to be triggered. Calling stop()
on instance will stop callbacks from triggering, but callbacks themselves won't be dismissed, thus you can resume event callbacks by calling start()
again.
To remove all event callbacks, call clear()
. Passing nil
instead of closure also removes event callback.
Every event callback has a parameter of Typist.KeyboardOptions
type. It is an inert/immutable struct which carries all data that keyboard has at the event of happening:
belongsToCurrentApp
—Bool
that identifies whether the keyboard belongs to the current app. With multitasking on iPad, all visible apps are notified when the keyboard appears and disappears. The value istrue
for the app that caused the keyboard to appear andfalse
for any other apps.startFrame
—CGRect
that identifies the start frame of the keyboard in screen coordinates. These coordinates do not take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. Thus, you may need to convert the rectangle to window coordinates (using theconvertRect:fromWindow:
method) or to view coordinates (using theconvertRect:fromView:
method) before using it.endFrame
—CGRect
that identifies the end frame of the keyboard in screen coordinates. These coordinates do not take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. Thus, you may need to convert the rectangle to window coordinates (using theconvertRect:fromWindow:
method) or to view coordinates (using theconvertRect:fromView:
method) before using it.animationCurve
—UIViewAnimationCurve
constant that defines how the keyboard will be animated onto or off the screen.animationDuration
—Double
that identifies the duration of the animation in seconds.
Following keyboard events are supported:
willShow
didShow
willHide
didHide
willChangeFrame
didChangeFrame
If you declare two closures on same event, only latter will be executed.
Typist is released under the MIT license. See LICENSE
for details.