SwiftUI List Visual Bug with Keyboard and Safe Area

Question

I'm experiencing a visual bug when using a List and TextFields in SwiftUI. After focusing on a TextField in the List and then removing the focus (I've tried various methods of doing this, like Buttons in the List rows/keyboard toolbar etc.), there is a visual bug where the black view behind the keyboard dismisses, hangs for a second over the safe area, then suddenly disappears, causing the animation not to appear smooth. Also, if you scroll to the bottom of the List and perform the same steps, after the black view lingers for a second, it then suddenly disappears again but causes the List to 'snap' down a bit and again ruins the animation.

Here is a minimal demonstration of the issue:

struct ContentView: View {
    
    @State var text: String = ""
    
    @FocusState private var focused: Int?
    
    var body: some View {
        List {
            ForEach(0..<50) { item in
                HStack {
                    TextField("", text: $text)
                        .id(item)
                        .focused($focused, equals: item)
                        .background(.white)
                    
                    Button {
                        focused = nil
                    } label: {
                        Text("Hide")
                    }
                }
            }
        }
        .scrollContentBackground(.hidden)
        .background(.red)
    }
}

One solution is using the List in a VStack with something below the List, but this is something I'd like to avoid with my UI. Also, I could use a ScrollView, but there is then a separate issue, where after dismissing the keyboard, the extra padding under the List produced by the keyboard avoidance stays there until you try and scroll the List again. I would also like to use the native swipe actions in my actual project. Finally, ignoring the safe area of the List/ScrollView works but then this disables keyboard avoidance, which is something that I'd like to keep.

Note: experienced on iOS 16.0 and 16.1

Hi Matt, I ran into the same issue even on iOS 17. Have you filed a feedback with Apple, and have you found any workaround since your post? Thanks for detailing this bug! — Lukáš Kubánek
– Lukáš Kubánek, Commented Oct 3, 2023 at 14:15
Hey Lukáš! Thanks a lot for filing this with Apple - I hadn't done this (but probably should have!). It's not ideal, but my solution was to ignore the keyboard safe area, which fixes the visual bug but disables keyboard avoidance, and resort to using IQKeyboardManager. While I'd rather not have to use it, it made all my problems magically disappear and is a very easy solution, so I'd highly recommend giving it a go if it suits you. — MattGreeny
– MattGreeny, Commented Oct 3, 2023 at 18:20
It's iOS 17.3 and the issue is still here. Extremely annoying. It becomes even more noticeable when trying to add .keyboard Toolbar to show above the keyboard. SwiftUI adding additional safeArea for it, an it too glitches with empty space ruining the animation :( — Nevs12
– Nevs12, Commented Jan 28, 2024 at 22:39
this issue still persists in 17.4. Did they ever reach out to you @LukášKubánek — Eric Agredo
– Eric Agredo, Commented Apr 30, 2024 at 17:58

bjorn.lau · Accepted Answer · 2022-10-31 10:08:31Z

1

I am not 100% sure why this is happening, since I have not worked a lot with lists. But I guess it has something to do with that you are not explicitly telling your view to ignore the safe area. Adding .edgesIgnoringSafeArea(.bottom) to your list when leaving focus, and then changing it to trailing on entering focus seems to solve it.

struct ContentView: View {

    @State var text: String = ""
    @State var ignoreSafeArea = false

    @FocusState private var focused: Int?

    var body: some View {
        List {
            ForEach(0..<50) { item in
                HStack {
                    TextField("", text: $text)
                        .id(item)
                        .focused($focused, equals: item)
                        .background(.white)

                    Button {
                        focused = nil
                    } label: {
                        Text("Hide")
                    }
                }
            }
            .onChange(of: focused) { focused in
                if focused == nil {
                    ignoreSafeArea = true
                } else {
                    ignoreSafeArea = false
                }
            }
        }.edgesIgnoringSafeArea(ignoreSafeArea ? .bottom : .trailing)
    }
}

edited Oct 31, 2022 at 10:08

answered Oct 29, 2022 at 23:29

bjorn.lau

1,21811 silver badges24 bronze badges

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

3 Comments

MattGreeny Over a year ago

This does work, but the only problem is that this then disables the keyboard avoidance of the TextFields, unless you know a way I can prevent this and still ignore the safe area? I can, of course, implement my own keyboard avoidance, but I'm experiencing other issues (e.g. here) and would rather use the native solution

bjorn.lau Over a year ago

Well, that's true. I did not consider that could be a problem. I updated my answer with another solution that should maintain the keyboard avoidance and keep the animation smooth.

MattGreeny Over a year ago

Thanks a lot for updating your solution - this is definitely a step in the right direction. The only problem that seems to remain is with the black view behind the keyboard. With your solution, it still seems to 'lag behind' when dismissing (although no longer sticks around over the bottom safe area) and suddenly appears when focusing on a TextField before the keyboard has chance to appear, which doesn't look great. I've updated my question to add a red background to the List which makes the issue clear. Do you know how I can get around this?

Collectives™ on Stack Overflow

SwiftUI List Visual Bug with Keyboard and Safe Area

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related