update docs

This commit is contained in:
Ryan Thomas 2022-02-14 13:40:47 -05:00
parent 37652de99e
commit 88c772ed86
1 changed files with 13 additions and 0 deletions

View File

@ -24,6 +24,8 @@ Configure by overriding systray_hints table values after the require statement.
systray_hints.default_button = 1 systray_hints.default_button = 1
systray_hints.mouse_buttons = { "h", "j", "l" } systray_hints.mouse_buttons = { "h", "j", "l" }
By default, systray_hints looks for `s.systray` in `s.mywibox`. If your systray widget or wibox has a different name, set `systray_hints.systray` or `systray_hints.wibox` accordingly.
If the system tray is normally hidden in your environment and toggled as needed with a keybinding, you can replace that keybinding with something like this: If the system tray is normally hidden in your environment and toggled as needed with a keybinding, you can replace that keybinding with something like this:
awful.key({ modkey }, "s", function () awful.key({ modkey }, "s", function ()
@ -56,6 +58,17 @@ If your system tray is always displayed, simply create a keybinding like the fol
end, {description="toggle systray hints", group="awesome"}), end, {description="toggle systray hints", group="awesome"}),
# Theme
Set custom colors in `theme.lua` as desired:
theme.systray_hints_font = "Iosevka Bold 16"
theme.systray_hints_fg = "#fdf6e3"
theme.systray_hints_bg = "#55465a"
theme.systray_hints_bg_highlight = "#aa53aa"
theme.systray_hints_bg_highlight_alt = "#426f5a"
theme.systray_hints_border = "#fdf6e333"
# Issues # Issues
The ability to obtain the geometry of the system tray is not referenced in the awesome API for a reason; in theory it may occasionally return incorrect data, requiring an additional execution of the keybinding. The ability to obtain the geometry of the system tray is not referenced in the awesome API for a reason; in theory it may occasionally return incorrect data, requiring an additional execution of the keybinding.