michaelhenry / keyboardavoider

The missing interactive keyboard in SwiftUI for iOS

⌨️ KeyboardAvoider {}

A KeyboardAvoider for SwiftUI. Inspired by the simplicity of keyboard_avoider in Flutter.

Features

• Autoscroll to TextField
• Swipe keyboard to dismiss

Installation

Swift Package Manager

Create a Package.swift file.

import PackageDescription

let package = Package(
  name: "TestProject",
  dependencies: [
    .package(url: "https://github.com/michaelhenry/KeyboardAvoider.git", from: "1.0.0")
  ]
)

Cocoapods

target 'MyApp' do
  pod 'KeyboardAvoider', '~> 1.0'
end

How to use

import KeyboardAvoider

KeyboardAvoider {
  // ... Your view with TextFields
}

Example:

KeyboardAvoider {
    VStack {
        TextField("First name", text: self.$firstname)
        TextField("Last name", text: self.$lastname)
        TextField("Email", text: self.$email)
        TextField("Password", text: self.$password)
        TextField("Confirm password", text: self.$password)
        Button("Sign Up") {

        }
        Button("Already have an account?") {

        }
    }
    .padding(.horizontal, 16.0)
}

Or in case you don't want to make your view scrollable, you can just only apply the .avoidKeyboard() into your main view.

    VStack {
        TextField("First name", text: self.$firstname)
        TextField("Last name", text: self.$lastname)
        TextField("Email", text: self.$email)
        TextField("Password", text: self.$password)
        TextField("Confirm password", text: self.$password)
        Button("Sign Up") {

        }
        Button("Already have an account?") {

        }
    }
    .avoidKeyboard()

FAQ

• How to remove the extra space between the textfield and the keyboard

  You can remove it by ignoring the safe area - bottom. Please see the Sample Project

 .edgesIgnoringSafeArea(.bottom)

keyboardavoider's Issues

Use keyboard.frame.origin.y as reference instead of keyboard height.

So the scroll view’s bottom padding will be independent to the safe area

Xcode 12

'shared' is unavailable in application extensions for iOS: Use view controller based solutions where appropriate instead.

iPad OS Support

is it possible to add ipad OS support, that would be great

No space provided for between the keyboard and the text view.

As you can see in the example GIFs, the revealed text view and the onscreen keyboard are right next to either other, with 0px of space between them. It would be more attractive with a little bit of extra spacing.

Exposing keyboard height publisher

Just incase user dont wanted to use the KeyboardAvoider view wrapper