Skip to content
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

Pear release 1.10.0 docs #165

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Pear release 1.10.0 docs #165

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cc0ce53
Add `pear.gui.hideable` configuration option
lejeunerenard Jan 30, 2025
9cc6dea
Add note about platform specific `gui` options
lejeunerenard Jan 31, 2025
d180034
Tweak platform list text to show connection w/ header
lejeunerenard Jan 31, 2025
8ca30e9
Clean up line breaks in gui platform config section
lejeunerenard Jan 31, 2025
a519dbe
Remove platforms not supported by electron in GUI config section
lejeunerenard Jan 31, 2025
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
26 changes: 26 additions & 0 deletions reference/pear/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down