Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevebarnegren/sbkeyboardevents
Easily respond to iOS keyboard appearance
https://github.com/stevebarnegren/sbkeyboardevents
appear constraint ios keyboard layout uikit
Last synced: 24 days ago
JSON representation
Easily respond to iOS keyboard appearance
- Host: GitHub
- URL: https://github.com/stevebarnegren/sbkeyboardevents
- Owner: SteveBarnegren
- License: mit
- Created: 2017-01-24T21:54:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-31T20:37:08.000Z (over 5 years ago)
- Last Synced: 2024-11-18T05:13:48.048Z (about 1 month ago)
- Topics: appear, constraint, ios, keyboard, layout, uikit
- Language: Swift
- Size: 60.5 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SBKeyboardEvents
[](http://cocoapods.org/pods/SBKeyboardEvents)
[](http://cocoapods.org/pods/SBKeyboardEvents)
[](http://cocoapods.org/pods/SBKeyboardEvents)
SBKeyboardEvents makes it easy to repond to keyboard events without having to write the same boilerplate code in every view controller. No more subscribing to a bunch of Notifications in viewDidLoad!
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Installation
SBKeyboardEvents is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod "SBKeyboardEvents"
```
## Usage
Your ViewController (or other class, if you like), should implement the 'KeyboardEventListener' protocol. It should then register itself for keyboard events should with the `SBKeyboardEvents` singleton:
######(There are methods for unsubscribing a listener, but this is handled automatically when the class is deallocated, so in practice, these methods should very rarely be required. It is safe subscribe and forget. SBKeyboardEvents keeps a weak reference to listeners, so it will not retain them)
```swift
override func viewDidLoad() {
super.viewDidLoad()
SBKeyboardEvents.addListener(self)
}
```
For the simplest implementation, you only need to implement a single method, `animateForKeyboardHeight(height:)`
This method is called from within the keyboard appearance/disappearance animation block, so adjust constraints/frames, and the rest will be handled automatically. Note that the height here, is the keyboard height from the bottom of the screen.
```swift
extension GameSetupViewController: KeyboardEventListener {
func animateForKeyboardHeight(_ height: CGFloat) {
keyboardPaddingConstraint.constant = height;
view.setNeedsLayout()
view.layoutIfNeeded()
}
}
```
This is the full Protocol declaration:
```swift
public protocol KeyboardEventListener : class {
func keyboardWillAppear()
func keyboardDidAppear()
func keyboardWillHide()
func keyboardDidHide()
func keyboardWillChangeFrame(_ frame: CGRect)
func keyboardDidChangeFrame(_ frame: CGRect)
func animateForKeyboardFrame(_ frame: CGRect)
func animateForKeyboardHeight(_ height: CGFloat)
}
```
Functions containing 'will' occur before the animation.
Functions containing 'did' occur after the animation.
Functions starting 'animate' are called from within the keyboard animation block
## Author
Steve Barnegren, [email protected]
[@SteveBarnegren](https://twitter.com/stevebarnegren)
## License
SBKeyboardEvents is available under the MIT license. See the LICENSE file for more info.