Pear release 1.10.0 docs (#165)

* Add `pear.gui.hideable` configuration option

Added in Pear v1.10.0

* Add note about platform specific `gui` options

* Tweak platform list text to show connection w/ header

* Clean up line breaks in gui platform config section

* Remove platforms not supported by electron in GUI config section
This commit is contained in:
Sean Zellmer
2025-02-14 02:35:21 -06:00
committed by GitHub
parent 9713b381a1
commit b011d81d27

View File

@@ -28,6 +28,28 @@ The name of the application. Overrides `package.json` `name`.
Graphical User Interface configuration options.
#### `pear.gui[platform] <Object>`
Platform specific options can be set by nesting options under the platform name. For example the following sets the macOS version to not be resizable:
```json
{
"pear": {
"gui": {
"darwin": {
"resizable": false
}
}
}
}
```
The following `platform`s are supported:
- `darwin`
- `linux`
- `win32`
#### `pear.gui.width <Number>`
Window width (pixels).
@@ -116,6 +138,10 @@ Set window opacity (0.0 - 1.0) (Windows, macOS).
Enable transparency. Must be set for opacity to work.
#### `pear.gui.hideable <Boolean>` (default: `false`)
Keep app running when all windows are closed.
#### `pear.gui.backgroundColor <String>` (default: "#000" non-transparent, "#00000000" transparent)
Background color (Hex, RGB, RGBA, HSL, HSLA, CSS color).