Adds UWP support to Shell

[dotMorten]

This is a replacement PR of #5936 (I messed up the rebase). There's some good discussions in that PR though.

Description of Change

This is the first stab at adding UWP renderers for Shell

Issues Resolved

#2415

• fixes Uwp Xamarin.Forms.Shell  #5593

API Changes

public class ShellRenderer : NavigationView, IVisualElementRenderer, IAppearanceObserver, IFlyoutBehaviorObserver
{
   public ShellRenderer();
   protected internal Shell Element { get; private set; }
   protected virtual void OnElementPropertyChanged(object sender, PropertyChangedEventArgs e);
   protected virtual void OnElementSet(Shell shell);   
}
[EditorBrowsable(EditorBrowsableState.Never)]
public sealed class ShellSectionRenderer : NavigationView, IAppearanceObserver
{
}
public class ToolbarItemRenderer : Windows.UI.Xaml.Controls.Button
{
	public ToolbarItemRenderer();
	public ToolbarItem ToolbarItem { get; set; }
	public static readonly DependencyProperty ToolbarItemProperty;
}
public static class PageExtensions
{
   // Added overload that allows specifying the page transition animation
   public static bool Navigate(this Windows.UI.Xaml.Controls.Frame frame, ContentPage page, Windows.UI.Xaml.Media.Animation.NavigationTransitionInfo infoOverride);
}

Known issues while it's a draft-PR:

• 1. Navigation isn't working fully working.
• 2. Only FileImageSource are supported for icons (limitation of NavigationViewItem and AppBarItem - considering to use a different kind) Also see issue Proposal: Create IconSource from Bitmap stream microsoft/microsoft-ui-xaml#601
• 3. Release builds fail to render the side pane (this one got me stumped, as no errors are reported - it's just completely missing anything but the contents from the visual tree)
• 4. Toolbar not implemented

It might be worth considering adding the WinUI dependency. This would mean 16299 can be continued to be used, but it does require one extra setup step to add a theme resource to App.xaml, as well as adding the dependency. In the future though, this library is where all new UWP components will be added, so sooner or later that's going to happen anyway.

Platforms Affected

• UWP

Behavioral/Visual Changes

None

Before/After Screenshots

Before:

After (Gastropods, Default Shell Template, Xappy):

Note:

• Gallery app is dependent on this PR: Adds the image resouces iOS and Android gallery apps already had to UWP #6000
• Back navigation is also dependent on [UWP] Avoid LINQ exception when the back button is pressed  #5933 (merged into 4.0.0 branch but not yet in Master)

Testing Procedure

Use @davidortinau's Gastropods sample. It seems fully functional from what I can tell.
You can also use this repo: https://github.com/dotMorten/Xamarin.Forms.UWPShell.Sample
(the sub-module points to this PR) which includes 3 different Shell samples, as well as the gallery sample.

PR Checklist

• Has automated tests
• Rebased on top of the target branch at time of PR
• Changes adhere to coding standard

[dotMorten]

Not everything in the gallery sample app works. List below screenshot of progress so far.
To run, clone the repo https://github.com/dotMorten/Xamarin.Forms.UWPShell.Sample including the submodule and run the ShellSample.UWP project. Click Controls Gallery then SwapRoot - Store Shell.

If you want to help out, I'd like help with the below unchecked items.

Checked = it is working, message after with issue if it's not

• Push Navigates, but navigation is different from Android

• Pop

• Pop to root

• Insert

• Remove

• Add Search

• Add Toolbar

• Remove Toolbar

• Remove Search

• Add Tab

• Remove Tab

• Hide Tabs

• Show Tabs

• Hide Nav (thanks to @NicoVermeir)

• Show Nav (thanks to @NicoVermeir)

• Hide Search

• Collapse Search [Shell, UWP] SearchBoxVisibility.Collaped  #9807

• Show Search

• Set Back [UWP, Shell] Implement BackButtonBehavior #9809

• Clear Back [UWP, Shell] Implement BackButtonBehavior #9809

• Disable Tab [UWP, Shell] Enabling and Disabling ShellElements has no effect #9810

• Enable Tab [UWP, Shell] Enabling and Disabling ShellElements has no effect #9810

• Enable Search

• Disable Search

• Set Title

• Set Tab Title [UWP, Shell] Shell Element Titles have no effect #9811

• Set Group Title [UWP, Shell] Shell Element Titles have no effect #9811

• New Tab Icon [Shell, UWP] Implement Shell Elements Icon property  #9812

• Flyout Disabled [Shell, UWP] Shell Flyout Behavior Implementations #9806

• Flyout Collapse [Shell, UWP] Shell Flyout Behavior Implementations #9806

• Flyout Locked [Shell, UWP] Shell Flyout Behavior Implementations #9806

• Add TitleView [UWP, Shell] Implement TitleView #9808

• Null TitleView [UWP, Shell] Implement TitleView #9808

• FH Fixed [Shell, UWP] Flyout Header permutations #9803

• FH Scroll [Shell, UWP] Flyout Header permutations #9803

• FH Collapse [Shell, UWP] Flyout Header permutations #9803

• Add TopTab

• Remove TopTab

• Nav Visible Checkbox [Shell, UWP] Shell.SetNavBarIsVisible #9813

• Tab Visible Checkbox [Shell, UWP] Shell.SetNavBarIsVisible #9814

• Push Special

• Show Alert

• Navigate to 'demo' route

• Go Back with Text

• Navigate to [textbox] GO!

[mzhukovs]

Really glad to see that someone is making the effort to support to UWP, and I am sure many others are as well. Just wondering if there is any sense of when this would make it into a preview/release?

[dotMorten]

We're hoping to do a live-streamed code-review next week

[dgerding]

Any updates? Really at a WAIT AND SEE attitude with Xamarin Forms until there is equal ground development footing for Windows platforms (UWP) alongside XF iOS and XF Android.

[sharpwood]

When can this project update this feature to the visual studio template?

[dotMorten]

@dgerding sorry we're a little delayed. I'm overwhelmed and hard to find common time do the PR Review.
@sharpwood first it'll have to be merged, then probably a few more fixes here and there (this PR gets us ~80% there). I'm assuming you won't see it in the template until after this ships in a real release, but you can easily add it yourself afterwards.

[Spookenator]

Hey guys! Wondering what the status of this is.
Really excited about using the shell in UWP.

[SebastianKruseWago]

Is there any ETA for Shell in UWP?

[dotMorten]

I'm sorry this haven't moved faster. I hit some regressions when syncing up with master, and I've been completely swamped with work and family-related stuff, so just haven't had much time to really sit down and try and address it. However I'm more than happy to take PRs for my branch.

[dotMorten]

Ugh! My dirty laundry!

[rmarinho]

A couple of small changes, it works fine locally.

[dotMorten]

[dgerding]

Hi All,
Just wondering if I should try and add a "uwp + shell" project by following the uwp wireup demoed in
https://github.com/dotMorten/Xamarin.Forms.UWPShell.Sample

Thanks again for all the hard work.

[PureWeen]

@dgerding just follow the steps here https://docs.microsoft.com/en-us/xamarin/xamarin-forms/platform/windows/installation/ to add a UWP project

We'll have the UWP project as part of the VS templates at some point in the nearish future

[dgerding]

Thanks @PureWeen

[dgerding]

I have a new VS2019 16.3 Xamarin Forms solution using the standard project template and have added a UWP project. Thanks to help from @PureWeen I've got it running. I know UWP support is going to take time and wasn't sure where the right place to report a likely bug.

Short version: The "Add" button in the upper right corner of the Items page in the stock project isn't showing up in UWP... but it does for the Android project. (Can't test iOS yet without a new build machine. )

I'll poke at it a bit more. Any guidance on reporting this in right place appreciated.

[PureWeen]

@dgerding If you could log a new issue here https://github.com/xamarin/Xamarin.Forms/issues/new/choose with a sample that would awesome!!

We merged the larger body of work so that we can start breaking out the work to be done into smaller issues that we and the community can collectively address.

Just log everything you find that you think is incorrect.

[dgerding]

Posted a bug report here, #7735, but for those interested, there is a zipped solution attached to that report that anyone can use as a temporary quick start for Xamarin Forms + Shell +UWP.

[edamreed]

Hi, thanks for the good work on this, been waiting for Shell on UWP for a while.

I just switched my xamarin forms app to enable shell on the UWP.
My menu is working on iOS and Android but on UWP renders as below

I'm using this syntax:-

<FlyoutItem Title="Dashboard">
        <FlyoutItem.Icon>
            <FontImageSource Color="Black" Glyph="{x:Static fa:FAIcons.chart}" FontFamily="{StaticResource FontAwesomeSolid}" Size="30"/>
        </FlyoutItem.Icon>
        <Tab>
            <ShellContent Title="Charts" ContentTemplate="{DataTemplate views:ChartsPage}"/>
        </Tab>
</FlyoutItem>

Am I using something thats not supported?
All NuGet packages are updated to latest stable.

Thanks

[PureWeen]

@edamreed it's still experimental on the UWP side (hence the flag)

We've merged this larger PR in so that we can start addressing the smaller issues more aggressively with more PRs :-)

So if you could log your issue then we can put it out there for someone (or us) to resolve and get merged in

[edamreed]

Thanks PureWeen, are the details I entered above enough to log a issue with?

[PureWeen]

@edamreed

#8207

[edamreed]

Thanks

[HTUlv412]

Any advance?