Skip to content

Commit c778c8d

Browse files
Update docs for v6.5
1 parent 63ac4cf commit c778c8d

File tree

7 files changed

+96
-0
lines changed

7 files changed

+96
-0
lines changed

docs/api/events.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ by the Neutralinojs server based on native state changes.
1515
| `windowClose` | Occurs when the user closes the window. | `window` | `null`
1616
| `windowFocus` | Occurs when the window gets focused. | `window` | `null`
1717
| `windowBlur` | Occurs when the window focus state is gone. | `window` | `null`
18+
| `windowMinimize` | Occurs when the window gets minimized. | `window` | `null`
19+
| `windowRestore` | Occurs when the window gets restored from the minimized state. | `window` | `null`
20+
| `windowMaximize` | Occurs when the window gets maximized. | `window` | `null`
21+
| `windowFullScreenEnter` | Occurs when the window enters the full-screen mode. | `window` | `null`
22+
| `windowFullScreenEnter` | Occurs when the window leaves the full-screen mode. | `window` | `null`
1823
| `serverOffline` | Occurs when the Neutralino server is offline | `all` | `null`
1924
| `clientConnect` | Occurs when a new client access the application. | `all` | Total clients
2025
| `clientDisconnect` | Occurs when a connected client leaves the application. | `all` | Total clients

docs/api/window.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,19 @@ await Neutralino.window.setAlwaysOnTop(true); // or setAlwaysOnTop();
143143
await Neutralino.window.setAlwaysOnTop(false);
144144
```
145145

146+
## window.setBorderless(borderless)
147+
Activates or deactivates the borderless mode. 
148+
149+
### Parameters
150+
151+
- `borderless` Boolean (optional): Says whether the borderless mode should be activated or not. The default value
152+
is `true`.
153+
154+
```js
155+
await Neutralino.window.setBorderless(true); // or setBorderless();
156+
await Neutralino.window.setBorderless(false);
157+
```
158+
146159
## window.move(x, y)
147160
Moves the native window into given coordinates. Neutralinojs's cross-platform coordinate system starts from top-left corner of the screen.
148161
In other words, `x=0,y=0` point refers to the top-left corner of the device's main screen.

docs/configuration/neutralino.config.json.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,9 @@ the framework will dispatch the `windowClose` event.
306306
Save and load the primary window state (width, height, x, y, values and maximized status) automatically.
307307
The default value is `true`.
308308

309+
### `modes.window.useLogicalPixels: boolean`
310+
Activates DPI-aware sizing based on the operating system's display scale factor if this option is set to `true`.
311+
309312
### `modes.window.extendUserAgentWith: string`
310313
Extends the default webview-specific user agent string with a custom suffix. If this value is not set,
311314
the webview sets the default user agent from the platform-specific rendering engine (i.e., WebKit on GNU/Linux).
@@ -335,6 +338,24 @@ Width of the chrome window.
335338
### `modes.chrome.height: number`
336339
Height of the chrome window.
337340

341+
### `modes.chrome.browserBinary: string`
342+
Set custom browser binary path under the chrome mode. If this field is specified, the framework will try to launch Chrome from there.
343+
If it fails, the framework will initiate the Chrome binary search as usual:
344+
345+
```js
346+
// cross-platform
347+
"browserBinary": "/path/to/chrome/bin"
348+
349+
// platform-specific path
350+
"browserBinaryLinux": "/usr/bin/google-chrome",
351+
"browserBinaryDarwin": "/Applications/Google Chrome.app",
352+
"browserBinaryWindows": "C:\\Programs\\Google Chrome\\chrome.exe"
353+
354+
// cross-platform (with path constants)
355+
"browserBinary": "${NL_OSDATAPATH}/chrome/bin"
356+
"browserBinaryWindows": "${NL_OSDOWNLOADSPATH}/chrome.exe"
357+
```
358+
338359
### `modes.chrome.args: string`
339360
Additional command-line arguments for the Chrome process. Read more about chrome mode
340361
from [here](./modes.md#chrome)

docs/how-to/extensions-overview.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ First, you need to define extensions you use in `neutralinojs.config.json` with
3232
- `commandDarwin` String (optional): Extension startup command for macOS.
3333
- `commandWindows` String (optional): Extension startup command for Windows.
3434

35+
Extension commands support path constants like `${NL_PATH}`, `${NL_OSDOWNLOADSPATH}`, etc. Path constants that begin with the `NL_OS` prefix use
36+
the `${NL_OS<name>PATH}` format where `<name>` is any accepted parameter (uppercased) to the [`os.getPath(name)`](../api/os.md#osgetpathname) function.
37+
3538
## Enable the extensions feature
3639

3740
The extensions API is disabled by default. Enable extensions by adding the following setting to your app config.

docs/release-notes/cli.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ toc_max_heading_level: 2
55

66
## Unreleased
77

8+
## v11.7.0
9+
10+
### Bugfixes/improvements
11+
- Display the zipped binaries package size while downloading pre-built Neutralinojs binaries from GitHub releases.
12+
- Use the correct resources path for host projects
13+
- Skip patching the frontend library's main HTML file when it's defined as empty in the configuration
14+
- Improve local plugin testing commands implementations
15+
- Upgrading several project dependencies
16+
817
## v11.6.0
918

1019
### Core: Bundler

docs/release-notes/client-library.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ toc_max_heading_level: 2
55

66
## Unreleased
77

8+
## v6.5.0
9+
10+
### API: window
11+
- Export `window.setBorderless(borderless: boolean)`
12+
13+
### TypeScript
14+
- Add missing `center` to `WindowPosOptions`
15+
- Use correct return type for `server.getMounts()`
16+
17+
### Bugfixes/improvements
18+
- Improve updator API error messages
19+
820
## v6.4.0
921

1022
### API: storage

docs/release-notes/framework.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,39 @@ toc_max_heading_level: 2
55

66
## Unreleased
77

8+
## v6.5.0
9+
10+
### Core: events
11+
- New window events: `windowMinimize`, `windowRestore`, `windowMaximize`, `windowFullScreenEnter`, and `windowFullScreenExit`
12+
13+
### API: window
14+
- Add `window.setBorderless(bool)` to toggle borderless mode while the Neutralinojs app is running.
15+
16+
### Configuration
17+
- Add `modes.chrome.browserBinary` option to set custom browser binary path under the chrome mode. If this field is specified, the framework will try to launch Chrome from there. If it fails, the framework will initiate the Chrome binary search as usual:
18+
```js
19+
// cross-platform
20+
"browserBinary": "/path/to/chrome/bin"
21+
22+
// platform-specific path
23+
"browserBinaryLinux": "/usr/bin/google-chrome",
24+
"browserBinaryDarwin": "/Applications/Google Chrome.app",
25+
"browserBinaryWindows": "C:\\Programs\\Google Chrome\\chrome.exe"
26+
27+
// cross-platform (with path constants)
28+
"browserBinary": "${NL_OSDATAPATH}/chrome/bin"
29+
"browserBinaryWindows": "${NL_OSDOWNLOADSPATH}/chrome.exe"
30+
```
31+
- Add the `modes.window.useLogicalPixels: true|false` option to activate DPI-aware sizing based on the operating system's display scale factor.
32+
- Add extra path constants support (early versions only supported `${NL_PATH}`) for the extensions command: `${NL_OSDATAPATH}`, `${NL_OSCACHEPATH}`, ... All supported path constants use this format: `${NL_OS<name>PATH}` where `<name>` is any accepted parameter (uppercased) to the `os.getPath(name)` function:
33+
```js
34+
"commandLinux": "${NL_OSDOWNLOADSPATH}/extensionBinary --load"
35+
```
36+
37+
### Improvements/bugfixes
38+
- Fix issues with filter extension handling of the file dialogs API on Linux
39+
- Fix tray icon disappearing issue on Windows
40+
841
## v6.4.0
942

1043
### API: storage

0 commit comments

Comments
 (0)