Skip to content

Set menuItem show action back to Never #14623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PureWeen merged 3 commits into from
Apr 26, 2023
Merged

Set menuItem show action back to Never #14623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3cd8e1
Set menuItem show action back to Never
PureWeen Apr 17, 2023
48cf812
Auto-format source code
Apr 17, 2023
4337b83
- fix iOS handler registration
PureWeen Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Controls/src/Core/Platform/Android/Extensions/ToolbarExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,8 @@ static void UpdateMenuItem(AToolbar toolbar,

if (item.Order != ToolbarItemOrder.Secondary)
menuitem.SetShowAsAction(ShowAsAction.Always);
else
Copy link
Member Author

@PureWeen PureWeen Apr 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only functional change. Never is the default so we are just reverting this back to the default if the user hasn't indicated Primary

image

menuitem.SetShowAsAction(ShowAsAction.Never);

menuitem.SetOnMenuItemClickListener(new GenericMenuClickListener(((IMenuItemController)item).Activate));

Expand Down
17 changes: 17 additions & 0 deletions src/Controls/tests/DeviceTests/ControlsHandlerTestBase.Android.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using Android.OS;
using AndroidX.AppCompat.App;
using AndroidX.AppCompat.Graphics.Drawable;
using AndroidX.AppCompat.View.Menu;
using AndroidX.AppCompat.Widget;
using AndroidX.CoordinatorLayout.Widget;
using AndroidX.Fragment.App;
Expand Down Expand Up @@ -88,6 +89,22 @@ public bool ToolbarItemsMatch(
ToolbarItem toolbarItem = toolbarItems[i];
var primaryCommand = menu.GetItem(i);
Assert.Equal(toolbarItem.Text, $"{primaryCommand.TitleFormatted}");

if (primaryCommand is MenuItemImpl menuItemImpl)
{
if (toolbarItem.Order != ToolbarItemOrder.Secondary)
{
Assert.True(menuItemImpl.RequiresActionButton(), "Secondary Menu Item `SetShowAsAction` not set correctly");
}
else
{
Assert.False(menuItemImpl.RequiresActionButton(), "Primary Menu Item `SetShowAsAction` not set correctly");
}
}
else
{
throw new Exception($"MenuItem type is not MenuItemImpl. Please rework test to work with {primaryCommand}");
}
}

return true;
Expand Down
30 changes: 24 additions & 6 deletions src/Controls/tests/DeviceTests/ControlsHandlerTestBase.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Maui;
Expand All @@ -10,6 +12,7 @@
using Microsoft.UI.Xaml;
using Microsoft.UI.Xaml.Automation.Peers;
using Microsoft.UI.Xaml.Controls;
using Windows.Foundation.Collections;
using Xunit;
using NativeAutomationProperties = Microsoft.UI.Xaml.Automation.AutomationProperties;
using WAppBarButton = Microsoft.UI.Xaml.Controls.AppBarButton;
Expand Down Expand Up @@ -135,16 +138,31 @@ public bool ToolbarItemsMatch(
IElementHandler handler,
params ToolbarItem[] toolbarItems)
{
var primaryToolbarItems = toolbarItems.Where(x => x.Order != ToolbarItemOrder.Secondary).ToArray();
var secondaryToolbarItems = toolbarItems.Where(x => x.Order == ToolbarItemOrder.Secondary).ToArray();

var navView = (RootNavigationView)GetMauiNavigationView(handler.MauiContext);
MauiToolbar windowHeader = (MauiToolbar)navView.Header;
Assert.NotNull(windowHeader?.CommandBar?.PrimaryCommands);

Assert.Equal(toolbarItems.Length, windowHeader.CommandBar.PrimaryCommands.Count);
for (var i = 0; i < toolbarItems.Length; i++)
ValidateCommandBarCommands(windowHeader?.CommandBar?.PrimaryCommands, primaryToolbarItems);
ValidateCommandBarCommands(windowHeader?.CommandBar?.SecondaryCommands, secondaryToolbarItems);

void ValidateCommandBarCommands(IObservableVector<ICommandBarElement> commands, ToolbarItem[] orderToolbarItems)
{
ToolbarItem toolbarItem = toolbarItems[i];
var primaryCommand = ((WAppBarButton)windowHeader.CommandBar.PrimaryCommands[i]);
Assert.Equal(toolbarItem, primaryCommand.DataContext);
if (orderToolbarItems.Length == 0)
{
Assert.True(commands is null || commands.Count == 0);
return;
}

Assert.NotNull(commands);
Assert.Equal(orderToolbarItems.Length, commands.Count);
for (var i = 0; i < toolbarItems.Length; i++)
{
ToolbarItem toolbarItem = orderToolbarItems[i];
var command = ((WAppBarButton)commands[i]);
Assert.Equal(toolbarItem, command.DataContext);
}
}

return true;
Expand Down
39 changes: 0 additions & 39 deletions src/Controls/tests/DeviceTests/Elements/NavigationPage/NavigationPageTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,45 +157,6 @@ await CreateHandlerAndAddToWindow<WindowHandlerStub>(window, async (handler) =>
});
}

#if !IOS && !MACCATALYST
[Fact(DisplayName = "Toolbar Items Map Correctly")]
public async Task ToolbarItemsMapCorrectly()
{
SetupBuilder();
var toolbarItem = new ToolbarItem() { Text = "Toolbar Item 1" };
var navPage = new NavigationPage(new ContentPage()
{
ToolbarItems =
{
toolbarItem
}
});

await CreateHandlerAndAddToWindow<WindowHandlerStub>(new Window(navPage), (handler) =>
{
ToolbarItemsMatch(handler, toolbarItem);
return Task.CompletedTask;
});
}
#endif

[Fact(DisplayName = "Toolbar Title")]
public async Task ToolbarTitle()
{
SetupBuilder();
var navPage = new NavigationPage(new ContentPage()
{
Title = "Page Title"
});

await CreateHandlerAndAddToWindow<WindowHandlerStub>(new Window(navPage), (handler) =>
{
string title = GetToolbarTitle(handler);
Assert.Equal("Page Title", title);
return Task.CompletedTask;
});
}

[Fact(DisplayName = "Insert Page Before Root Page and then PopToRoot")]
public async Task InsertPageBeforeRootPageAndThenPopToRoot()
{
Expand Down
79 changes: 79 additions & 0 deletions src/Controls/tests/DeviceTests/Elements/Toolbar/ToolbarTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

#if IOS || MACCATALYST
using FlyoutViewHandler = Microsoft.Maui.Controls.Handlers.Compatibility.PhoneFlyoutPageRenderer;
using NavigationViewHandler = Microsoft.Maui.Controls.Handlers.Compatibility.NavigationRenderer;
#endif

namespace Microsoft.Maui.DeviceTests
Expand All @@ -42,6 +43,79 @@ void SetupBuilder()
});
}


#if !IOS && !MACCATALYST
[Fact(DisplayName = "Toolbar Items Map Correctly")]
public async Task ToolbarItemsMapCorrectly()
{
SetupBuilder();
var toolbarItem = new ToolbarItem() { Text = "Toolbar Item 1" };
var navPage = new NavigationPage(new ContentPage()
{
ToolbarItems =
{
toolbarItem
}
});

await CreateHandlerAndAddToWindow<WindowHandlerStub>(new Window(navPage), (handler) =>
{
ToolbarItemsMatch(handler, toolbarItem);
return Task.CompletedTask;
});
}

[Fact(DisplayName = "Toolbar Items Order Updates Correctly After Navigation")]
public async Task ToolbarItemsOrderUpdatesCorrectlyAfterNavigation()
{
SetupBuilder();
var toolbarItemFirstPage = new ToolbarItem() { Text = "Toolbar Item 1" };
var toolbarItemSecondPage = new ToolbarItem() { Text = "Toolbar Item Second Page", Order = ToolbarItemOrder.Secondary };

var navPage = new NavigationPage(new ContentPage()
{
ToolbarItems =
{
toolbarItemFirstPage
}
});

await CreateHandlerAndAddToWindow<WindowHandlerStub>(new Window(navPage), async (handler) =>
{
await navPage.PushAsync(new ContentPage()
{
ToolbarItems =
{
toolbarItemSecondPage
}
});

ToolbarItemsMatch(handler, GetExpectedToolbarItems(navPage));
ToolbarItemsMatch(handler, toolbarItemSecondPage);
await navPage.PopAsync();
ToolbarItemsMatch(handler, GetExpectedToolbarItems(navPage));
ToolbarItemsMatch(handler, toolbarItemFirstPage);
});
}
#endif

[Fact(DisplayName = "Toolbar Title")]
public async Task ToolbarTitle()
{
SetupBuilder();
var navPage = new NavigationPage(new ContentPage()
{
Title = "Page Title"
});

await CreateHandlerAndAddToWindow<WindowHandlerStub>(new Window(navPage), (handler) =>
{
string title = GetToolbarTitle(handler);
Assert.Equal("Page Title", title);
return Task.CompletedTask;
});
}

#if !IOS && !MACCATALYST
[Theory(DisplayName = "Toolbar Recreates With New MauiContext")]
[InlineData(typeof(FlyoutPage))]
Expand Down Expand Up @@ -104,5 +178,10 @@ await CreateHandlerAndAddToWindow<IWindowHandler>(window, (handler) =>
}, context2);
}
#endif

ToolbarItem[] GetExpectedToolbarItems(NavigationPage navPage)
{
return ((Toolbar)(navPage.Window as IToolbarElement).Toolbar).ToolbarItems.ToArray();
}
}
}