RxKeyboard 0.4.1

RxKeyboard 0.4.1

DocsDocumented
TestsTested
LangLanguage SwiftSwift
License MIT
ReleasedLast Release Jan 2017
SwiftSwift Version 3.0
SPMSupports SPM

Maintained by Suyeol Jeon.


Downloads

Total16,599
Week2,348
Month8,070

Installs

Apps280
Apps WeekApps This Week 113
Test Targets39
Test WeekTests This week 15
powered by Segment

GitHub

Stars404
Watchers37
Forks17
Issues1
Contributors1
Pull Requests0

Code

Files1
SizeIntegration Size 20 kb
FrameworkCreates Framework
LOCLines of Code 101


 
Depends on:
RxSwift>= 3.0
RxCocoa>= 3.0
 

  • By
  • Suyeol Jeon

RxKeyboard

RxKeyboard provides a reactive way of observing keyboard frame changes. Forget about keyboard notifications. It also perfectly works with UIScrollViewKeyboardDismissMode.interactive.

rxkeyboard-message rxkeyboard-textview

Getting Started

RxKeyboard provides two Drivers.

/// An observable keyboard frame.
let frame: Driver<CGRect>

/// An observable visible height of keyboard. Emits keyboard height if the keyboard is visible
/// or `0` if the keyboard is not visible.
let visibleHeight: Driver<CGFloat>

/// Same with `visibleHeight` but only emits values when keyboard is about to show. This is
/// useful when adjusting scroll view content offset.
let willShowVisibleHeight: Driver<CGFloat>

Use RxKeyboard.instance to get singleton instance.

RxKeyboard.instance

Subscribe RxKeyboard.instance.frame to observe keyboard frame changes.

RxKeyboard.instance.frame
  .drive(onNext: { frame in
    print(frame)
  })
  .addDisposableTo(disposeBag)

Tips and Tricks

  • 🔗 I want to adjust UIScrollView’s contentInset to fit keyboard height.

    RxKeyboard.instance.visibleHeight
      .drive(onNext: { keyboardVisibleHeight in
        scrollView.contentInset.bottom = keyboardVisibleHeight
      })
      .addDisposableTo(disposeBag)
  • 🔗 I want to adjust UIScrollView’s contentOffset to fit keyboard height.

    RxKeyboard.instance.willShowVisibleHeight
      .drive(onNext: { keyboardVisibleHeight in
        scrollView.contentInset.offset.y += keyboardVisibleHeight
      })
      .addDisposableTo(disposeBag)
  • 🔗 I want to make UIToolbar move along with the keyboard in an interactive dismiss mode. (Just like the wonderful GIF above!)

    If you’re not using Auto Layout:

    RxKeyboard.instance.visibleHeight
      .drive(onNext: { keyboardVisibleHeight in
        toolbar.frame.origin.y = self.view.height - toolbar.frame.height - keyboardVisibleHeight
      })
      .addDisposableTo(disposeBag)

    If you’re using Auto Layout, you have to capture the toolbar’s bottom constraint and set constant to keyboard visible height.

    RxKeyboard.instance.visibleHeight
      .drive(onNext: { keyboardVisibleHeight in
        toolbarBottomConstraint.constant = -1 * keyboardVisibleHeight
      })
      .addDisposableTo(disposeBag)

    Note: In real world, you should use setNeedsLayout() and layoutIfNeeded() with animation block. See the demo project for example.

  • Anything else? Please open an issue or make a Pull Request.

Dependencies

Requirements

  • Swift 3
  • iOS 8+

Installation

  • Using CocoaPods:

    pod 'RxKeyboard', '~> 0.4'
  • Using Carthage:

    github "devxoul/RxKeyboard" ~> 0.4
    

License

RxKeyboard is under MIT license.