diff --git a/dev-packages/cli/README.md b/dev-packages/cli/README.md index 612ca3a8a0597..c12f74a347243 100644 --- a/dev-packages/cli/README.md +++ b/dev-packages/cli/README.md @@ -15,10 +15,11 @@ - [**Description**](#description) - [**Getting Started**](#getting-started) - [**Configure**](#configure) - - [**Build Target**](#build-target) - [**Application Properties**](#application-properties) - [**Default Preferences**](#default-preferences) - [**Default Theme**](#default-theme) + - [**Build Target**](#build-target) + - [**Electron Frontend Application Config**](#electron-frontend-application-config) - [**Using Latest Builds**](#using-latest-builds) - [**Building**](#building) - [**Build**](#build) @@ -127,6 +128,37 @@ The target can be configured in the `package.json` via `theia/target` property, For `electron` target applications, is it mandatory to include **Electron** runtime dependencies. The `@theia/electron` package is the easiest way to install the necessary dependencies. +### Electron Frontend Application Config + +The `electron` frontend application configuration provides configuration options for the `electron` target.\ +The currently supported configurations are: + +- `disallowReloadKeybinding`: if set to `true`, reloading the current browser window won't be possible with the Ctrl/Cmd + r keybinding. It is `false` by default. Has no effect if not in an electron environment. +- `windowOptions`: override or add properties to the electron `windowOptions`. + +```json +{ + "theia": { + "target": "electron", + "frontend": { + "config": { + "electron": { + "disallowReloadKeybinding": true, + "windowOptions": { + "titleBarStyle": "hidden", + "webPreferences": { + "webSecurity": false, + "nodeIntegration": true, + "webviewTag": true + } + } + } + } + } + } +} +``` + ### Using Latest Builds If you set `next` in your theia config, then Theia will prefer `next` over `latest` as the latest tag.