Skip to content

Commit e6ddaec

Browse files
Xiaoy312Xiaoy312
committed
fix(droid): add workaround for NavView leaving blank on IsBackButtonVisible update
1 parent 2a674e0 commit e6ddaec

File tree

3 files changed

+149
-19
lines changed

3 files changed

+149
-19
lines changed

‎src/Uno.UI.RuntimeTests/Tests/Microsoft_UI_Xaml_Controls/Given_NavigationView.cs

Lines changed: 123 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
using System.Threading.Tasks;
2-
#if WINAPPSDK
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Threading.Tasks;
5+
using Microsoft.UI.Xaml;
6+
using Microsoft.UI.Xaml.Controls;
7+
using Microsoft.UI.Xaml.Media;
8+
using Windows.UI;
9+
using Uno.Extensions;
10+
using Uno.Extensions.Specialized;
311
using Uno.UI.Extensions;
4-
#elif __IOS__
12+
using Uno.UI.RuntimeTests.Helpers;
13+
14+
using static Private.Infrastructure.TestServices;
15+
using MUXC = Microsoft/* UWP don't rename */.UI.Xaml.Controls;
16+
17+
#if __IOS__
518
using UIKit;
619
#elif __MACOS__
720
using AppKit;
8-
#else
921
#endif
10-
using Microsoft.UI.Xaml;
11-
using Microsoft.UI.Xaml.Controls;
12-
using static Private.Infrastructure.TestServices;
13-
using Windows.UI;
14-
using Microsoft.UI.Xaml.Media;
15-
using Uno.UI.RuntimeTests.Helpers;
1622

1723
namespace Uno.UI.RuntimeTests.Tests.Microsoft_UI_Xaml_Controls
1824
{
@@ -27,16 +33,16 @@ public partial class Given_NavigationView
2733
#endif
2834
public async Task When_SelectedItem_Set_Before_Load_And_Theme_Changed()
2935
{
30-
var navView = new Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationView()
36+
var navView = new MUXC.NavigationView()
3137
{
3238
MenuItems =
3339
{
34-
new Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationViewItem {Content = "Item 1"},
35-
new Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationViewItem {Content = "Item 2"},
36-
new Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationViewItem {Content = "Item 3"},
40+
new MUXC.NavigationViewItem {Content = "Item 1"},
41+
new MUXC.NavigationViewItem {Content = "Item 2"},
42+
new MUXC.NavigationViewItem {Content = "Item 3"},
3743
},
38-
PaneDisplayMode = Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationViewPaneDisplayMode.LeftMinimal,
39-
IsBackButtonVisible = Microsoft/* UWP don't rename */.UI.Xaml.Controls.NavigationViewBackButtonVisible.Collapsed,
44+
PaneDisplayMode = MUXC.NavigationViewPaneDisplayMode.LeftMinimal,
45+
IsBackButtonVisible = MUXC.NavigationViewBackButtonVisible.Collapsed,
4046
};
4147
navView.SelectedItem = navView.MenuItems[1];
4248
var hostGrid = new Grid() { MinWidth = 20, MinHeight = 20 };
@@ -53,9 +59,9 @@ public async Task When_SelectedItem_Set_Before_Load_And_Theme_Changed()
5359

5460
await WindowHelper.WaitForIdle();
5561

56-
var togglePaneButton = navView.FindFirstChild<Button>(b => b.Name == "TogglePaneButton");
57-
var icon = togglePaneButton?.FindFirstChild<FrameworkElement>(f => f.Name == "Icon");
58-
var iconTextBlock = icon?.FindFirstChild<TextBlock>(includeCurrent: true);
62+
var togglePaneButton = navView.FindFirstDescendant<Button>(b => b.Name == "TogglePaneButton");
63+
var icon = togglePaneButton?.FindFirstDescendant<FrameworkElement>(f => f.Name == "Icon");
64+
var iconTextBlock = icon as TextBlock ?? icon?.FindFirstDescendant<TextBlock>();
5965

6066
Assert.IsNotNull(iconTextBlock);
6167

@@ -73,5 +79,103 @@ public async Task When_SelectedItem_Set_Before_Load_And_Theme_Changed()
7379
#endif
7480
}
7581
}
82+
83+
[TestMethod]
84+
public async Task When_IsBackButtonVisible_Toggled()
85+
{
86+
// unoplatform/uno#19516
87+
// droid-specific: There is a bug where setting IsBackButtonVisible would "lock" the size of all NVIs
88+
// preventing resizing on items expansion/collapse.
89+
90+
var sut = new MUXC.NavigationView()
91+
{
92+
Height = 500,
93+
IsBackButtonVisible = MUXC.NavigationViewBackButtonVisible.Collapsed,
94+
IsPaneToggleButtonVisible = false,
95+
PaneDisplayMode = MUXC.NavigationViewPaneDisplayMode.Left,
96+
CompactModeThresholdWidth = 10,
97+
ExpandedModeThresholdWidth = 50,
98+
};
99+
sut.ItemInvoked += (s, e) =>
100+
{
101+
// manual trigger for deepest/inner-most items
102+
if (e.InvokedItemContainer is MUXC.NavigationViewItem nvi &&
103+
nvi.MenuItems.Count == 0)
104+
{
105+
sut.IsBackButtonVisible = MUXC.NavigationViewBackButtonVisible.Visible;
106+
}
107+
};
108+
109+
var nvis = new Dictionary<string, MUXC.NavigationViewItem>();
110+
//AddItems(sut.MenuItems, "", count: 4, depth: 1, maxDepth: 2);
111+
AddItems(sut.MenuItems, "", count: 3, depth: 1, maxDepth: 3);
112+
void AddItems(IList<object> target, string prefix, int count, int depth, int maxDepth)
113+
{
114+
for (int i = 0; i < count; i++)
115+
{
116+
var header = prefix + (char)('A' + i);
117+
var item = new MUXC.NavigationViewItem() { Content = header };
118+
119+
if (depth < maxDepth) AddItems(item.MenuItems, header, count, depth + 1, maxDepth);
120+
121+
target.Add(item);
122+
nvis.Add(header, item);
123+
}
124+
}
125+
126+
// for debugging
127+
var panel = new StackPanel();
128+
void AddTestButton(string label, Action action)
129+
{
130+
var button = new Button() { Content = label };
131+
button.Click += (s, e) => action();
132+
panel.Children.Add(button);
133+
}
134+
AddTestButton("InvalidateMeasure", () =>
135+
{
136+
foreach (var ir in sut.EnumerateDescendants().OfType<MUXC.ItemsRepeater>())
137+
{
138+
ir.InvalidateMeasure();
139+
}
140+
});
141+
AddTestButton("IsBackButtonVisible toggle", () =>
142+
sut.IsBackButtonVisible = sut.IsBackButtonVisible == MUXC.NavigationViewBackButtonVisible.Collapsed
143+
? MUXC.NavigationViewBackButtonVisible.Visible
144+
: MUXC.NavigationViewBackButtonVisible.Collapsed);
145+
panel.Children.Add(sut);
146+
147+
await UITestHelper.Load(panel, x => x.IsLoaded);
148+
149+
var initialHeight = nvis["B"].ActualHeight;
150+
151+
nvis["B"].IsExpanded = true;
152+
await UITestHelper.WaitForIdle();
153+
var partiallyExpandedHeight = nvis["B"].ActualHeight;
154+
155+
nvis["BB"].IsExpanded = true;
156+
await UITestHelper.WaitForIdle();
157+
var fullyExpandedHeight = nvis["B"].ActualHeight;
158+
159+
// trigger the bug
160+
await Task.Delay(2000); // necessary
161+
sut.IsBackButtonVisible = MUXC.NavigationViewBackButtonVisible.Visible;
162+
await UITestHelper.WaitForIdle();
163+
164+
nvis["BB"].IsExpanded = false;
165+
await UITestHelper.WaitForIdle();
166+
var partiallyCollapsedHeight = nvis["B"].ActualHeight;
167+
168+
nvis["B"].IsExpanded = false;
169+
await UITestHelper.WaitForIdle();
170+
var fullyCollapsedHeight = nvis["B"].ActualHeight;
171+
172+
// sanity check
173+
Assert.IsTrue(initialHeight < partiallyExpandedHeight, $"Expanding 'B' should increase item 'B' height: {initialHeight} -> {partiallyExpandedHeight}");
174+
Assert.IsTrue(partiallyExpandedHeight < fullyExpandedHeight, $"Expanding 'BB' should increase item 'B' height: {partiallyExpandedHeight} -> {fullyExpandedHeight}");
175+
176+
// verifying fix
177+
Assert.IsTrue(fullyExpandedHeight > partiallyCollapsedHeight, $"Collapsing 'BB' should reduce item 'B' height: {fullyExpandedHeight} -> {partiallyCollapsedHeight}");
178+
Assert.IsTrue(partiallyCollapsedHeight > fullyCollapsedHeight, $"Collapsing 'B' should reduce item 'B' height: {partiallyCollapsedHeight} -> {fullyCollapsedHeight}");
179+
}
76180
}
77181
}

‎src/Uno.UI/FeatureConfiguration.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -929,5 +929,15 @@ public static bool IsEdgeToEdgeEnabled
929929
}
930930
}
931931
#endif
932+
933+
public static class NavigationView
934+
{
935+
#if __ANDROID__
936+
/// <summary>
937+
/// Workaround for unoplatform/uno#19516 where toggling IsBackButtonVisible would stop NVIs from updating their layout/size when expanded/collapsed.
938+
/// </summary>
939+
public static bool EnableUno19516Workaround { get; set; } = true;
940+
#endif
941+
}
932942
}
933943
}

‎src/Uno.UI/Microsoft/UI/Xaml/Controls/NavigationView/NavigationView.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@
99
using System.Collections.ObjectModel;
1010
using System.Collections.Specialized;
1111
using System.Globalization;
12+
using System.Linq;
1213
using System.Numerics;
1314
using Microsoft/* UWP don't rename */.UI.Xaml.Automation.Peers;
1415
using Microsoft/* UWP don't rename */.UI.Xaml.Controls.AnimatedVisuals;
1516
using Uno.Disposables;
1617
using Uno.Foundation.Logging;
18+
using Uno.UI;
1719
using Uno.UI.DataBinding;
20+
using Uno.UI.Extensions;
1821
using Uno.UI.Helpers.WinUI;
1922
using Windows.ApplicationModel.Core;
2023
using Windows.Foundation;
@@ -4353,6 +4356,19 @@ private void OnPropertyChanged(DependencyPropertyChangedEventArgs args)
43534356
{
43544357
backButton.UpdateLayout();
43554358
}
4359+
4360+
#if __ANDROID__
4361+
// workaround for unoplatform/uno#19516 where toggling IsBackButtonVisible would stop NVIs from updating their layout/size when expanded/collapsed.
4362+
if (FeatureConfiguration.NavigationView.EnableUno19516Workaround &&
4363+
m_appliedTemplate && IsLoaded)
4364+
{
4365+
foreach (var ir in this.EnumerateDescendants().OfType<ItemsRepeater>())
4366+
{
4367+
ir.InvalidateMeasure();
4368+
}
4369+
}
4370+
#endif
4371+
43564372
UpdatePaneLayout();
43574373
}
43584374

0 commit comments

Comments
 (0)