From fcb98e6523e7651735d52bc342104a82d7d5a09b Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Mon, 10 Jul 2023 20:45:53 +1000 Subject: [PATCH] [v3] Update docs --- v3/STATUS.md | 38 +++++++++++++++++++------------------- v3/V3 Changes.md | 15 ++++++++++++++- 2 files changed, 33 insertions(+), 20 deletions(-) diff --git a/v3/STATUS.md b/v3/STATUS.md index 31cce3fbe..aa190a42f 100644 --- a/v3/STATUS.md +++ b/v3/STATUS.md @@ -377,25 +377,25 @@ Note: things are currently not working after the refactor ## Examples -| Example | Windows | Linux | Mac | -|--------------|--------------------------------------------------------|-------|-----| -| binding | NO | | | -| build | Yes (Debug + Prod) | | | -| clipboard | Yes | | | -| contextmenus | Yes | | | -| dialogs | Almost | | | -| drag-n-drop | NO | | | -| events | NO | | | -| frameless | Needs resizing | | | -| kitchensink | Yes | | | -| menu | Yes | | | -| plain | Yes | | | -| plugins | Needs StartAtLogin | | | -| screen | Yes | | | -| systray | Yes | | | -| window | Size of initial window not right with application menu | | | -| windowjs | Example not complete | | | -| wml | Yes | | | +| Example | Windows | Linux | Mac | +|--------------|----------------------|-------|-----| +| binding | NO | | | +| build | Yes (Debug + Prod) | | | +| clipboard | Yes | | | +| contextmenus | Yes | | | +| dialogs | Almost | | | +| drag-n-drop | NO | | | +| events | NO | | | +| frameless | Yes | | | +| kitchensink | Yes | | | +| menu | Yes | | | +| plain | Yes | | | +| plugins | Yes | | | +| screen | Yes | | | +| systray | Yes | | Yes | +| window | Yes | | | +| windowjs | Example not complete | | | +| wml | Yes | | | # Alpha Release TODO diff --git a/v3/V3 Changes.md b/v3/V3 Changes.md index e3a9830f0..3f5cfeedf 100644 --- a/v3/V3 Changes.md +++ b/v3/V3 Changes.md @@ -128,6 +128,18 @@ This attribute specifies which javascript event should trigger the action. The d ``` + +## Systray + +Wails 3 comes with a built-in systray. This is a fully featured systray that has been designed to be as simple as possible to use. +It is possible to set the icon, tooltip and menu of the systray. It is possible to also "attach" a window to the systray. Doing this will provide the following functionality: + +- Clicking the systray icon with toggle the window visibility +- Right-clicking the systray will open the menu, if there is one + +On macOS, if there is no attached window, the systray will use the default method of displaying the menu (any button). +If there is an attached window but no menu, the systray will toggle the window regardless of the button pressed. + ## Plugins Plugins are a way to extend the functionality of your Wails application. @@ -254,4 +266,5 @@ handle this. The `--webkit-app-region` attribute can be set to any of the follow - `no-drag` - The element cannot be used to drag the window We would have ideally liked to use `app-region`, however this is not supported by the `getComputedStyle` call on -webkit on macOS. \ No newline at end of file +webkit on macOS. +