mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 22:44:21 +01:00
Pear release 1.11.1 docs (#169)
* Add `data` cli command & info about `apps` subcommand * Add `pear reset` cli command for resetting a Pear application Added a warning in the description as the command can result in lost data and users should be cautious when using it. * Remove leading spaces for `data` command flags * Add note about dumping paths from `pear://` links in `dump` command * Add `Pear.tray()` to Pear API docs * Add supported formats for tray icon * Remove `--unsafe-clear-preferences` from `pear run` cli doc * Add `pear.gui.name` config option * Edit new documentation for grammar & formatting * Clarify `pear.gui.name` is an override & doesnt have a default * Remove using "you" in `pear dump` doc & Correct grammar in `Pear.tray()` Co-authored-by: David Mark Clements <huperekchunow@googlemail.com> * Reword `pear reset` to make warning explicit * Add note about hidden app issues when linux doesn't support `Pear.tray()` --------- Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
This commit is contained in:
@@ -50,6 +50,10 @@ The following `platform`s are supported:
|
||||
- `linux`
|
||||
- `win32`
|
||||
|
||||
### `pear.gui.name <String>`
|
||||
|
||||
Override the app name which otherwise defaults to [name](#pear.name-less-than-string-greater-than).
|
||||
|
||||
#### `pear.gui.width <Number>`
|
||||
|
||||
Window width (pixels).
|
||||
@@ -142,6 +146,8 @@ Enable transparency. Must be set for opacity to work.
|
||||
|
||||
Keep app running when all windows are closed.
|
||||
|
||||
WARNING: Linux tray support varies which can cause scenarios where the application's tray doesn't work and closing the app will be hidden and inaccessible. Using a tray and `hideable` on Linux is not recommended.
|
||||
|
||||
#### `pear.gui.backgroundColor <String>` (default: "#000" non-transparent, "#00000000" transparent)
|
||||
|
||||
Background color (Hex, RGB, RGBA, HSL, HSLA, CSS color).
|
||||
|
||||
Reference in New Issue
Block a user