ElectronSharp.API 27.1.0.43644

There is a newer version of this package available.
See the version list below for details.
dotnet add package ElectronSharp.API --version 27.1.0.43644
                    
NuGet\Install-Package ElectronSharp.API -Version 27.1.0.43644
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ElectronSharp.API" Version="27.1.0.43644" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ElectronSharp.API" Version="27.1.0.43644" />
                    
Directory.Packages.props
<PackageReference Include="ElectronSharp.API" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ElectronSharp.API --version 27.1.0.43644
                    
#r "nuget: ElectronSharp.API, 27.1.0.43644"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=ElectronSharp.API&version=27.1.0.43644
                    
Install as a Cake Addin
#tool nuget:?package=ElectronSharp.API&version=27.1.0.43644
                    
Install as a Cake Tool

<img src="https://github.com/theolivenbaum/electron-sharp/blob/main/assets/electron-sharp-logo.svg" width="100" height="100"/>

ElectronSharp

Build cross platform desktop apps with .NET 7 and ASP.NET Core (Razor Pages, MVC), Blazor or h5.

ElectronSharp is a wrapper around a "normal" Electron application with an embedded ASP.NET Core application. It uses a socket-based IPC bridge we can invoke Electron APIs from .NET.

The CLI extensions hosts the toolset to build and start ElectronSharp-based applications.

ElectronSharp is a hard fork from the original Electron.NET project, mantained by me and used to build the Curiosity app.

📦 NuGet:

  • API NuGet
  • CLI NuGet

🛠 Requirements to run:

The current ElectronSharp CLI builds Windows/macOS/Linux binaries. The API uses .NET 7, so our minimum base OS is the same as .NET 7.

Also you should have installed:

👩‍🏫 Usage

To activate and communicate with the Electron API, include the ElectronSharp.API NuGet package in your ASP.NET Core app. Check out the Electron.SampleApp for an example of how to use ElectronSharp.

PM> Install-Package ElectronSharp.API

Program.cs

You start ElectronSharp up with an UseElectron WebHostBuilder-Extension.

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseElectron(args);
            webBuilder.UseStartup<Startup>();
        });

Startup.cs

Open the Electron Window in the Startup.cs file:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    ...

    // Open the Electron-Window here
    Task.Run(async () => await Electron.WindowManager.CreateWindowAsync());
}

🚀 Start the Application

To start the application make sure you have installed the "ElectronSharp.CLI" packages as global tool:

dotnet tool install ElectronSharp.CLI -g

At the first time, you need an ElectronSharp project initialization. Type the following command in your app folder:

electron-sharp init
  • Now a electronnet.manifest.json should appear in your ASP.NET Core project
  • Now run the following:
electron-sharp start

Hint

If invoking any of those commands gives you strange errors (like .NET 5 not installed, but your project is .NET 6), it means you've typed electronize instead of electron-sharp.

Note

Only the first electronize start is slow. The next will go on faster.

🔭 Develop ElectronSharp apps using a file watcher

The file watcher is included with version 8.31.1 of ElectronSharp. For example, a file change can trigger compilation, test execution, or deployment. The ElectronSharp window will automatically refresh and new code changes will be visible more quickly. The following ElectronSharp CLI command is required:

electron-sharp start /watch

Note

Only the first electronize start is slow. The next will go on faster.

🐞 Debug

Start your ElectronSharp application with the ElectronSharp CLI command. In Visual Studio attach to your running application instance. Go in the Debug Menu and click on Attach to Process.... Sort by your projectname on the right and select it on the list.

📔 Usage of the Electron-API

A complete documentation will follow. Until then take a look in the source code of the sample application:
ElectronSharp Sample App

⛏ Build

Here you need the ElectronSharp CLI as well. Type the following command in your ASP.NET Core folder:

electronize build /target win

There are additional platforms available:

electron-sharp build /target win
electron-sharp build /target osx
electron-sharp build /target osx-arm64
electron-sharp build /target linux

Those four "default" targets will produce packages for those platforms. Note that the osx-arm64 is for Apple Silicon Macs.

For certain NuGet packages or certain scenarios you may want to build a pure x86 application. To support those things you can define the desired .NET runtime, the electron platform and electron architecture like this:

electron-sharp build /target custom "win7-x86;win32" /electron-arch ia32 

The end result should be an electron app under your /bin/desktop folder.

Note

macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per this Electron issue). macOS builds can be produced on either Linux or macOS machines.

👨‍💻 Original (Electron.NET) Authors

  • Gregor Biswanger - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - Cross-Platform-Blog - Twitter @BFreakout
  • Robert Muehsig - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - codeinside Blog - Twitter @robert0muehsig

See also the list of contributors who participated in the original project.

🙋‍♀️🙋‍♂ Contributing

Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the Issues section. Please make sure all commits are properly documented.

🎉 License

MIT-licensed

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
36.2.0.59099 265 6/30/2025
36.2.0.57911 509 5/8/2025
35.1.4.57522 181 4/5/2025
35.1.2.57212 1,404 3/28/2025
35.0.2.56759 294 3/17/2025
34.0.1.55684 1,193 1/30/2025
34.0.1.55490 233 1/25/2025
33.3.1.54760 399 1/7/2025
33.2.0.53881 646 11/21/2024
33.2.0.53880 124 11/21/2024
32.0.1.51369 1,300 8/23/2024
31.3.1.50855 217 7/29/2024
31.3.0.50755 196 7/28/2024
31.3.0.50594 197 7/25/2024
31.2.1.50335 299 7/16/2024
31.2.0.50292 171 7/15/2024
31.1.0.50269 130 7/13/2024
31.1.0.49989 271 6/27/2024
30.0.6.49104 550 5/22/2024
30.0.6.49034 126 5/19/2024
30.0.6.48961 258 5/16/2024
30.0.4.48738 193 5/14/2024
30.0.2.48552 204 5/9/2024
30.0.2.48434 189 5/7/2024
30.0.2.48296 151 5/2/2024
30.0.1.47933 282 4/19/2024
30.0.0.47870 153 4/17/2024
29.3.0.47750 242 4/12/2024
29.1.5.47165 348 3/22/2024
29.1.5.47134 212 3/21/2024
29.1.4.46985 261 3/14/2024
29.0.1.46142 923 2/22/2024
28.2.0.44969 1,557 1/27/2024
28.1.3.44599 277 1/11/2024
28.0.0.44380 374 12/14/2023
27.1.0.43670 1,732 11/17/2023
27.1.0.43644 150 11/16/2023
27.1.0.43604 216 11/16/2023
27.0.4.43553 200 11/13/2023
27.0.4.43552 148 11/13/2023
27.0.4.43498 279 11/9/2023
27.0.2.43249 199 10/24/2023
27.0.1.43128 495 10/19/2023
27.0.0.43002 265 10/13/2023
26.3.0.42624 412 10/5/2023
26.3.0.42623 169 10/5/2023
26.2.4.42548 231 10/2/2023
26.2.2.42382 275 9/20/2023
26.2.1.42149 255 9/16/2023
26.2.1.42101 219 9/15/2023
26.2.0.41770 270 9/7/2023
26.1.0.41750 165 9/6/2023
26.1.0.41739 273 9/6/2023
26.1.0.41637 206 9/5/2023
26.1.0.41603 164 9/4/2023
26.1.0.41265 338 8/28/2023
26.1.0.41264 194 8/28/2023
26.1.0.41263 182 8/28/2023
26.1.0.41243 203 8/28/2023
26.1.0.41010 284 8/24/2023
26.0.0.40902 254 8/22/2023
25.3.1.40533 443 8/8/2023
25.3.1.40262 277 7/20/2023
25.3.0.40090 216 7/16/2023
25.2.0.39535 607 6/27/2023
25.2.0.39487 202 6/26/2023
25.0.1.39151 368 6/2/2023
25.0.0.39150 252 6/2/2023
25.0.0.38955 276 5/30/2023
24.4.0.38875 254 5/25/2023
24.4.0.38874 224 5/25/2023
24.0.0.37423 851 4/11/2023
23.1.3.36686 833 3/15/2023
23.1.3.36685 293 3/15/2023
23.1.3.36684 299 3/15/2023
23.1.3.36622 307 3/9/2023
23.0.0.36276 499 2/15/2023
23.0.0.36236 372 2/14/2023
23.0.0.36228 339 2/13/2023
23.0.0.36192 357 2/13/2023
23.0.0.35946 420 2/7/2023
22.2.0.35891 406 2/5/2023
22.2.0.35887 362 2/4/2023
22.1.0.35531 501 1/27/2023
22.0.2.35227 766 1/15/2023
22.0.0.35063 403 1/5/2023
22.0.0.35062 391 1/5/2023
22.0.0.35061 410 1/5/2023
22.0.0.35059 390 1/5/2023
22.0.0.35057 422 1/5/2023