SwiftUI ScrollView Keyboard Avoidance

Question

First off. I know the SwiftUI ScrollView has limitations. I am hoping to get around that here.

My problem is I have a chat box...so a VStack with a ScrollView and a text input. I am able to get the text input to be keyboard adaptive...i.e. when you type it shifts up with the keyboard.

The issue is that the ScrollView loses its scroll position. So, if you scroll to the bottom and then activate the keyboard...you can't see the bottom anymore. It's almost like a ZStack.

What I want is to mimic the same behavior as WhatsApp which maintains scroll position while typing a new message.

I know about the ScrollViewReader and scrollTo...that seems to be a hack in this case and I'm hoping to avoid it. If anything, maybe there is a layout related fix?

Timmerz · Accepted Answer · 2021-03-01 20:49:29Z

3

By a stroke of luck I was able to solve this by adding .keyboardAdaptive() to both the ScrollView and the text input as well as changing from padding to offset

struct KeyboardAdaptive: ViewModifier {
    @State private var keyboardHeight: CGFloat = 0

    @State var offset: CGFloat
    
    func body(content: Content) -> some View {
        content
            .offset(y: -keyboardHeight)
            .onReceive(Publishers.keyboardHeight) {
                self.keyboardHeight = $0 == 0 ? 0 : $0 - offset
            }
    }
}

answered Mar 1, 2021 at 20:49

Timmerz

6,1795 gold badges38 silver badges50 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Doug Over a year ago

This looks like a great answer @Timmerz, but I am unsure where Publishers.keyboardHeight comes from 😕

rage Over a year ago

github.com/V8tr/KeyboardAvoidanceSwiftUI

Tanvirgeek Over a year ago

is there a native way to get keyboard height?

kerd Over a year ago

In the provided snippet @State var offset never changes. Could you, please, elaborate on what value it should take?

alexxjk Over a year ago

But if you apply KeyboardAdaptive to the ScrollView you can never scroll to the top of the content, won't you?

|

Abhishek · Accepted Answer · 2022-05-19 14:43:25Z

2

Maybe a better option. If you are using iOS 14+ with scrollview or have the option to use scrollview.

https://developer.apple.com/documentation/swiftui/scrollviewproxy https://developer.apple.com/documentation/swiftui/scrollviewreader

Below might help

        ScrollViewReader { (proxy: ScrollViewProxy) in
            ScrollView {
                view1().frame(height: 200)
                view2().frame(height: 200)

                view3() <-----this has textfields 
                    .onTapGesture {
                        proxy.scrollTo(1, anchor: .center)
                    }
                    .id(1)

                view4() <-----this has text editor
                    .onTapGesture {
                        proxy.scrollTo(2, anchor: .center)
                    }
                    .id(2)

                view5().frame(height: 200)
                view6().frame(height: 200)
                submtButton().frame(height: 200)
            }
        }

imp part from above is

         anyView().onTapGesture {
              proxy.scrollTo(_ID, anchor: .center)
         }.id(_ID)

Hope this helps someone :)

answered May 19, 2022 at 14:43

Abhishek

4943 silver badges9 bronze badges

1 Comment

Michał Ziobro Over a year ago

it doesn't work for me without DispatchQueue.main.asyncAfter(deadline: .now() + .seconds(1)) {

Collectives™ on Stack Overflow

SwiftUI ScrollView Keyboard Avoidance

2 Answers 2

6 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

6 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related