Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rxswiftcommunity/rxkeyboard

Reactive Keyboard in iOS
https://github.com/rxswiftcommunity/rxkeyboard

ios keyboard rxswift swift

Last synced: 29 days ago
JSON representation

Reactive Keyboard in iOS

Host: GitHub
URL: https://github.com/rxswiftcommunity/rxkeyboard
Owner: RxSwiftCommunity
License: mit
Created: 2016-10-09T20:42:20.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-11-23T16:38:41.000Z (12 months ago)
Last Synced: 2024-10-14T20:01:38.459Z (29 days ago)
Topics: ios, keyboard, rxswift, swift
Language: Swift
Size: 188 KB
Stars: 1,606
Watchers: 45
Forks: 176
Open Issues: 26
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # RxKeyboard

![Swift](https://img.shields.io/badge/Swift-5.0-orange.svg)

[![CocoaPods](http://img.shields.io/cocoapods/v/RxKeyboard.svg)](https://cocoapods.org/pods/RxKeyboard)

[![Build Status](https://travis-ci.org/RxSwiftCommunity/RxKeyboard.svg?branch=master)](https://travis-ci.org/RxSwiftCommunity/RxKeyboard)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

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

![rxkeyboard-message](https://cloud.githubusercontent.com/assets/931655/22062707/625eea7a-ddbe-11e6-9984-529abae1bd1a.gif)

![rxkeyboard-textview](https://cloud.githubusercontent.com/assets/931655/19223656/14bd915c-8eb0-11e6-93ea-7618fc9c5d81.gif)

## Getting Started

RxKeyboard provides two [`Driver`](https://github.com/ReactiveX/RxSwift/blob/master/Documentation/Traits.md#driver)s.

```swift

/// An observable keyboard frame.

let frame: Driver

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

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

```

Use `RxKeyboard.instance` to get singleton instance.

```swift

RxKeyboard.instance

```

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

```swift

RxKeyboard.instance.frame

  .drive(onNext: { frame in

    print(frame)

  })

  .disposed(by: disposeBag)

```

## Tips and Tricks

- 🔗 **I want to adjust `UIScrollView`'s `contentInset` to fit keyboard height.**

    ```swift

    RxKeyboard.instance.visibleHeight

      .drive(onNext: { [scrollView] keyboardVisibleHeight in

        scrollView.contentInset.bottom = keyboardVisibleHeight

      })

      .disposed(by: disposeBag)

    ```

- 🔗 **I want to adjust `UIScrollView`'s `contentOffset` to fit keyboard height.**

    ```swift

    RxKeyboard.instance.willShowVisibleHeight

      .drive(onNext: { [scrollView] keyboardVisibleHeight in

        scrollView.contentOffset.y += keyboardVisibleHeight

      })

      .disposed(by: 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:

    ```swift

    RxKeyboard.instance.visibleHeight

      .drive(onNext: { [toolbar, view] keyboardVisibleHeight in

        toolbar.frame.origin.y = view.frame.height - toolbar.frame.height - keyboardVisibleHeight

      })

      .disposed(by: disposeBag)

    ```

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

    ```swift

    RxKeyboard.instance.visibleHeight

      .drive(onNext: { [toolbarBottomConstraint] keyboardVisibleHeight in

        toolbarBottomConstraint.constant = -1 * keyboardVisibleHeight

      })

      .disposed(by: disposeBag)

    ```

    > **Note**: In real world, you should use `setNeedsLayout()` and `layoutIfNeeded()` with animation block. See the [example project](https://github.com/RxSwiftCommunity/RxKeyboard/blob/master/Example/Sources/ViewControllers/MessageListViewController.swift#L92-L105) for example.

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

    

## Dependencies

- [RxSwift](https://github.com/ReactiveX/RxSwift) (>= 6.0)

- [RxCocoa](https://github.com/ReactiveX/RxSwift) (>=6.0)

## Requirements

- Swift 5.1

- iOS 9+

## Contributing

In development, RxKeyboard manages dependencies with Swift Package Manager. Use the command below in order to generate a Xcode project file. Note that `.xcodeproj` file changes are not tracked via git.

```console

$ swift package generate-xcodeproj

```

## Installation

- **Using [CocoaPods](https://cocoapods.org)**:

    ```ruby

    pod 'RxKeyboard'

    ```

- **Using [Carthage](https://github.com/Carthage/Carthage)**:

    ```

    binary "https://raw.githubusercontent.com/RxSwiftCommunity/RxKeyboard/master/RxKeyboard.json"

    ```

    ⚠️ With Carthage, RxKeyboard only supports binary installation:

    * 0.9.2

        * Xcode 10.1 (10B61)

        * Swift 4.2.1 (swiftlang-1000.11.42 clang-1000.11.45.1)

    * 0.9.0

        * Xcode 10 (10A255)

        * Swift 4.2 (swiftlang-1000.11.37.1 clang-1000.11.45.1)

    * 0.8.2

        * Xcode 9.3 (9E145)

        * Swift 4.1.0 (swiftlang-902.0.48 clang-902.0.37.1)

    * 0.7.1

        * Xcode 9.1 (9B55)

        * Swift 4.0.2 (swiftlang-900.0.69.2 clang-900.0.38)

    * 0.7.0

        * 9.0.1 (9A1004)

        * Swift 4.0 (swiftlang-900.0.65.2 clang-900.0.37)

## License

RxKeyboard is under MIT license.