Avalonia v11.0.0-preview4 #31

DamianSuess · 2022-11-27T20:07:57Z

Add support for Avalonia v11.0.0-preview4

Action Items

Add error catching and reporting for region registration
Test with x:CompiledBindings="True"
- This has been addressed by Implement binding to methods for compiled bindings AvaloniaUI/Avalonia#7246
Test with HotReload NuGet, Live.Avalonia
Validate and update the Notification Service sample
- Currently, Notifications are appearing in the top-left after the upgrade regardless of the position setting
Update ViewDiscovery sample which is not correctly rendering after the upgrade

References

…onia.Themes.Fluent to SampleApp.props, its now a separate package.

OmidID · 2022-11-28T18:48:51Z

@DamianSuess Great job. Is it ready to merge?

DamianSuess · 2022-11-28T19:23:38Z

Not yet, thanks for asking. Figured I'd make a PR marked as draft so you & others can see the live progress and provide feedback on any improvements.

DamianSuess · 2022-11-28T22:13:24Z

I encountered an interesting error in the SampleMvvmApp project after upgrading to Avalonia v11.0.0-pre4.

The DashboardView's ListBox.DataTemplate causes an exception to be thrown in Prism.Avalonia's RegionViewRegistry.OnContentRegistered(..) because the DataTemplate does not define a DataType of the object in the template. Odd, we never had to do this before.

Error Message:

An exception has occurred while trying to add a view to region 'ContentRegion'.
- The most likely causing exception was was: 'Prism.Ioc.ContainerResolutionException: An unexpected error occurred while resolving 'SampleMvvmApp.Views.DashboardView'
---> System.InvalidOperationException: DataTemplate inside of DataTemplates must have a DataType set. Set DataType property or use ItemTemplate with single template instead.

Considerations:

We could modify the OnContentRegistered(..) and RegisterViewWithRegion(..) methods inside of RegionViewRegistry to return a Success (bool) and Exception similar to Prism.Form's NavigationResult. However, having RegisterViewWithRegion return a value breaks compatibility with Prism.WPF, Prism.Forms, Prism.Uno, etc.

Another option, when users set x:CompileBindings="True" they will be informed of these hidden XAML errors at compile time, and their apps won't crash. Though this option works, it would be good for Prism.Avalonia to report

Any thoughts or other options?

App.xaml.cs

        protected override void OnInitialized()
        {
            var regionManager = Container.Resolve<IRegionManager>();

            // Error in missing `DataType` gets picked up inside here
            regionManager.RegisterViewWithRegion(RegionNames.ContentRegion, typeof(DashboardView));
            regionManager.RegisterViewWithRegion(RegionNames.SidebarRegion, typeof(SidebarView));
        }

DashboardView.xaml
Before - Error caused by missing DataType in DataTemplate.

      <ListBox Margin="2"
               VerticalAlignment="Bottom"
               Items="{Binding ListItems}"
               ScrollViewer.HorizontalScrollBarVisibility="Visible"
               ScrollViewer.VerticalScrollBarVisibility="Visible"
               SelectedIndex="{Binding ListItemSelected}"
               SelectionMode="Single">
        <ListBox.DataTemplates>
          <DataTemplate>
            <TextBlock Text="{Binding .}"
                       FontSize="10"
                       TextWrapping="NoWrap" />
          </DataTemplate>
        </ListBox.DataTemplates>

After - Successful:

<UserControl xmlns="https://github.com/avaloniaui"
             ...
             xmlns:system="clr-namespace:System;assembly=mscorlib">
        ...
        <ListBox.DataTemplates>
          <DataTemplate DataType="{x:Type system:String}">
            <TextBlock Text="{Binding .}"
                       FontSize="10"
                       TextWrapping="NoWrap" />
          </DataTemplate>
        </ListBox.DataTemplates>

…t rules on DataTemplate DataType bindings

…dated NuGet description, replacing "Prism.WPF" typo with "Prism.Avalonia"

…Type. Skipping unimplemented `Selector` test

rabbitism · 2022-12-06T09:58:08Z

The DashboardView's ListBox.DataTemplate causes an exception to be thrown in Prism.Avalonia's RegionViewRegistry.OnContentRegistered(..) because the DataTemplate does not define a DataType of the object in the template. Odd, we never had to do this before.

I believe the change is from this PR
AvaloniaUI/Avalonia#8221

DamianSuess · 2022-12-06T14:16:00Z

@rabbitism, great find! I was digging through PRs & change docs trying to find this. Dong, you win the internet for the week 🚀

Though I like the strongly typed nature of defining the DataType in a DataTemplate, this new feature may become a surprise to some developers upgrading.

Also including AvaloniaUI/Avalonia#8203 as a reference

According to the PR's suggested error handling, it currently doesn't throw the exception during compile time. Only until x:CompileBindings="true" is set, other wise we get it at runtime.

…n XAML

maxkatz6 · 2022-12-28T18:06:24Z

samples/ModulesSample/App.xaml.cs

@@ -33,7 +33,7 @@ public static AppBuilder BuildAvaloniaApp()
                })
                .With(new Win32PlatformOptions
                {
-                    EnableMultitouch = true,
+                    //// EnableMultitouch = true,  // Not supported in Avalonia v11.0.0-preview4


It is always enabled now

Thank you @maxkatz6 for the heads up. I updated the code comment to reflect your note

…iaCommunity/Prism.Avalonia into feature/Avalonia-0.11pre4

…eview4

DamianSuess · 2023-01-24T01:09:02Z

I fixe the ViewDiscovery sample to render, however, it is no longer auto-switching the views as it did w/ Avalonia v0.10.x. It appears that during the MainWindow's creation, it is not registering the Prism Region "ContentRegion" in time.

To fix some of ViewDiscovery's AXML errors, I switched to Lite Theme, enabled compiled bindings, and moved View registration to the App.xaml. Still, the initial issue persists.

maxkatz6 · 2023-01-24T01:23:25Z

build/AvaloniaDependency.props

+    <PackageReference Include="Avalonia" Version="11.0.0-preview4" />
+    <PackageReference Include="Avalonia.Controls.DataGrid" Version="11.0.0-preview4" />
+    <PackageReference Include="Avalonia.Desktop" Version="11.0.0-preview4" />
+    <PackageReference Include="Avalonia.Diagnostics" Version="11.0.0-preview4" />
+    <!--<PackageReference Condition="'$(Configuration)' == 'Debug'" Include="Avalonia.Diagnostics" Version="11.0.0-preview4" />-->
+    <PackageReference Include="Avalonia.LinuxFramebuffer" Version="11.0.0-preview4" />
+    <PackageReference Include="Avalonia.Markup.Xaml.Loader" Version="11.0.0-preview4" />
+    <PackageReference Include="Avalonia.ReactiveUI" Version="11.0.0-preview4" />


It seems to be the list of dependencies that will be referenced with the Prism.Avalonia nuget package.
If so, I believe this list is excessive.

Most likely, for the mvvm framework you most likely only need main "Avalonia" package.
Note, that I have used Prism a very little before in WPF, so I might miss some details.

Avalonia.Desktop - will block application to run only on Win, Mac and Lin. With the way how .NET dependencies work, this dependency unfortunately won't allow users to target Browser (WASM) projects.

Avalonia.Controls.DataGrid, Avalonia.Diagnostics and Avalonia.Markup.Xaml.Loader - these should be harmless in general, but also bloat application size, when they are not used (that's why Diagnostics also disable for the release in our templates).

Avalonia.LinuxFramebuffer - only makes sense if users want to target linux framebuffer, but should be harmless otherwise.

Avalonia.ReactiveUI - probably isn't needed here. If Prism uses System.Reactive, this dependency should be added manually (note, Avalonia doesn't reference System.Reactive anymore, starting with coming soon preview5)

Some of these packages still are needed for the sample project though.

@maxkatz6 in the next preview 5 release of this repo, I'll trim those down. You're right, we should only be referencing the bare minimum, most of them aren't being used.

maxkatz6 · 2023-01-24T01:26:59Z

samples/SampleMvvmApp/Views/DashboardView.xaml

+        <ListBox.ItemTemplate>
+          <!--
+          OLD: <DataTemplate>
+          NEW: <DataTemplate DataType="{x:Type system:String}">
+          https://github.com/AvaloniaUI/Avalonia/pull/8221
+          -->
+            <DataTemplate DataType="{x:Type system:String}">
            <TextBlock Text="{Binding .}"
                       FontSize="10"
                       TextWrapping="NoWrap" />
          </DataTemplate>
-        </ListBox.DataTemplates>
+        </ListBox.ItemTemplate>


Note, you don't necessary need DataType, if you use ListBox.ItemTemplate instead ListBox.DataTemplates.
It won't cause any exceptions, as ListBox.ItemTemplate is way more specific and won't pollute children with the template.
Although, it's always a good idea to setup more strict types. Especially with x:CompileBindings.

maxkatz6 · 2023-01-24T01:34:01Z

I fixe the ViewDiscovery sample to render, however, it is no longer auto-switching the views as it did w/ Avalonia v0.10.x. It appears that during the MainWindow's creation, it is not registering the Prism Region "ContentRegion" in time.

For this PR, can you try to switch to nightly builds? I remember there were issues with ContentControl which possibly can cause problems like this (note, I haven't debugged this issue).

Nightly builds, which should be shipped as preview5 in next weeks, some more breaking changes. But it also is expected to be last preview before release candidate.

More about nightly builds you can find here: https://github.com/AvaloniaUI/Avalonia/wiki/Using-nightly-build-feed or bot comments like this AvaloniaUI/Avalonia#10058 (comment)

DamianSuess · 2023-01-24T01:37:07Z

@maxkatz6, you're the man! i'll give it a shot. Wow, i wasn't expecting such quick feedback. If we ever meet up at some conference, a round of drinks are on me 👍

DamianSuess · 2023-01-30T20:24:17Z

hello all, just a heads up on the slow down..
Though I prefer the keep work & personal life separate, I just want to let you all know for the past month I've been very ill and still recovering. No, it's not the c-word. Pneumonia hit really hard and took its toll.

When the spare time allows in between old man naps, I'll try and get out preview NuGet packages for you all to consume (Preview-4, and Nightly) as per MaxKatz's awesome suggestion. I apologize for the inconvenience

…to denote Avalonia v11.0-preview4 support

DamianSuess · 2023-02-04T01:45:42Z

Published v8.1.91.3-preview.11.4 to NuGet.org

OmidID · 2023-02-04T10:15:23Z

WOA. WONDERFUL. THANKSSSSSSS A LOT. GREAT JOB

DamianSuess added 2 commits November 27, 2022 14:49

Updated base AvaloniaDependency.props to v11.0.0-preview4. Added Aval…

9fdd04f

…onia.Themes.Fluent to SampleApp.props, its now a separate package.

Avalonia 11.0.0-preview4 - Sample app, removed old theme

7038762

DamianSuess added the enhancement New feature or request label Nov 27, 2022

DamianSuess self-assigned this Nov 27, 2022

Merge branch 'master' into feature/Avalonia-0.11pre4

3b733b0

DamianSuess added 4 commits November 29, 2022 09:38

Avalonia v11.0.0-pre4 - SampleMvvmApp - Resolved Avalonia's new stric…

403c577

…t rules on DataTemplate DataType bindings

Dropped .NET 5 support as it is no longer maintained by Microsoft. Up…

06687e1

…dated NuGet description, replacing "Prism.WPF" typo with "Prism.Avalonia"

basic view for failure case testing

c2c45e3

Avalonia v11.0.0-pre4 - Added test for DataTemplate with missing Data…

9b9191e

…Type. Skipping unimplemented `Selector` test

This was linked to issues Dec 6, 2022

Issue when integrating with Avalonia 11.0 preview 2 #25

Closed

Avalonia v11.0.0-prev4 - ViewModelLocator.AutoWireViewModel Issue #28

Closed

DamianSuess added 4 commits December 6, 2022 12:13

Added test case for defining and not defining DataTemplate DataType i…

40439b2

…n XAML

Updated samples

c8ee99b

Merge branch 'master' into feature/Avalonia-0.11pre4

eb012bc

Sample view discovery

147cd71

maxkatz6 reviewed Dec 28, 2022

View reviewed changes

DamianSuess added 3 commits January 5, 2023 09:11

Updated change log

4e187de

Merge branch 'feature/Avalonia-0.11pre4' of https://github.com/Avalon…

fd2aec7

…iaCommunity/Prism.Avalonia into feature/Avalonia-0.11pre4

Updated sample ViewDiscovery, fixing XAML issues with Avalonia v11-pr…

3fbdf03

…eview4

DamianSuess marked this pull request as ready for review January 24, 2023 01:00

maxkatz6 reviewed Jan 24, 2023

View reviewed changes

DamianSuess added 2 commits February 3, 2023 19:35

Version number update for Avalonia-v11-preview4

3eda85c

Updated release notes and version numbering to 8.1.91.3-preview.11.4 …

b2f88c2

…to denote Avalonia v11.0-preview4 support

DamianSuess merged commit 14970c4 into master Feb 4, 2023

DamianSuess deleted the feature/Avalonia-0.11pre4 branch February 4, 2023 01:52

DamianSuess added this to the Avalonia v11.0-Preview milestone Jan 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avalonia v11.0.0-preview4 #31

Avalonia v11.0.0-preview4 #31

DamianSuess commented Nov 27, 2022 •

edited

OmidID commented Nov 28, 2022

DamianSuess commented Nov 28, 2022 •

edited

DamianSuess commented Nov 28, 2022 •

edited

rabbitism commented Dec 6, 2022

DamianSuess commented Dec 6, 2022 •

edited

maxkatz6 Dec 28, 2022

DamianSuess Jan 24, 2023

DamianSuess commented Jan 24, 2023

maxkatz6 Jan 24, 2023

maxkatz6 Jan 24, 2023

DamianSuess Feb 4, 2023

maxkatz6 Jan 24, 2023

maxkatz6 commented Jan 24, 2023

DamianSuess commented Jan 24, 2023

DamianSuess commented Jan 30, 2023

DamianSuess commented Feb 4, 2023

OmidID commented Feb 4, 2023

Avalonia v11.0.0-preview4 #31

Avalonia v11.0.0-preview4 #31

Conversation

DamianSuess commented Nov 27, 2022 • edited

Action Items

References

OmidID commented Nov 28, 2022

DamianSuess commented Nov 28, 2022 • edited

DamianSuess commented Nov 28, 2022 • edited

Considerations:

rabbitism commented Dec 6, 2022

DamianSuess commented Dec 6, 2022 • edited

maxkatz6 Dec 28, 2022

Choose a reason for hiding this comment

DamianSuess Jan 24, 2023

Choose a reason for hiding this comment

DamianSuess commented Jan 24, 2023

maxkatz6 Jan 24, 2023

Choose a reason for hiding this comment

maxkatz6 Jan 24, 2023

Choose a reason for hiding this comment

DamianSuess Feb 4, 2023

Choose a reason for hiding this comment

maxkatz6 Jan 24, 2023

Choose a reason for hiding this comment

maxkatz6 commented Jan 24, 2023

DamianSuess commented Jan 24, 2023

DamianSuess commented Jan 30, 2023

DamianSuess commented Feb 4, 2023

OmidID commented Feb 4, 2023

DamianSuess commented Nov 27, 2022 •

edited

DamianSuess commented Nov 28, 2022 •

edited

DamianSuess commented Nov 28, 2022 •

edited

DamianSuess commented Dec 6, 2022 •

edited