[iOS] Scroll with the keyboard to not block entries and editors #13499

tj-devel709 · 2023-02-22T07:11:44Z

Description of Change

This PR brings changes to allow the page to scroll when the Keyboard appears and would block Entries and Editors on iOS. Prior to this PR, it could be very difficult to enter text into an entry or editor located in a position that the keyboard would cover it. This PR was based off of IQKeyboard's logic of handling scrolls with a few modifications. This implementation takes uses cursor location instead of just differentiating between non-scrollable editors vs scrollable editors and entries. Because of this change, we can handle large entries and editors that are not fully filled with text more appropriately. This implementation also passes scrolling to the parent scrollable view so that our ListViews, CollectionViews, and TableViews are not cut off in the scrolling.

Note, on Shell when using top tabs, you can notice that scrolling cuts off some text on the top and is affected in a similar way as this issue: #8778

Screen.Recording.2023-02-22.at.5.18.48.PM.mov

Issues Fixed

Fixes #4792

github-actions · 2023-02-22T07:17:28Z

Thank you for your pull request. We are auto-formating your source code to follow our code guidelines.

drasticactions · 2023-02-22T08:18:48Z

First, thank you for mentioning that library! I had never heard of it before, and damn, it's helpful! There were existing bindings for Xamarin.iOS but none for .NET, so I rebound it. If anyone wants similar functions to this PR you should be able to drop it into an existing MAUI app, and it should work.

That said, having essential functions for handling UITextView navigation in the box would be awesome!

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

mandel-macaque · 2023-02-22T18:36:16Z

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

+								if (View.FindResponder<UIStackView>() is not null)
+									superScrollView.SetContentOffset(newContentOffset, UIView.AnimationsEnabled);
+								else
+									superScrollView.ContentOffset = newContentOffset;


This is a closure that is capturing the superScrollView which is I suppose an UIView, therefore is a memory leak.

Mea culpa, should have said increased memory pressure. We are creating an extra object with a reference to the capture elements. The gc will have extra work.

This one I was not able to move out since the superScrollView needs to be updated here and used later. I suppose I can use a ref and move it to a different method, but I think that would be the same issue

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

…board_Final

tj-devel709 · 2023-02-23T04:41:33Z

@mandel-macaque Regarding the memory leaks, won't setting the fields to null eventually clear up the issues with memory leaks?

mandel-macaque · 2023-02-23T13:28:32Z

@tj-devel709 first sorry, I should have clarify that in the AnimateScroll callbacks is not perse a memory leak but a bad memory management practice that will increase the memory pressure of the application.

There are several situations in which we are me creating inefficient memory management in this pr:

When dealing with events and clousures.
When creating closures that will create extra not needed references.

In order to understand you have to know that when a closure is used, the C# create a magic class that will contain a reference to the outside world. That means that we are creating more and more objects that those that are really needed.

Every single one of those lambdas has created an object that has incremented the reference count of all the IDisposable objects. This increases the memory pressure of the application which will at some point force the GC to kick in. Remember that the gc will pause the app to execute the collection of objects in its thread, which has a performance hit.

We also have a memory management problem, every single one of the closure is capturing a Disposable object, have we considered the ownership of the object? What happens if the creator calls Dispose? (In practical terms, I don't believe this is an issue in an UI application if the UI is not created on the fly and UI elements disposed, but could happen).

The other memory issue we have is the fact that we have the lambdas that are capturing the Notification center and the content of the class. There is no need for that, we are creating extra references that are (in this case potential memory leaks since they are events).

The fix is simple, move to using delegates instead of all the closures and that will reduce the memory pressure, will make the gc work less and we will have a snappier application.

src/Core/src/Handlers/ScrollView/ScrollViewHandler.iOS.cs

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

…ectionview scrolling

github-actions · 2023-03-08T07:44:50Z

Thank you for your pull request. We are auto-formatting your source code to follow our code guidelines.

…board_Final

…roll pages

mandel-macaque

Some final minor fixes needed.

src/Controls/src/Core/Compatibility/Handlers/Shell/iOS/ShellScrollViewTracker.cs

src/Controls/src/Core/Compatibility/Handlers/iOS/KeyboardInsetTracker.cs

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

src/Core/src/Platform/iOS/ViewExtensions.cs

src/Core/src/Platform/iOS/MauiScrollView.cs

src/Core/src/Platform/iOS/ViewExtensions.cs

src/Core/src/Hosting/LifecycleEvents/AppHostBuilderExtensions.iOS.cs

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

src/Core/src/Platform/iOS/MauiScrollView.cs

github-actions · 2023-03-16T22:56:09Z

Thank you for your pull request. We are auto-formatting your source code to follow our code guidelines.

…board_Final

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs

* Removed BuildTizenDefaultTemplate and just have it call RadioButton's default template since they were identical. (#13996) * Reinstate WebView cookie functionality for Android & iOS (#13736) * Fix iOS cookies * Fix Android Cookies * Update src/Core/src/Platform/iOS/MauiWKWebView.cs Co-authored-by: Manuel de la Pena <[email protected]> * Auto-format source code * Update MauiWKWebView.cs * Update src/Core/src/Platform/iOS/MauiWKWebView.cs --------- Co-authored-by: Manuel de la Pena <[email protected]> Co-authored-by: GitHub Actions Autoformatter <[email protected]> * Revert 10759. Fix Button sizing using HorizontalOptions. (#14005) * Ensure that Grid is treating star rows/columns as Auto when unconstrained (#13999) * Ensure that Grid is treating star rows/columns as Auto when unconstrained Fixes #13993 * Auto-format source code --------- Co-authored-by: GitHub Actions Autoformatter <[email protected]> * [iOS] Implement ScrollView Orientation (#13657) * [iOS] Remove not used mapper for ContentSize * [iOS] Implement Orientation mapping * [Samples] Add sample page for ScrollView orientation * Try without this * [iOS] Move from extension to helper * Add back removed API * Use SetNeedsLayout to call measure of ContentView * Cleanup * [Android] Fix Frame Renderer to use Wrapper View correctly (#12218) * [Android] Fix Frame to call missing mapper methods * - fix rebase * Auto-format source code * - update tests and wrapper view code * - remove code that's now generalized in ViewHandler * - cleanup frame renderer --------- Co-authored-by: GitHub Actions Autoformatter <[email protected]> * [controls] fix cases a GC causes events to not fire (#13997) As seen in #13973, some of my recent changes had a flaw: * #13550 * #13806 * #13656 Because nothing held onto the `EventHandler` in some of these cases, at some point a GC will prevent future events from firing. So for example, my original attempt to test this behavior: [Fact] public async Task RectangleGeometrySubscribed() { var geometry = new RectangleGeometry(); var visual = new VisualElement { Clip = geometry }; bool fired = false; visual.PropertyChanged += (sender, e) => { if (e.PropertyName == nameof(VisualElement.Clip)) fired = true; }; // Was missing these three lines!!! // await Task.Yield(); // GC.Collect(); // GC.WaitForPendingFinalizers(); geometry.Rect = new Rect(1, 2, 3, 4); Assert.True(fired, "PropertyChanged did not fire!"); } In each case, I added an additional test showing the problem. I played around with some ideas, but the simplest solution is to save the `EventHandler` in a member field of the subscriber. Will keep thinking of smarter ways to handle this. I also fixed several GC-related tests that were ignored, hoping they might help find issues in this area. My `await Task.Yield()` trick was enough to make them pass. * Fix tests in Release mode In `Release` mode, a `GC.KeepAlive()` call is needed for the tests to pass. Co-authored-by: GitHub Actions Autoformatter <[email protected]> * [iOS] Scroll with the keyboard to not block entries and editors (#13499) --------- Co-authored-by: dustin-wojciechowski <[email protected]> Co-authored-by: Gerald Versluis <[email protected]> Co-authored-by: Manuel de la Pena <[email protected]> Co-authored-by: GitHub Actions Autoformatter <[email protected]> Co-authored-by: Javier Suárez <[email protected]> Co-authored-by: E.Z. Hart <[email protected]> Co-authored-by: Rui Marinho <[email protected]> Co-authored-by: Shane Neuville <[email protected]> Co-authored-by: Jonathan Peppers <[email protected]> Co-authored-by: TJ Lambert <[email protected]>

pulmuone · 2023-09-11T05:46:37Z

very good

TJ Lambert added 3 commits February 21, 2023 15:28

start of the Scroll implementation

d53bf8b

Massive rehaul with functionality

764a5b1

add license comment

1a40a18

tj-devel709 added platform/iOS 🍎 area-controls-entry Entry area-controls-scrollview ScrollView area-keyboard Keyboard, soft keyboard labels Feb 22, 2023

ghost added the legacy-area-controls Label, Button, CheckBox, Slider, Stepper, Switch, Picker, Entry, Editor label Feb 22, 2023

Auto-format source code

3e9edf9

mandel-macaque requested changes Feb 22, 2023

View reviewed changes

TJ Lambert added 2 commits February 22, 2023 17:28

Fix edge case where cursor is not inside the editor when we Next into it

b97feee

Merge remote-tracking branch 'TJ/ScrollKeyboard_Final' into ScrollKey…

7a14d07

…board_Final

TJ Lambert added 2 commits February 22, 2023 23:17

address first part Manuel comments and flip the move

8466344

obsolete the keyboardInsetTracker

7e1c83d

PureWeen requested changes Feb 23, 2023

View reviewed changes

TJ Lambert added 4 commits March 6, 2023 19:31

Address Shane and some Manuel suggestions and allow listview and coll…

c1cc0ff

…ectionview scrolling

Optimize memory usage by changing closures to delegates

9e8558e

obsolete the ShellScrollViewTracker

0029721

Add tests and change RootController to ContainerView

3b37360

tj-devel709 marked this pull request as ready for review March 8, 2023 07:41

Auto-format source code

ee5937b

tj-devel709 marked this pull request as draft March 9, 2023 01:47

TJ Lambert added 2 commits March 8, 2023 21:39

fixed issue with spamming clicks really fast

058f9ea

Merge remote-tracking branch 'TJ/ScrollKeyboard_Final' into ScrollKey…

c4dc334

…board_Final

tj-devel709 marked this pull request as ready for review March 9, 2023 03:40

TJ Lambert added 2 commits March 8, 2023 22:47

Fix rare race condition between events by moving to debounced method

e52ee20

Fix animation speed and allow scrollviews to come into view on non-sc…

ac0e366

…roll pages

mandel-macaque requested changes Mar 16, 2023

View reviewed changes

PureWeen requested changes Mar 16, 2023

View reviewed changes

src/Core/src/Platform/iOS/MauiScrollView.cs Show resolved Hide resolved

src/Core/src/Platform/iOS/ViewExtensions.cs Outdated Show resolved Hide resolved

PureWeen requested changes Mar 16, 2023

View reviewed changes

src/Core/src/Hosting/LifecycleEvents/AppHostBuilderExtensions.iOS.cs Outdated Show resolved Hide resolved

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs Show resolved Hide resolved

src/Core/src/Platform/iOS/MauiScrollView.cs Show resolved Hide resolved

TJ Lambert and others added 2 commits March 16, 2023 17:52

Make Manuel and Shane suggestions p2

6390a85

Auto-format source code

0b49cf3

PureWeen requested review from mandel-macaque, PureWeen and rmarinho March 16, 2023 23:30

TJ Lambert added 3 commits March 16, 2023 18:58

set IsCurrentlyScrolling off in Disconnect

81151d5

add dimensions check

c71e638

Merge remote-tracking branch 'TJ/ScrollKeyboard_Final' into ScrollKey…

d708982

…board_Final

mandel-macaque approved these changes Mar 17, 2023

View reviewed changes

src/Core/src/Platform/iOS/KeyboardAutoManagerScroll.cs Show resolved Hide resolved

rmarinho approved these changes Mar 17, 2023

View reviewed changes

PureWeen approved these changes Mar 17, 2023

View reviewed changes

tj-devel709 merged commit 16fcd7e into dotnet:main Mar 17, 2023

PureWeen added the backport/suggested The PR author or issue review has suggested that the change should be backported. label Mar 23, 2023

jsuarezruiz mentioned this pull request Mar 29, 2023

Move to the backlog - Transparency - community needs fixes to move to maui. #14255

Closed

hartez added the backport/NO This change should not be backported. It may break customers. label Mar 30, 2023

github-actions bot locked and limited conversation to collaborators Dec 12, 2023

samhouts added area-controls-editor Editor backport/approved After some discussion or review, this PR or change was approved to be backported. and removed legacy-area-controls Label, Button, CheckBox, Slider, Stepper, Switch, Picker, Entry, Editor labels Jan 31, 2024

samhouts added the fixed-in-8.0.0-preview.3.8149 Look for this fix in 8.0.0-preview.3.8149! label Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[iOS] Scroll with the keyboard to not block entries and editors #13499

[iOS] Scroll with the keyboard to not block entries and editors #13499

tj-devel709 commented Feb 22, 2023 •

edited

Loading

github-actions bot commented Feb 22, 2023

drasticactions commented Feb 22, 2023

mandel-macaque Feb 22, 2023

mandel-macaque Feb 23, 2023

tj-devel709 Mar 7, 2023

tj-devel709 commented Feb 23, 2023

mandel-macaque commented Feb 23, 2023

github-actions bot commented Mar 8, 2023

mandel-macaque left a comment

github-actions bot commented Mar 16, 2023

pulmuone commented Sep 11, 2023

[iOS] Scroll with the keyboard to not block entries and editors #13499

[iOS] Scroll with the keyboard to not block entries and editors #13499

Conversation

tj-devel709 commented Feb 22, 2023 • edited Loading

Description of Change

Issues Fixed

github-actions bot commented Feb 22, 2023

drasticactions commented Feb 22, 2023

mandel-macaque Feb 22, 2023

Choose a reason for hiding this comment

mandel-macaque Feb 23, 2023

Choose a reason for hiding this comment

tj-devel709 Mar 7, 2023

Choose a reason for hiding this comment

tj-devel709 commented Feb 23, 2023

mandel-macaque commented Feb 23, 2023

github-actions bot commented Mar 8, 2023

mandel-macaque left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 16, 2023

pulmuone commented Sep 11, 2023

tj-devel709 commented Feb 22, 2023 •

edited

Loading