Merge pull request #203 from AvaloniaUI/return-viewLocator

Return view locator
AvaloniaUI · Jun 14, 2023 · 92e0749 · 92e0749
2 parents b91ac29 + 1ae49f5
commit 92e0749
Show file tree

Hide file tree

Showing 32 changed files with 408 additions and 21 deletions.
diff --git a/readme.md b/readme.md
@@ -119,6 +119,14 @@ Available parameters:
 
 *By default*: ReactiveUI
 
+``-rvl, --remove-view-locator``
+
+*Description*: Defines if your app will use default ViewLocator made by Avalonia Team or you are planning to use a custom one. Removing ViewLocator may be useful in code trimming scenarios. Default ViewLocator is not trimming-friendly.
+
+*Options*: **true**, **false**
+
+*By default*: false
+
 ``--no-restore``
 
 *Description*: If specified, skips the automatic restore of the project on create.
@@ -143,6 +151,14 @@ Available parameters:
 
 *By default*: true
 
+``-rvl, --remove-view-locator``
+
+*Description*: Defines if your app will use default ViewLocator made by Avalonia Team or you are planning to use a custom one. Removing ViewLocator may be useful in code trimming scenarios. Default ViewLocator is not trimming-friendly.
+
+*Options*: **true**, **false**
+
+*By default*: false
+
 # Creating a new Window
 
 To create a new `Window` called `MyNewWindow`, in the namespace `MyApp` run:

diff --git a/templates/csharp/app-mvvm/.template.config/dotnetcli.host.json b/templates/csharp/app-mvvm/.template.config/dotnetcli.host.json
@@ -11,6 +11,9 @@
     "AvaloniaVersion": {
       "longName": "avalonia-version"
     },
+    "RemoveViewLocator": {
+      "longName": "remove-view-locator"
+    },
     "MVVMToolkit": {
       "longName": "mvvm"
     },

diff --git a/templates/csharp/app-mvvm/.template.config/ide.host.json b/templates/csharp/app-mvvm/.template.config/ide.host.json
@@ -22,6 +22,13 @@
         "text": "Use Compiled Bindings"
       },
       "isVisible": true
+    },
+    {
+      "id": "RemoveViewLocator",
+      "name": {
+        "text": "Remove View Locator"
+      },
+      "isVisible": true
     }
   ]
 }
diff --git a/templates/csharp/app-mvvm/.template.config/template.json b/templates/csharp/app-mvvm/.template.config/template.json
@@ -91,6 +91,13 @@
       "defaultValue": "true",
       "isEnabled": "(AvaloniaVersion != \"0.10.21\")"
     },
+    "RemoveViewLocator": {
+      "type": "parameter",
+      "description": "Defines if your app will use default ViewLocator made by Avalonia Team or you are planning to use a custom one. Removing ViewLocator may be useful in code trimming scenarios. Default ViewLocator is not trimming-friendly.",
+      "datatype": "bool",
+      "displayName": "Remove Avalonia ViewLocator",
+      "defaultValue": "false"
+    },
     "HostIdentifier": {
       "type": "bind",
       "binding": "HostIdentifier"
@@ -100,21 +107,49 @@
     {
       "modifiers": [
         {
-          "condition": "(AvaloniaStableChosen)",
+          "condition": "(RemoveViewLocator && AvaloniaStableChosen)",
           "exclude": [
-            "App.v11.axaml"
-          ]
+            "App.axaml",
+            "App.v11.axaml",
+            "App.v11.RemoveViewLocator.axaml",
+            "ViewLocator.cs"
+          ],
+          "rename": {
+            "App.RemoveViewLocator.axaml": "App.axaml"
+          }
         },
         {
-          "condition": "(!AvaloniaStableChosen)",
+          "condition": "(!RemoveViewLocator && AvaloniaStableChosen)",
           "exclude": [
-            "App.axaml"
+            "App.v11.axaml",
+            "App.RemoveViewLocator.axaml",
+            "App.v11.RemoveViewLocator.axaml"
           ]
+        },
+        {
+          "condition": "(RemoveViewLocator && !AvaloniaStableChosen)",
+          "exclude": [
+            "App.axaml",
+            "App.v11.axaml",
+            "App.RemoveViewLocator.axaml",
+            "ViewLocator.cs"
+          ],
+          "rename": {
+            "App.v11.RemoveViewLocator.axaml": "App.axaml"
+          }
+        },
+        {
+          "condition": "(!RemoveViewLocator && !AvaloniaStableChosen)",
+          "exclude": [
+            "App.axaml",
+            "App.RemoveViewLocator.axaml",
+            "App.v11.RemoveViewLocator.axaml"
+          ],
+          "rename": {
+            "App.v11.axaml": "App.axaml"
+          }
         }
-      ],
-      "rename": {
-        "App.v11.axaml": "App.axaml"
-      }
+      ]
     }
   ],
   "primaryOutputs": [

diff --git a/templates/csharp/app-mvvm/App.RemoveViewLocator.axaml b/templates/csharp/app-mvvm/App.RemoveViewLocator.axaml
@@ -0,0 +1,8 @@
+<Application xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             x:Class="AvaloniaAppTemplate.App">
+
+    <Application.Styles>
+        <FluentTheme Mode="Light"/>
+    </Application.Styles>
+</Application>
diff --git a/templates/csharp/app-mvvm/App.axaml b/templates/csharp/app-mvvm/App.axaml
@@ -1,7 +1,12 @@
 <Application xmlns="https://github.com/avaloniaui"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:local="using:AvaloniaAppTemplate"
              x:Class="AvaloniaAppTemplate.App">
 
+    <Application.DataTemplates>
+        <local:ViewLocator/>
+    </Application.DataTemplates>
+
     <Application.Styles>
         <FluentTheme Mode="Light"/>
     </Application.Styles>

diff --git a/templates/csharp/app-mvvm/App.v11.RemoveViewLocator.axaml b/templates/csharp/app-mvvm/App.v11.RemoveViewLocator.axaml
@@ -0,0 +1,10 @@
+<Application xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             x:Class="AvaloniaAppTemplate.App"
+             RequestedThemeVariant="Default">
+             <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->
+
+    <Application.Styles>
+        <FluentTheme />
+    </Application.Styles>
+</Application>
diff --git a/templates/csharp/app-mvvm/App.v11.axaml b/templates/csharp/app-mvvm/App.v11.axaml
@@ -1,9 +1,14 @@
 <Application xmlns="https://github.com/avaloniaui"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
              x:Class="AvaloniaAppTemplate.App"
+             xmlns:local="using:AvaloniaAppTemplate"
              RequestedThemeVariant="Default">
              <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->
 
+    <Application.DataTemplates>
+        <local:ViewLocator/>
+    </Application.DataTemplates>
+
     <Application.Styles>
         <FluentTheme />
     </Application.Styles>

diff --git a/templates/csharp/app-mvvm/ViewLocator.cs b/templates/csharp/app-mvvm/ViewLocator.cs
@@ -0,0 +1,31 @@
+using System;
+using Avalonia.Controls;
+using Avalonia.Controls.Templates;
+using AvaloniaAppTemplate.ViewModels;
+
+namespace AvaloniaAppTemplate;
+
+public class ViewLocator : IDataTemplate
+{
+#if (AvaloniaStableChosen)
+    public IControl Build(object data)
+#else
+    public Control Build(object data)
+#endif
+    {
+        var name = data.GetType().FullName!.Replace("ViewModel", "View");
+        var type = Type.GetType(name);
+
+        if (type != null)
+        {
+            return (Control)Activator.CreateInstance(type)!;
+        }
+
+        return new TextBlock { Text = "Not Found: " + name };
+    }
+
+    public bool Match(object data)
+    {
+        return data is ViewModelBase;
+    }
+}
diff --git a/templates/csharp/xplat/.template.config/dotnetcli.host.json b/templates/csharp/xplat/.template.config/dotnetcli.host.json
@@ -6,6 +6,9 @@
     },
     "UseCompiledBindings": {
       "longName": "compiled-bindings"
+    },
+    "RemoveViewLocator": {
+      "longName": "remove-view-locator"
     }
   },
   "usageExamples": [

diff --git a/templates/csharp/xplat/.template.config/ide.host.json b/templates/csharp/xplat/.template.config/ide.host.json
@@ -8,6 +8,13 @@
         "text": "Use Compiled Bindings"
       },
       "isVisible": true
+    },
+    {
+      "id": "RemoveViewLocator",
+      "name": {
+        "text": "Remove View Locator"
+      },
+      "isVisible": true
     }
   ]
 }
diff --git a/templates/csharp/xplat/.template.config/template.json b/templates/csharp/xplat/.template.config/template.json
@@ -35,11 +35,40 @@
       "displayName": "Use compiled Bindings",
       "defaultValue": "true"
     },
+    "RemoveViewLocator": {
+      "type": "parameter",
+      "description": "Defines if your app will use default ViewLocator made by Avalonia Team or you are planning to use a custom one. Removing ViewLocator may be useful in code trimming scenarios. Default ViewLocator is not trimming-friendly.",
+      "datatype": "bool",
+      "displayName": "Remove Avalonia ViewLocator",
+      "defaultValue": "false"
+    },
     "HostIdentifier": {
       "type": "bind",
       "binding": "HostIdentifier"
     }
   },
+  "sources": [
+    {
+      "modifiers": [
+        {
+          "condition": "(RemoveViewLocator)",
+          "exclude": [
+            "AvaloniaTest/App.axaml",
+            "AvaloniaTest/ViewLocator.cs"
+          ],
+          "rename": {
+            "App.RemoveViewLocator.axaml": "App.axaml"
+          }
+        },
+        {
+          "condition": "(!RemoveViewLocator)",
+          "exclude": [
+            "AvaloniaTest/App.RemoveViewLocator.axaml"
+          ]
+        }
+      ]
+    }
+  ],
   "primaryOutputs": [
     { "path": "AvaloniaTest/AvaloniaTest.csproj" },
     { "path": "AvaloniaTest.Android/AvaloniaTest.Android.csproj" },
@@ -60,7 +89,7 @@
       "id": "editor",
       "condition": "(HostIdentifier != \"dotnetcli\" && HostIdentifier != \"dotnetcli-preview\")",
       "description": "Opens MainView and MainViewModel in the editor",
-      "manualInstructions": [ ],
+      "manualInstructions": [],
       "actionId": "84C0DA21-51C8-4541-9940-6CA19AF04EE6",
       "args": {
         "files": "5;6"

diff --git a/templates/csharp/xplat/AvaloniaTest/App.RemoveViewLocator.axaml b/templates/csharp/xplat/AvaloniaTest/App.RemoveViewLocator.axaml
@@ -0,0 +1,10 @@
+<Application xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             x:Class="AvaloniaTest.App"
+             RequestedThemeVariant="Default">
+             <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->
+
+    <Application.Styles>
+        <FluentTheme />
+    </Application.Styles>
+</Application>
diff --git a/templates/csharp/xplat/AvaloniaTest/App.axaml b/templates/csharp/xplat/AvaloniaTest/App.axaml
@@ -1,9 +1,14 @@
 <Application xmlns="https://github.com/avaloniaui"
              xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:local="using:AvaloniaTest"
              x:Class="AvaloniaTest.App"
              RequestedThemeVariant="Default">
              <!-- "Default" ThemeVariant follows system theme variant. "Dark" or "Light" are other available options. -->
 
+    <Application.DataTemplates>
+        <local:ViewLocator/>
+    </Application.DataTemplates>
+
     <Application.Styles>
         <FluentTheme />
     </Application.Styles>

diff --git a/templates/csharp/xplat/AvaloniaTest/ViewLocator.cs b/templates/csharp/xplat/AvaloniaTest/ViewLocator.cs
@@ -0,0 +1,34 @@
+using System;
+using Avalonia.Controls;
+using Avalonia.Controls.Templates;
+using AvaloniaTest.ViewModels;
+
+namespace AvaloniaTest;
+
+public class ViewLocator : IDataTemplate
+{
+#if (AvaloniaStableChosen)
+    public IControl Build(object data)
+#else
+    public Control Build(object data)
+#endif
+    {
+        if (data is null)
+            return null;
+
+        var name = data.GetType().FullName!.Replace("ViewModel", "View");
+        var type = Type.GetType(name);
+
+        if (type != null)
+        {
+            return (Control)Activator.CreateInstance(type)!;
+        }
+
+        return new TextBlock { Text = name };
+    }
+
+    public bool Match(object? data)
+    {
+        return data is ViewModelBase;
+    }
+}
diff --git a/templates/fsharp/app-mvvm/.template.config/dotnetcli.host.json b/templates/fsharp/app-mvvm/.template.config/dotnetcli.host.json
@@ -11,6 +11,9 @@
     "AvaloniaVersion": {
       "longName": "avalonia-version"
     },
+    "RemoveViewLocator": {
+      "longName": "remove-view-locator"
+    },
     "MVVMToolkit": {
       "longName": "mvvm"
     },

diff --git a/templates/fsharp/app-mvvm/.template.config/ide.host.json b/templates/fsharp/app-mvvm/.template.config/ide.host.json
@@ -22,6 +22,13 @@
         "text": "Use Compiled Bindings"
       },
       "isVisible": true
+    },
+    {
+      "id": "RemoveViewLocator",
+      "name": {
+        "text": "Remove View Locator"
+      },
+      "isVisible": true
     }
   ]
 }