starred/Electron.NET
1
0
Fork 0
mirror of https://github.com/ElectronNET/Electron.NET.git synced 2026-07-19 23:25:59 +00:00
Code Issues 668 Packages Projects Releases 20 Wiki Activity

Improved demo and updated docs

Browse Source
This commit is contained in:
Florian Rappl
2026-05-25 21:44:07 +02:00
parent fdab81a3a6
commit 279a823eb7
8 changed files with 45 additions and 186 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/ElectronNET.Samples.AuthMiddleware/Components/_Imports.razor
View File

@@ -6,6 +6,6 @@
@using static Microsoft.AspNetCore.Components.Web.RenderMode
@using Microsoft.AspNetCore.Components.Web.Virtualization
@using Microsoft.JSInterop
@using ElectronNET.Samples.BlazorSignalR
@using ElectronNET.Samples.BlazorSignalR.Components
@using ElectronNET.Samples.BlazorSignalR.Components.Layout
@using ElectronNET.Samples.AuthMiddleware
@using ElectronNET.Samples.AuthMiddleware.Components
@using ElectronNET.Samples.AuthMiddleware.Components.Layout

6
src/ElectronNET.Samples.AuthMiddleware/ElectronNET.Samples.BlazorSignalR.csproj → src/ElectronNET.Samples.AuthMiddleware/ElectronNET.Samples.AuthMiddleware.csproj
View File

@@ -12,10 +12,10 @@
<Import Project="..\ElectronNET\build\ElectronNET.Core.props" Condition="$(ElectronNetDevMode)" />
<PropertyGroup Label="ElectronNetCommon">
<Title>Electron.NET Blazor SignalR Sample</Title>
<Title>Electron.NET Auth Middleware Sample</Title>
<Version>1.0.0</Version>
<Product>com.electronnet.blazor-signalr-sample</Product>
<Description>Sample Blazor Server application using Electron.NET with SignalR mode</Description>
<Product>com.electronnet.auth-middleware-sample</Product>
<Description>Sample Blazor Server application using Electron.NET with Auth Middleware</Description>
<Company>Electron.NET</Company>
<Copyright>Copyright © 2026, Electron.NET</Copyright>
<ElectronVersion>30.4.0</ElectronVersion>

2
src/ElectronNET.Samples.AuthMiddleware/ElectronNET.Samples.AuthMiddleware.sln
View File

@@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.5.2.0
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.Samples.BlazorSignalR", "ElectronNET.Samples.BlazorSignalR.csproj", "{1A87C5B5-16EE-5DA0-33B4-17DA71675A87}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.Samples.AuthMiddleware", "ElectronNET.Samples.AuthMiddleware.csproj", "{1A87C5B5-16EE-5DA0-33B4-17DA71675A87}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution

21
src/ElectronNET.Samples.AuthMiddleware/Program.Minimal.cs.txt
View File

@@ -1,21 +0,0 @@
using ElectronNET.API;
using ElectronNET.AspNet.Hubs;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddElectron();
// Configure Electron.NET with SignalR mode
builder.WebHost.UseElectron(args, async () =>
{
Console.WriteLine("[TEST] App ready callback started");
});
var app = builder.Build();
// Absolute minimal setup
app.MapHub<ElectronHub>("/electron-hub");
Console.WriteLine("[TEST] Application starting...");
app.Run();

10
src/ElectronNET.Samples.AuthMiddleware/Program.cs
View File

@@ -1,7 +1,7 @@
using ElectronNET.API;
using ElectronNET.API.Entities;
// using ElectronNET.AspNet.Middleware;
// using ElectronNET.AspNet.Services;
using ElectronNET.AspNet.Middleware;
using ElectronNET.AspNet.Services;
var watch = new System.Diagnostics.Stopwatch();
watch.Start();
@@ -24,7 +24,7 @@ builder.Services.AddCors(options =>
});
// Register Electron authentication service as singleton
// builder.Services.AddSingleton<IElectronAuthenticationService, ElectronAuthenticationService>();
builder.Services.AddSingleton<IElectronAuthenticationService, ElectronAuthenticationService>();
builder.Services.AddElectron();
@@ -63,7 +63,7 @@ var app = builder.Build();
serviceProvider = app.Services; // Capture for use in Electron callback above
// Register authentication middleware FIRST (before routing, static files, etc.)
// app.UseMiddleware<ElectronAuthenticationMiddleware>();
app.UseMiddleware<ElectronAuthenticationMiddleware>();
// Enable routing
app.UseRouting();
@@ -86,7 +86,7 @@ app.UseStatusCodePagesWithReExecute("/not-found", createScopeForStatusCodePages:
app.UseAntiforgery();
app.MapStaticAssets();
app.MapRazorComponents<ElectronNET.Samples.BlazorSignalR.Components.App>()
app.MapRazorComponents<ElectronNET.Samples.AuthMiddleware.Components.App>()
.AddInteractiveServerRenderMode();
app.Run();

153
src/ElectronNET.Samples.AuthMiddleware/README.md
View File

@@ -1,153 +0,0 @@
# Electron.NET Blazor SignalR Sample
This sample demonstrates how to use Electron.NET with **SignalR-based startup mode** in a Blazor Server application.
## Features
✅ **SignalR Communication** - Uses SignalR instead of socket.io for .NET ↔ Electron communication
✅ **Dynamic Port Assignment** - Kestrel binds to port 0, avoiding conflicts
✅ **Blazor Server** - Full Blazor Server support with interactive components
✅ **Electron Integration** - Native desktop window with auto-hide menu bar
## Prerequisites
- .NET 10.0 SDK or later
- Node.js 22.x or later
## How to Run
### Method 1: Visual Studio
1. Open the solution in Visual Studio
2. Set `ElectronNET.Samples.BlazorSignalR` as the startup project
3. Press **F5** to run
The environment variable `ELECTRON_USE_SIGNALR=true` is already configured in `launchSettings.json`.
### Method 2: Command Line
```bash
cd src/ElectronNET.Samples.BlazorSignalR
set ELECTRON_USE_SIGNALR=true # Windows
# or
export ELECTRON_USE_SIGNALR=true # Linux/Mac
dotnet run
```
## What Happens
1. ASP.NET Core starts with Kestrel on port 0 (random available port)
2. Electron.NET detects `ELECTRON_USE_SIGNALR=true` environment variable
3. Runtime controller captures the actual port (e.g., `http://localhost:54321`)
4. Electron process is launched with `--electronUrl=http://localhost:54321`
5. Electron connects to SignalR hub at `/electron-hub`
6. Once connected, the `ElectronAppReady` callback fires
7. A browser window is created showing the Blazor Server application
8. Both Blazor's SignalR hub (`/_blazor`) and Electron's hub (`/electron-hub`) run side-by-side
## Key Files
- **Program.cs** - Application startup with Electron and SignalR configuration
- **launchSettings.json** - Sets `ELECTRON_USE_SIGNALR=true` environment variable
- **ElectronNET.Samples.BlazorSignalR.csproj** - Project configuration with Electron.NET references
## Code Highlights
### Program.cs
```csharp
// Configure Electron.NET with SignalR mode
builder.WebHost.UseElectron(args, async () =>
{
var options = new BrowserWindowOptions
{
Show = false,
Width = 1200,
Height = 800,
IsRunningBlazor = true, // Crucial for Blazor support
};
var browserWindow = await Electron.WindowManager.CreateWindowAsync(options);
browserWindow.OnReadyToShow += () => browserWindow.Show();
});
// ... configure services ...
// Map the Electron SignalR hub (required for SignalR mode)
app.MapElectronHub();
```
### launchSettings.json
```json
{
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development",
"ELECTRON_USE_SIGNALR": "true"
},
"applicationUrl": "http://localhost:0"
}
```
## Differences from Socket.io Mode
| Aspect | Socket.io Mode | SignalR Mode |
|--------|---------------|--------------|
| Communication | socket.io | SignalR |
| Port Selection | Fixed port found by portscanner | Dynamic (port 0) |
| Startup Order | Electron → .NET or .NET → Electron | .NET → Electron |
| Hub Endpoint | N/A (socket.io on separate port) | `/electron-hub` |
| Environment Variable | None | `ELECTRON_USE_SIGNALR=true` |
## Console Output
When running successfully, you should see:
```
[SignalR Sample] Application configured and starting...
[RuntimeControllerAspNetDotnetFirstSignalR] StartCore
[RuntimeControllerAspNetDotnetFirstSignalR] URL: http://localhost:54321
[RuntimeControllerAspNetDotnetFirstSignalR] Launching: --dotnetpackedsignalr --electronUrl=http://localhost:54321
[RuntimeControllerAspNetDotnetFirstSignalR] Electron ready
[SignalRBridge] Connecting to http://localhost:54321/electron-hub
[ElectronHub] Client connected: abc123xyz
[SignalRBridge] Connected successfully
[RuntimeControllerAspNetDotnetFirstSignalR] SignalR connected!
[SignalR Sample] Electron app ready callback executed!
[SignalR Sample] Window ready and visible!
```
## Troubleshooting
### Window doesn't appear
- Check that `ELECTRON_USE_SIGNALR` environment variable is set
- Look for errors in the console output
- Verify `app.MapElectronHub()` is called in Program.cs
### Connection fails
- Ensure SignalR hub is properly mapped
- Check firewall settings
- Verify Node.js and npm packages are installed (`npm install` in ElectronNET.Host)
### Hot Reload issues
- SignalR supports automatic reconnection
- If issues persist, restart the application
## Next Steps
- Modify the Blazor components in `Components/Pages/`
- Add more Electron API calls in the `ElectronAppReady` callback
- Explore bidirectional communication between Blazor and Electron
## Learn More
- [SignalR Startup Mode Documentation](../../docs/SignalR-Startup-Mode.md)
- [Electron.NET Documentation](https://github.com/ElectronNET/Electron.NET/wiki)
- [ASP.NET Core SignalR](https://docs.microsoft.com/aspnet/core/signalr)
## License
MIT - Same as Electron.NET