Skip to content

Add Documentation for Preload Script #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FlorianRappl merged 4 commits into from
Feb 25, 2026
+20 −0
Merged

Add Documentation for Preload Script #1031

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
497e6aa
Add check for existing preload script path before overriding
AeonSake Feb 17, 2026
850d8f6
Add documentation for preload script and warning for Blazor
AeonSake Feb 17, 2026
d5df307
Update documentation to reflect current approach
AeonSake Feb 17, 2026
3850a71
Revert "Add check for existing preload script path before overriding"
AeonSake Feb 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Using/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,26 @@ BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions
```


### Preload Script

If you require the use of a [preload script](https://www.electronjs.org/docs/latest/tutorial/tutorial-preload), you can specify the file path of the script when creating a new window like so:

```csharp
WebPreferences wp = new WebPreferences();
wp.Preload = "path/to/preload.js";
BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions
{
WebPreferences = wp
};
```

> [!IMPORTANT]
> When using a preload script _AND_ running a Blazor app, the following lines must be added to the preload script:
> ```js
> global.process = undefined;
> global.module = undefined;
> ```


## 🚀 Next Steps

Expand Down
4 changes: 2 additions & 2 deletions src/ElectronNET.Host/api/browserWindows.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/ElectronNET.Host/api/browserWindows.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,8 @@ export = (socket: Socket, app: Electron.App) => {
};
}

if (options.isRunningBlazor) {
options.webPreferences["preload"] = path.join(
if (options.isRunningBlazor && !options.webPreferences.preload) {
Copy link
Copy Markdown
Collaborator

@FlorianRappl FlorianRappl Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does not make sense as isRunningBlazor only exists for this.

The warning should be printed that a preload script will be ignored if isRunningBlazor is set. The option, which has been turned on explicitly, should always have preference.

Copy link
Copy Markdown
Contributor Author

@AeonSake AeonSake Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine by me, I'll update the note in the documentation to reflect this.

options.webPreferences.preload = path.join(
__dirname,
"..",
"scripts",
Expand Down