From b011d81d274a8c1f7dcb6b9a3006c4742f50dc05 Mon Sep 17 00:00:00 2001 From: Sean Zellmer Date: Fri, 14 Feb 2025 02:35:21 -0600 Subject: [PATCH] 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 --- reference/pear/configuration.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/reference/pear/configuration.md b/reference/pear/configuration.md index 9de8f02..96a795d 100644 --- a/reference/pear/configuration.md +++ b/reference/pear/configuration.md @@ -28,6 +28,28 @@ The name of the application. Overrides `package.json` `name`. Graphical User Interface configuration options. +#### `pear.gui[platform] ` + +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 ` 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 ` (default: `false`) + +Keep app running when all windows are closed. + #### `pear.gui.backgroundColor ` (default: "#000" non-transparent, "#00000000" transparent) Background color (Hex, RGB, RGBA, HSL, HSLA, CSS color).