VTray

NOTE This library is still in development and is not ready for production use.

VTray is a cross-platform V library to place an icon and menu in the notification area.

Features

• Create a tray
• Custom icon for tray
• Add tooltip.
• Add an on click event listener
• Supported on Windows
• Supported on Linux
• Supported on MacOS
• Menu items can be checked/unchecked
• Menu items can be enabled/disabled
• Dynamically update icon
• Dynamically update tooltip
• Allow menus to have their own icons
• Allow submenus within menus

NOTE Struct definitions and functions can be found here

Requirements

For Linux you will need the following packages installed:

sudo apt-get install libayatana-appindicator3-dev
sudo apt-get install libgtk-3-dev
sudo apt-get install pkg-config

For MacOS the tray icon size must be 22x22 pixels in order for it to render correctly.

I have only tested this using GCC, so I am not sure if it will work with other compilers.

Example

module main

import ouri028.vtray

fn main() {
    icon := $if macos {
        '${@VMODROOT}/assets/icon.png'
    } $else {
        '${@VMODROOT}/assets/icon.ico'
    }
    mut tray := vtray.create(icon, tooltip: 'VTray Demo!')
    tray.add_item('Edit',
        checkable: true
        on_click: fn [tray] (item &vtray.MenuItem) {
            println(item)
            if item.checked {
                tray.set_icon('${@VMODROOT}/assets/test.ico')
            } else {
                tray.set_icon('${@VMODROOT}/assets/icon.ico')
            }
        }
    )
    tray.add_item('Copy',
        on_click: fn [tray] () {
            tray.set_tooltip('Copied!')
        }
    )
    tray.add_item('Quit', on_click: tray.destroy)
    tray.run()
    tray.destroy()
}

Windows 11

Linux

MacOS

License

MIT License

Copyright (c) 2023 Sylvester Stephenson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.