Prepare for Blazor support

Author: FlorianRappl

Changelog.md

@@ -1,3 +1,9 @@
+# 0.2.0
+
+## ElectronNET.Core
+
+- Added `IsRunningBlazor` option to `BrowserWindowOptions` (#926)
+
 # 0.1.0
 
 ## ElectronNET.Core

README.md

@@ -58,22 +58,22 @@ To do so, use the `UseElectron` extension method on a `WebApplicationBuilder`, a
 using ElectronNET.API;
 using ElectronNET.API.Entities;
 
-    public static void Main(string[] args)
-    {
-        WebHost.CreateDefaultBuilder(args)
-            .UseElectron(args, ElectronAppReady)
-            .UseStartup<Startup>()
-            .Build()
-            .Run();
-    }
-
-    public static async Task ElectronAppReady()
-    {
-        var browserWindow = await Electron.WindowManager.CreateWindowAsync(
-            new BrowserWindowOptions { Show = false });
-
-        browserWindow.OnReadyToShow += () => browserWindow.Show();
-    }
+public static void Main(string[] args)
+{
+    WebHost.CreateDefaultBuilder(args)
+        .UseElectron(args, ElectronAppReady)
+        .UseStartup<Startup>()
+        .Build()
+        .Run();
+}
+
+public static async Task ElectronAppReady()
+{
+    var browserWindow = await Electron.WindowManager.CreateWindowAsync(
+        new BrowserWindowOptions { Show = false });
+
+    browserWindow.OnReadyToShow += () => browserWindow.Show();
+}
 ```
 
 ### Minimal API Example
@@ -113,6 +113,56 @@ app.MapRazorPages();
 app.Run();
 ```
 
+### Blazor
+
+For a project with Blazor you can use:
+
+```cs
+using ElectronNET.API;
+using ElectronNET.API.Entities;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services
+    .AddRazorComponents()
+    .AddInteractiveWebAssemblyComponents();
+
+builder.Services.AddElectron(); // <-- might be useful to set up DI
+
+builder.UseElectron(args, async () =>
+{
+    var options = new BrowserWindowOptions {
+        Show = false,
+        AutoHideMenuBar = true,
+        IsRunningBlazor = true, // <-- crucial
+    };
+    var browserWindow = await Electron.WindowManager.CreateWindowAsync(options);
+    browserWindow.OnReadyToShow += () => browserWindow.Show();
+});
+
+var app = builder.Build();
+
+// Configure the HTTP request pipeline.
+if (app.Environment.IsDevelopment())
+{
+    app.UseWebAssemblyDebugging();
+}
+else
+{
+    app.UseExceptionHandler("/Error", createScopeForErrors: true);
+}
+
+app.UseStaticFiles();
+app.UseAntiforgery();
+
+app.MapRazorComponents<BlazorApp.Components.App>()
+    .AddInteractiveWebAssemblyRenderMode();
+
+app.Run();
+```
+
+The `IsRunningBlazor` option makes sure to set up the renderer in a way that Blazor can just run without any interference. This includes things such as HMR for development.
+
 ## 🚀 Starting and Debugging the Application
 
 Just press `F5` in Visual Studio or use dotnet for debugging.

docs/GettingStarted/Console-App.md

@@ -54,7 +54,7 @@ Add the Electron.NET configuration to your `.csproj` file:
 </PropertyGroup>
 
 <ItemGroup>
-  <PackageReference Include="ElectronNET.Core" Version="0.1.0" />
+  <PackageReference Include="ElectronNET.Core" Version="0.2.0" />
 </ItemGroup>
 ```
 

src/ElectronNET.API/API/Entities/BrowserWindowOptions.cs

@@ -126,6 +126,11 @@ public class BrowserWindowOptions
         /// </summary>
         public bool SkipTaskbar { get; set; }
 
+        /// <summary>
+        /// Determines if Blazor is used. Will disable "module" and "process" globals. Default is false.
+        /// </summary>
+        public bool IsRunningBlazor { get; set; }
+
         /// <summary>
         /// The kiosk mode. Default is false.
         /// </summary>

src/ElectronNET.ConsoleApp/ElectronNET.ConsoleApp.csproj

@@ -69,7 +69,7 @@
     <ProjectReference Include="..\ElectronNET.API\ElectronNET.API.csproj" Condition="$(ElectronNetDevMode)" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="ElectronNET.Core" Version="0.1.0" Condition="'$(ElectronNetDevMode)' != 'true'" />
+    <PackageReference Include="ElectronNET.Core" Version="0.2.0" Condition="'$(ElectronNetDevMode)' != 'true'" />
   </ItemGroup>
 
   <Import Project="..\ElectronNET\build\ElectronNET.targets" Condition="$(ElectronNetDevMode)" />