Theme Variables
Generated from @beautiful LDoc annotations in the SomeWM source. Last sync: 6393acb0e5. 443 documented, 76 used-but-undocumented.
See the Theme Tutorial for how to apply these in a custom theme.
Quick-Start Variables
The handful of variables every theme sets. Each is also listed in its module section below.
| Variable | Type | Description |
|---|---|---|
bg_normal | color | Default background |
fg_normal | color | Default text |
bg_focus | color | Background when focused |
fg_focus | color | Text when focused |
bg_urgent | color | Background for urgent items |
fg_urgent | color | Text for urgent items |
font | string | Default Pango font, e.g. "sans 10" |
border_width | number | Window border thickness in pixels |
border_color_normal | color | Unfocused window border |
border_color_active | color | Focused window border |
useless_gap | number | Gap between tiled windows |
wallpaper | string | Path to wallpaper image |
Cursors
Standard X cursor names like "left_ptr", "fleur", "cross", "watch" are accepted.
Cursor theme
Set the cursor theme via environment variables before launching:
export XCURSOR_THEME="Adwaita"
export XCURSOR_SIZE="24"
somewm
Or change it at runtime (SomeWM-only):
root.cursor_theme("Adwaita")
root.cursor_size(32)
awful
278 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
calendar_style | cell_properties | The generic calendar style table. Each table property can also be defined by beautiful.calendar_[flag]_[property]=val. | awful/widget/calendar_popup.lua:42 |
carousel_default_column_width | number | Default column width fraction for new columns. | awful/layout/suit/carousel.lua:45 |
carousel_peek_width | number | Peek width in pixels for showing adjacent column edges. | awful/layout/suit/carousel.lua:67 |
column_count | integer | The default number of columns. | awful/tag.lua:1452 |
cursor_mouse_move | string | The move cursor name. | awful/mouse/init.lua:82 |
cursor_mouse_resize | string | The resize cursor name. | awful/mouse/init.lua:78 |
enable_spawn_cursor | boolean | Show busy mouse cursor during spawn. | awful/startup_notification.lua:23 |
fullscreen_hide_border | boolean | Hide the border on fullscreen clients. | awful/permissions/init.lua:49 |
gap_single_client | boolean | Enable gaps for a single client. | awful/tag.lua:1186 |
hotkeys_bg | color | Hotkeys widget background color. | awful/hotkeys_popup/widget.lua:260 |
hotkeys_border_color | color | Hotkeys widget border color. | awful/hotkeys_popup/widget.lua:272 |
hotkeys_border_width | int | Hotkeys widget border width. | awful/hotkeys_popup/widget.lua:268 |
hotkeys_description_font | string|lgi.Pango.FontDescription | Font used for hotkeys' descriptions. | awful/hotkeys_popup/widget.lua:301 |
hotkeys_fg | color | Hotkeys widget foreground color. | awful/hotkeys_popup/widget.lua:264 |
hotkeys_font | string|lgi.Pango.FontDescription | Main hotkeys widget font. | awful/hotkeys_popup/widget.lua:297 |
hotkeys_group_margin | int | Margin between hotkeys groups. | awful/hotkeys_popup/widget.lua:305 |
hotkeys_label_bg | color | Background color used for miscellaneous labels of hotkeys widget. | awful/hotkeys_popup/widget.lua:285 |
hotkeys_label_fg | color | Foreground color used for hotkey groups and other labels. | awful/hotkeys_popup/widget.lua:289 |
hotkeys_modifiers_fg | color | Foreground color used for hotkey modifiers (Ctrl, Alt, Super, etc). | awful/hotkeys_popup/widget.lua:281 |
hotkeys_override_label_bgs | boolean | Override label background colors instead of cycling through xresources colors. | awful/hotkeys_popup/widget.lua:293 |
hotkeys_shape | gears.shape | Hotkeys widget shape. | awful/hotkeys_popup/widget.lua:276 |
layout_carousel | surface | The carousel layout layoutbox icon. | awful/layout/suit/carousel.lua:40 |
layout_cornerne | surface | The cornerne layout layoutbox icon. | awful/layout/suit/corner.lua:20 |
layout_cornernw | surface | The cornernw layout layoutbox icon. | awful/layout/suit/corner.lua:15 |
layout_cornerse | surface | The cornerse layout layoutbox icon. | awful/layout/suit/corner.lua:30 |
layout_cornersw | surface | The cornersw layout layoutbox icon. | awful/layout/suit/corner.lua:25 |
layout_dwindle | surface | The dwindle layout layoutbox icon. | awful/layout/suit/spiral.lua:21 |
layout_fairh | surface | The fairh layout layoutbox icon. | awful/layout/suit/fair.lua:13 |
layout_fairv | surface | The fairv layout layoutbox icon. | awful/layout/suit/fair.lua:18 |
layout_floating | surface | The floating layout layoutbox icon. | awful/layout/suit/floating.lua:16 |
layout_fullscreen | surface | The fullscreen layout layoutbox icon. | awful/layout/suit/max.lua:19 |
layout_magnifier | surface | The magnifier layout layoutbox icon. | awful/layout/suit/magnifier.lua:19 |
layout_max | surface | The max layout layoutbox icon. | awful/layout/suit/max.lua:14 |
layout_spiral | surface | The spiral layout layoutbox icon. | awful/layout/suit/spiral.lua:16 |
layout_tile | surface | The tile layout layoutbox icon. | awful/layout/suit/tile.lua:24 |
layout_tilebottom | surface | The tile bottom layout layoutbox icon. | awful/layout/suit/tile.lua:34 |
layout_tileleft | surface | The tile left layout layoutbox icon. | awful/layout/suit/tile.lua:39 |
layout_tiletop | surface | The tile top layout layoutbox icon. | awful/layout/suit/tile.lua:29 |
layoutlist_align | string | The selected layout alignment. | awful/widget/layoutlist.lua:243 |
layoutlist_bg_normal | string|pattern | The default background color. | awful/widget/layoutlist.lua:216 |
layoutlist_bg_selected | string|pattern | The selected layout background color. | awful/widget/layoutlist.lua:226 |
layoutlist_disable_icon | boolean | Disable the layout icons (only show the name label). | awful/widget/layoutlist.lua:231 |
layoutlist_disable_name | boolean | Disable the layout name label (only show the icon). | awful/widget/layoutlist.lua:235 |
layoutlist_fg_normal | string|pattern | The default foreground (text) color. | awful/widget/layoutlist.lua:210 |
layoutlist_fg_selected | string|pattern | The selected layout foreground (text) color. | awful/widget/layoutlist.lua:221 |
layoutlist_font | string | The layoutlist font. | awful/widget/layoutlist.lua:239 |
layoutlist_font_selected | string | The selected layout title font. | awful/widget/layoutlist.lua:247 |
layoutlist_shape | gears.shape | The default layoutlist elements shape. | awful/widget/layoutlist.lua:255 |
layoutlist_shape_border_color | string|color | The default layoutlist elements border color. | awful/widget/layoutlist.lua:263 |
layoutlist_shape_border_color_selected | string|color | The selected layout border color. | awful/widget/layoutlist.lua:276 |
layoutlist_shape_border_width | number | The default layoutlist elements border width. | awful/widget/layoutlist.lua:259 |
layoutlist_shape_border_width_selected | number | The selected layout border width. | awful/widget/layoutlist.lua:272 |
layoutlist_shape_selected | gears.shape | The selected layout shape. | awful/widget/layoutlist.lua:268 |
layoutlist_spacing | number | The space between the layouts. | awful/widget/layoutlist.lua:251 |
master_count | integer | The default number of master windows. | awful/tag.lua:1335 |
master_fill_policy | string | The default fill policy. ** Possible values**: * expand: Take all the space * master_width_factor: Only take the ratio defined by the master_width_factor | awful/tag.lua:1246 |
master_width_factor | number | The default master width factor | awful/tag.lua:700 |
maximized_hide_border | boolean | Hide the border on maximized clients. | awful/permissions/init.lua:53 |
maximized_honor_padding | boolean | Honor the screen padding when maximizing. | awful/permissions/init.lua:45 |
menu_bg_focus | color | The default focused item background color. | awful/menu.lua:81 |
menu_bg_normal | color | The default background color. | awful/menu.lua:91 |
menu_border_color | number | The menu item border color. | awful/menu.lua:68 |
menu_border_width | number | The menu item border width. | awful/menu.lua:72 |
menu_fg_focus | color | The default focused item foreground (text) color. | awful/menu.lua:76 |
menu_fg_normal | color | The default foreground (text) color. | awful/menu.lua:86 |
menu_font | string | The menu text font. | awful/menu.lua:55 |
menu_height | number | The item height. | awful/menu.lua:60 |
menu_submenu | string | The default sub-menu indicator if no menu_submenu_icon is provided. | awful/menu.lua:96 |
menu_submenu_icon | string|gears.surface | The icon used for sub-menus. | awful/menu.lua:51 |
menu_width | number | The default menu width. | awful/menu.lua:64 |
prompt_bg | color | The prompt background color. | awful/widget/prompt.lua:18 |
prompt_bg_cursor | color | The prompt cursor background color. | awful/prompt.lua:102 |
prompt_fg | color | The prompt foreground color. | awful/widget/prompt.lua:13 |
prompt_fg_cursor | color | The prompt cursor foreground color. | awful/prompt.lua:97 |
prompt_font | string | The prompt text font. | awful/prompt.lua:107 |
snap_bg | color|string|gradient|pattern | The snap outline background color. | awful/mouse/init.lua:62 |
snap_border_width | integer | The snap outline width. | awful/mouse/init.lua:66 |
snap_shape | function | The snap outline shape. | awful/mouse/init.lua:70 |
snapper_gap | number | The gap between snapped clients. | awful/mouse/init.lua:74 |
taglist_bg_empty | color | The tag list empty elements background color. | awful/widget/taglist.lua:97 |
taglist_bg_focus | color | The tag list main background color. | awful/widget/taglist.lua:72 |
taglist_bg_occupied | color | The tag list occupied elements background color. | awful/widget/taglist.lua:87 |
taglist_bg_urgent | color | The tag list urgent elements background color. | awful/widget/taglist.lua:82 |
taglist_bg_volatile | color | The tag list volatile elements background color. | awful/widget/taglist.lua:107 |
taglist_disable_icon | boolean | Do not display the tag icons, even if they are set. | awful/widget/taglist.lua:141 |
taglist_fg_empty | color | The tag list empty elements foreground (text) color. | awful/widget/taglist.lua:102 |
taglist_fg_focus | color | The tag list main foreground (text) color. | awful/widget/taglist.lua:67 |
taglist_fg_occupied | color | The tag list occupied elements foreground (text) color. | awful/widget/taglist.lua:92 |
taglist_fg_urgent | color | The tag list urgent elements foreground (text) color. | awful/widget/taglist.lua:77 |
taglist_fg_volatile | color | The tag list volatile elements foreground (text) color. | awful/widget/taglist.lua:112 |
taglist_font | string | The taglist font. | awful/widget/taglist.lua:145 |
taglist_shape | gears.shape | The main shape used for the elements. This will be the fallback for state specific shapes. To get a shape for the whole taglist, use wibox.container.background. | awful/widget/taglist.lua:153 |
taglist_shape_border_color | color | The elements shape border color. | awful/widget/taglist.lua:169 |
taglist_shape_border_color_empty | color | The empty elements shape border color. | awful/widget/taglist.lua:184 |
taglist_shape_border_color_focus | color | The selected elements shape border color. | awful/widget/taglist.lua:199 |
taglist_shape_border_color_urgent | color | The urgents elements shape border color. | awful/widget/taglist.lua:214 |
taglist_shape_border_color_volatile | color | The volatile elements shape border color. | awful/widget/taglist.lua:229 |
taglist_shape_border_width | number | The shape elements border width. | awful/widget/taglist.lua:164 |
taglist_shape_border_width_empty | number | The shape used for the empty elements border width. | awful/widget/taglist.lua:179 |
taglist_shape_border_width_focus | number | The shape used for the selected elements border width. | awful/widget/taglist.lua:194 |
taglist_shape_border_width_urgent | number | The shape used for the urgent elements border width. | awful/widget/taglist.lua:209 |
taglist_shape_border_width_volatile | number | The shape used for the volatile elements border width. | awful/widget/taglist.lua:224 |
taglist_shape_empty | gears.shape | The shape used for the empty elements. | awful/widget/taglist.lua:174 |
taglist_shape_focus | gears.shape | The shape used for the selected elements. | awful/widget/taglist.lua:189 |
taglist_shape_urgent | gears.shape | The shape used for the urgent elements. | awful/widget/taglist.lua:204 |
taglist_shape_volatile | gears.shape | The shape used for the volatile elements. | awful/widget/taglist.lua:219 |
taglist_spacing | number | The space between the taglist elements. | awful/widget/taglist.lua:149 |
taglist_squares_resize | boolean | If the background images can be resized. | awful/widget/taglist.lua:137 |
taglist_squares_sel | surface | The selected elements background image. | awful/widget/taglist.lua:117 |
taglist_squares_sel_empty | surface | The selected empty elements background image. | awful/widget/taglist.lua:127 |
taglist_squares_unsel | surface | The unselected elements background image. | awful/widget/taglist.lua:122 |
taglist_squares_unsel_empty | surface | The unselected empty elements background image. | awful/widget/taglist.lua:132 |
tasklist_above | string | Extra tasklist client property notification icon for clients with the above property set. | awful/widget/tasklist.lua:220 |
tasklist_align | string | The focused client alignment. | awful/widget/tasklist.lua:248 |
tasklist_below | string | Extra tasklist client property notification icon for clients with the below property set. | awful/widget/tasklist.lua:224 |
tasklist_bg_focus | string|pattern | The focused client background color. | awful/widget/tasklist.lua:133 |
tasklist_bg_image_focus | string | The focused client background image. | awful/widget/tasklist.lua:177 |
tasklist_bg_image_minimize | string | The minimized clients background image. | awful/widget/tasklist.lua:185 |
tasklist_bg_image_normal | string | The elements default background image. | awful/widget/tasklist.lua:173 |
tasklist_bg_image_urgent | string | The urgent clients background image. | awful/widget/tasklist.lua:181 |
tasklist_bg_minimize | string|pattern | The minimized clients background color. | awful/widget/tasklist.lua:165 |
tasklist_bg_normal | string|pattern | The default background color. | awful/widget/tasklist.lua:117 |
tasklist_bg_urgent | string|pattern | The urgent clients background color. | awful/widget/tasklist.lua:149 |
tasklist_disable_icon | boolean | Disable the tasklist client icons. | awful/widget/tasklist.lua:189 |
tasklist_disable_task_name | boolean | Disable the tasklist client titles. | awful/widget/tasklist.lua:196 |
tasklist_fg_focus | string|pattern | The focused client foreground (text) color. | awful/widget/tasklist.lua:125 |
tasklist_fg_minimize | string|pattern | The minimized clients foreground (text) color. | awful/widget/tasklist.lua:157 |
tasklist_fg_normal | string|pattern | The default foreground (text) color. | awful/widget/tasklist.lua:109 |
tasklist_fg_urgent | string|pattern | The urgent clients foreground (text) color. | awful/widget/tasklist.lua:141 |
tasklist_floating | string | Extra tasklist client property notification icon for clients with the floating property set. | awful/widget/tasklist.lua:228 |
tasklist_font | string | The tasklist font. | awful/widget/tasklist.lua:255 |
tasklist_font_focus | string | The focused client title alignment. | awful/widget/tasklist.lua:263 |
tasklist_font_minimized | string | The minimized clients font. | awful/widget/tasklist.lua:271 |
tasklist_font_urgent | string | The urgent clients font. | awful/widget/tasklist.lua:279 |
tasklist_icon_size | integer | The icon size. | awful/widget/tasklist.lua:382 |
tasklist_maximized | string | Extra tasklist client property notification icon for clients with the maximized property set. | awful/widget/tasklist.lua:232 |
tasklist_maximized_horizontal | string | Extra tasklist client property notification icon for clients with the maximized_horizontal property set. | awful/widget/tasklist.lua:236 |
tasklist_maximized_vertical | string | Extra tasklist client property notification icon for clients with the maximized_vertical property set. | awful/widget/tasklist.lua:240 |
tasklist_minimized | string | Extra tasklist client property notification icon for clients with the minimized property set. | awful/widget/tasklist.lua:244 |
tasklist_ontop | string | Extra tasklist client property notification icon for clients with the ontop property set. | awful/widget/tasklist.lua:216 |
tasklist_plain_task_name | boolean | Disable the extra tasklist client property notification icons. See the Status icons section for more details. | awful/widget/tasklist.lua:203 |
tasklist_shape | gears.shape | The default tasklist elements shape. | awful/widget/tasklist.lua:294 |
tasklist_shape_border_color | string|color | The default tasklist elements border color. | awful/widget/tasklist.lua:308 |
tasklist_shape_border_color_focus | string|color | The focused client border color. | awful/widget/tasklist.lua:330 |
tasklist_shape_border_color_minimized | string|color | The minimized clients border color. | awful/widget/tasklist.lua:352 |
tasklist_shape_border_color_urgent | string|color | The urgent clients border color. | awful/widget/tasklist.lua:374 |
tasklist_shape_border_width | number | The default tasklist elements border width. | awful/widget/tasklist.lua:301 |
tasklist_shape_border_width_focus | number | The focused client border width. | awful/widget/tasklist.lua:323 |
tasklist_shape_border_width_minimized | number | The minimized clients border width. | awful/widget/tasklist.lua:345 |
tasklist_shape_border_width_urgent | number | The urgent clients border width. | awful/widget/tasklist.lua:367 |
tasklist_shape_focus | gears.shape | The focused client shape. | awful/widget/tasklist.lua:316 |
tasklist_shape_minimized | gears.shape | The minimized clients shape. | awful/widget/tasklist.lua:338 |
tasklist_shape_urgent | gears.shape | The urgent clients shape. | awful/widget/tasklist.lua:360 |
tasklist_spacing | number | The space between the tasklist elements. | awful/widget/tasklist.lua:287 |
tasklist_sticky | string | Extra tasklist client property notification icon for clients with the sticky property set. | awful/widget/tasklist.lua:212 |
titlebar_bg | color | The titlebar background color. | awful/titlebar.lua:89 |
titlebar_bg_focus | color | The focused titlebar background color. | awful/titlebar.lua:107 |
titlebar_bg_normal | color | The titlebar background color. | awful/titlebar.lua:71 |
titlebar_bg_urgent | color | The urgent titlebar background color. | awful/titlebar.lua:125 |
titlebar_bgimage | gears.surface|string | The titlebar background image image. | awful/titlebar.lua:95 |
titlebar_bgimage_focus | gears.surface|string | The focused titlebar background image image. | awful/titlebar.lua:113 |
titlebar_bgimage_normal | gears.surface|string | The titlebar background image image. | awful/titlebar.lua:77 |
titlebar_bgimage_urgent | gears.surface|string | The urgent titlebar background image. | awful/titlebar.lua:131 |
titlebar_close_button_focus | gears.surface|string | The focused client close button image. | awful/titlebar.lua:227 |
titlebar_close_button_focus_hover | gears.surface|string | The hovered+focused close button image. | awful/titlebar.lua:233 |
titlebar_close_button_focus_press | gears.surface|string | The pressed+focused close button image. | awful/titlebar.lua:239 |
titlebar_close_button_normal | gears.surface|string | The normal close button image. | awful/titlebar.lua:167 |
titlebar_close_button_normal_hover | gears.surface|string | The hovered close button image. | awful/titlebar.lua:173 |
titlebar_close_button_normal_press | gears.surface|string | The pressed close button image. | awful/titlebar.lua:179 |
titlebar_fg | color | The titlebar foreground (text) color. | awful/titlebar.lua:83 |
titlebar_fg_focus | color | The focused titlebar foreground (text) color. | awful/titlebar.lua:101 |
titlebar_fg_normal | color | The titlebar foreground (text) color. | awful/titlebar.lua:65 |
titlebar_fg_urgent | color | The urgent titlebar foreground (text) color. | awful/titlebar.lua:119 |
titlebar_floating_button_focus | gears.surface|string | The focused client non-floating button image. | awful/titlebar.lua:197 |
titlebar_floating_button_focus_active | gears.surface|string | The floating+focused client button image. | awful/titlebar.lua:329 |
titlebar_floating_button_focus_active_hover | gears.surface|string | The hovered+floating+focused button image. | awful/titlebar.lua:335 |
titlebar_floating_button_focus_active_press | gears.surface|string | The pressed+floating+focused button image. | awful/titlebar.lua:341 |
titlebar_floating_button_focus_inactive | gears.surface|string | The inactive+focused+floating button image. | awful/titlebar.lua:473 |
titlebar_floating_button_focus_inactive_hover | gears.surface|string | The hovered+inactive+focused+floating button image. | awful/titlebar.lua:479 |
titlebar_floating_button_focus_inactive_press | gears.surface|string | The pressed+inactive+focused+floating button image. | awful/titlebar.lua:485 |
titlebar_floating_button_normal | gears.surface|string | The normal non-floating button image. | awful/titlebar.lua:137 |
titlebar_floating_button_normal_active | gears.surface|string | The normal floating button image. | awful/titlebar.lua:257 |
titlebar_floating_button_normal_active_hover | gears.surface|string | The hovered floating client button image. | awful/titlebar.lua:263 |
titlebar_floating_button_normal_active_press | gears.surface|string | The pressed floating client button image. | awful/titlebar.lua:269 |
titlebar_floating_button_normal_inactive | gears.surface|string | The inactive+floating button image. | awful/titlebar.lua:401 |
titlebar_floating_button_normal_inactive_hover | gears.surface|string | The hovered+inactive+floating button image. | awful/titlebar.lua:407 |
titlebar_floating_button_normal_inactive_press | gears.surface|string | The pressed+inactive+floating button image. | awful/titlebar.lua:413 |
titlebar_maximized_button_focus | gears.surface|string | The focused client non-maximized button image. | awful/titlebar.lua:203 |
titlebar_maximized_button_focus_active | gears.surface|string | The maximized+focused button image. | awful/titlebar.lua:347 |
titlebar_maximized_button_focus_active_hover | gears.surface|string | The hovered+maximized+focused button image. | awful/titlebar.lua:353 |
titlebar_maximized_button_focus_active_press | gears.surface|string | The pressed+maximized+focused button image. | awful/titlebar.lua:359 |
titlebar_maximized_button_focus_inactive | gears.surface|string | The inactive+focused+maximized button image. | awful/titlebar.lua:491 |
titlebar_maximized_button_focus_inactive_hover | gears.surface|string | The hovered+inactive+focused+maximized button image. | awful/titlebar.lua:497 |
titlebar_maximized_button_focus_inactive_press | gears.surface|string | The pressed+inactive+focused+maximized button image. | awful/titlebar.lua:503 |
titlebar_maximized_button_normal | gears.surface|string | The normal non-maximized button image. | awful/titlebar.lua:143 |
titlebar_maximized_button_normal_active | gears.surface|string | The maximized client button image. | awful/titlebar.lua:275 |
titlebar_maximized_button_normal_active_hover | gears.surface|string | The hozered+maximized client button image. | awful/titlebar.lua:281 |
titlebar_maximized_button_normal_active_press | gears.surface|string | The pressed+maximized button image. | awful/titlebar.lua:287 |
titlebar_maximized_button_normal_inactive | gears.surface|string | The inactive+maximized button image. | awful/titlebar.lua:419 |
titlebar_maximized_button_normal_inactive_hover | gears.surface|string | The hovered+inactive+maximized button image. | awful/titlebar.lua:425 |
titlebar_maximized_button_normal_inactive_press | gears.surface|string | The pressed+maximized+inactive button image. | awful/titlebar.lua:431 |
titlebar_minimize_button_focus | gears.surface|string | The focused client minimize button image. | awful/titlebar.lua:209 |
titlebar_minimize_button_focus_hover | gears.surface|string | The hovered+focused client minimize button image. | awful/titlebar.lua:215 |
titlebar_minimize_button_focus_press | gears.surface|string | The pressed+focused minimize button image. | awful/titlebar.lua:221 |
titlebar_minimize_button_normal | gears.surface|string | The normal minimize button image. | awful/titlebar.lua:149 |
titlebar_minimize_button_normal_hover | gears.surface|string | The hovered minimize button image. | awful/titlebar.lua:155 |
titlebar_minimize_button_normal_press | gears.surface|string | The pressed minimize button image. | awful/titlebar.lua:161 |
titlebar_ontop_button_focus | gears.surface|string | The focused client non-ontop button image. | awful/titlebar.lua:245 |
titlebar_ontop_button_focus_active | gears.surface|string | The ontop+focused button image. | awful/titlebar.lua:365 |
titlebar_ontop_button_focus_active_hover | gears.surface|string | The hovered+ontop+focused button image. | awful/titlebar.lua:371 |
titlebar_ontop_button_focus_active_press | gears.surface|string | The pressed+ontop+focused button image. | awful/titlebar.lua:377 |
titlebar_ontop_button_focus_inactive | gears.surface|string | The inactive+focused+ontop button image. | awful/titlebar.lua:509 |
titlebar_ontop_button_focus_inactive_hover | gears.surface|string | The hovered+inactive+focused+ontop button image. | awful/titlebar.lua:515 |
titlebar_ontop_button_focus_inactive_press | gears.surface|string | The pressed+inactive+focused+ontop button image. | awful/titlebar.lua:521 |
titlebar_ontop_button_normal | gears.surface|string | The normal non-ontop button image. | awful/titlebar.lua:185 |
titlebar_ontop_button_normal_active | gears.surface|string | The ontop button image. | awful/titlebar.lua:293 |
titlebar_ontop_button_normal_active_hover | gears.surface|string | The hovered+ontop client button image. | awful/titlebar.lua:299 |
titlebar_ontop_button_normal_active_press | gears.surface|string | The pressed+ontop client button image. | awful/titlebar.lua:305 |
titlebar_ontop_button_normal_inactive | gears.surface|string | The inactive+ontop button image. | awful/titlebar.lua:437 |
titlebar_ontop_button_normal_inactive_hover | gears.surface|string | The hovered+inactive+ontop button image. | awful/titlebar.lua:443 |
titlebar_ontop_button_normal_inactive_press | gears.surface|string | The pressed+inactive+ontop button image. | awful/titlebar.lua:449 |
titlebar_sticky_button_focus | gears.surface|string | The focused client sticky button image. | awful/titlebar.lua:251 |
titlebar_sticky_button_focus_active | gears.surface|string | The sticky+focused button image. | awful/titlebar.lua:383 |
titlebar_sticky_button_focus_active_hover | gears.surface|string | The hovered+sticky+focused button image. | awful/titlebar.lua:389 |
titlebar_sticky_button_focus_active_press | gears.surface|string | The pressed+sticky+focused button image. | awful/titlebar.lua:395 |
titlebar_sticky_button_focus_inactive | gears.surface|string | The inactive+focused+sticky button image. | awful/titlebar.lua:527 |
titlebar_sticky_button_focus_inactive_hover | gears.surface|string | The hovered+inactive+focused+sticky button image. | awful/titlebar.lua:533 |
titlebar_sticky_button_focus_inactive_press | gears.surface|string | The pressed+inactive+focused+sticky button image. | awful/titlebar.lua:539 |
titlebar_sticky_button_normal | gears.surface|string | The normal non-sticky button image. | awful/titlebar.lua:191 |
titlebar_sticky_button_normal_active | gears.surface|string | The sticky button image. | awful/titlebar.lua:311 |
titlebar_sticky_button_normal_active_hover | gears.surface|string | The hovered+sticky button image. | awful/titlebar.lua:317 |
titlebar_sticky_button_normal_active_press | gears.surface|string | The pressed+sticky client button image. | awful/titlebar.lua:323 |
titlebar_sticky_button_normal_inactive | gears.surface|string | The inactive+sticky button image. | awful/titlebar.lua:455 |
titlebar_sticky_button_normal_inactive_hover | gears.surface|string | The hovered+inactive+sticky button image. | awful/titlebar.lua:461 |
titlebar_sticky_button_normal_inactive_press | gears.surface|string | The pressed+inactive+sticky button image. | awful/titlebar.lua:467 |
titlebar_tooltip_align | string | The text horizontal alignment in tooltips. It is used as the align parameter passed to the awful.tooltip constructor function. Valid values are: * "right" * "top_right" * "left" * "bottom_left" * "top_left" * "bottom" * "top" | awful/titlebar.lua:619 |
titlebar_tooltip_delay_show | integer | The delay in second before the titlebar buttons tooltip is shown. It is used as the delay_show parameter passed to the awful.tooltip constructor function. | awful/titlebar.lua:595 |
titlebar_tooltip_margins_leftright | integer | The inner left and right margins for tooltip messages. It is used as the margins_leftright parameter passed to the awful.tooltip constructor function. | awful/titlebar.lua:601 |
titlebar_tooltip_margins_topbottom | integer | The inner top and bottom margins for the tooltip messages. It is used as the margins_topbottom parameter passed to the awful.tooltip constructor function. | awful/titlebar.lua:607 |
titlebar_tooltip_messages_close | string | The message in the close button tooltip. | awful/titlebar.lua:545 |
titlebar_tooltip_messages_floating_active | string | The message in the floating button tooltip when then client is floating. | awful/titlebar.lua:565 |
titlebar_tooltip_messages_floating_inactive | string | The message in the floating button tooltip when then client isn't floating. | awful/titlebar.lua:570 |
titlebar_tooltip_messages_maximized_active | string | The message in the maximize button tooltip when the client is maximized. | awful/titlebar.lua:555 |
titlebar_tooltip_messages_maximized_inactive | string | The message in the maximize button tooltip when the client is unmaximized. | awful/titlebar.lua:560 |
titlebar_tooltip_messages_minimize | string | The message in the minimize button tooltip. | awful/titlebar.lua:550 |
titlebar_tooltip_messages_ontop_active | string | The message in the onTop button tooltip when the client is onTop. | awful/titlebar.lua:575 |
titlebar_tooltip_messages_ontop_inactive | string | The message in the onTop button tooltip when client isn't onTop. | awful/titlebar.lua:580 |
titlebar_tooltip_messages_sticky_active | string | The message in the sticky button tooltip when the client is sticky. | awful/titlebar.lua:585 |
titlebar_tooltip_messages_sticky_inactive | string | The message in the sticky button tooltip when the client isn't sticky. | awful/titlebar.lua:590 |
titlebar_tooltip_timeout | number | The time in second before invoking the timer_function callback. It is used as the timeout parameter passed to the awful.tooltip constructor function. | awful/titlebar.lua:613 |
tooltip_align | string | The default tooltip alignment. | awful/tooltip.lua:276 |
tooltip_bg | color | The tooltip background color. | awful/tooltip.lua:92 |
tooltip_border_color | color | The tooltip border color. | awful/tooltip.lua:88 |
tooltip_border_width | number | The tooltip border width. | awful/tooltip.lua:104 |
tooltip_fg | color | The tooltip foregound (text) color. | awful/tooltip.lua:96 |
tooltip_font | string | The tooltip font. | awful/tooltip.lua:100 |
tooltip_gaps | table | The tooltip margins. | awful/tooltip.lua:112 |
tooltip_opacity | number | The tooltip opacity. | awful/tooltip.lua:108 |
tooltip_shape | gears.shape | The default tooltip shape. The default shape for all tooltips is a rectangle. However, by setting this variable they can default to rounded rectangle or stretched octagons. | awful/tooltip.lua:116 |
useless_gap | number | The default gap. | awful/tag.lua:1123 |
wallpaper_bg | color | The default wallpaper background color. | awful/wallpaper.lua:494 |
wallpaper_fg | gears.color | The default wallpaper foreground color. This is useful when using widgets or text in the wallpaper. A wallpaper created from a single image wont use this. | awful/wallpaper.lua:500 |
wibar_align | string | The wibar's alignments. | awful/wibar.lua:191 |
wibar_bg | color | The wibar's background color. | awful/wibar.lua:171 |
wibar_bgimage | surface | The wibar's background image. | awful/wibar.lua:175 |
wibar_border_color | string | The wibar border color. | awful/wibar.lua:143 |
wibar_border_width | integer | The wibar border width. | awful/wibar.lua:139 |
wibar_cursor | string | The wibar's mouse cursor. | awful/wibar.lua:151 |
wibar_favor_vertical | boolean | If there is both vertical and horizontal wibar, give more space to vertical ones. By default, if multiple wibars risk overlapping, it will be resolved by giving more space to the horizontal one: [image: wibar position] If this variable is to to true, it will behave like: | awful/wibar.lua:125 |
wibar_fg | color | The wibar's foreground (text) color. | awful/wibar.lua:179 |
wibar_height | integer | The wibar's height. | awful/wibar.lua:167 |
wibar_margins | number|table | The wibar's margins. | awful/wibar.lua:187 |
wibar_ontop | boolean | If the wibar is to be on top of other windows. | awful/wibar.lua:147 |
wibar_opacity | number | The wibar opacity, between 0 and 1. | awful/wibar.lua:155 |
wibar_shape | gears.shape | The wibar's shape. | awful/wibar.lua:183 |
wibar_stretch | boolean | If the wibar needs to be stretched to fill the screen. | awful/wibar.lua:106 |
wibar_type | string | The window type (desktop, normal, dock, …). | awful/wibar.lua:159 |
wibar_width | integer | The wibar's width. | awful/wibar.lua:163 |
wibox
66 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
arcchart_bg | gears.color | The radial background. | wibox/container/arcchart.lua:51 |
arcchart_border_color | color | The progressbar border background color. | wibox/container/arcchart.lua:23 |
arcchart_border_width | number | The progressbar border width. | wibox/container/arcchart.lua:31 |
arcchart_color | color | The progressbar foreground color. | wibox/container/arcchart.lua:27 |
arcchart_paddings | table|number | The padding between the outline and the progressbar. | wibox/container/arcchart.lua:35 |
arcchart_rounded_edge | boolean | If the chart has rounded edges. | wibox/container/arcchart.lua:47 |
arcchart_start_angle | number | The (radiant) angle where the first value start. | wibox/container/arcchart.lua:55 |
arcchart_thickness | number | The arc thickness. | wibox/container/arcchart.lua:43 |
bg_systray | string | The systray background color. | wibox/widget/systray.lua:35 |
calendar_empty_color | color | Set the color for the empty space where there are no date widgets. This happens when the month doesn't start on a Sunday or stop on a Saturday. | wibox/widget/calendar.lua:70 |
calendar_font | string | The calendar font. | wibox/widget/calendar.lua:45 |
calendar_long_weekdays | boolean | Format the weekdays with three characters instead of two | wibox/widget/calendar.lua:61 |
calendar_spacing | number | The calendar spacing. | wibox/widget/calendar.lua:49 |
calendar_start_sunday | boolean | Start the week on Sunday. | wibox/widget/calendar.lua:57 |
calendar_week_numbers | boolean | Display the calendar week numbers. | wibox/widget/calendar.lua:53 |
checkbox_bg | color | The outer (unchecked area) background color, pattern or gradient. | wibox/widget/checkbox.lua:28 |
checkbox_border_color | color | The outer (unchecked area) border color. | wibox/widget/checkbox.lua:33 |
checkbox_border_width | number | The outer (unchecked area) border width. | wibox/widget/checkbox.lua:23 |
checkbox_check_border_color | color | The checked part border color. | wibox/widget/checkbox.lua:38 |
checkbox_check_border_width | number | The checked part border width. | wibox/widget/checkbox.lua:43 |
checkbox_check_color | number | The checked part filling color. | wibox/widget/checkbox.lua:48 |
checkbox_check_shape | gears.shape|function | The checked part shape. If none is set, then the shape property will be used. | wibox/widget/checkbox.lua:59 |
checkbox_color | color | The checkbox color. This will be used for the unchecked part border color and the checked part filling color. Note that check_color and border_color have priority over this property. | wibox/widget/checkbox.lua:75 |
checkbox_paddings | table|number | The padding between the outline and the progressbar. | wibox/widget/checkbox.lua:66 |
checkbox_shape | gears.shape|function | The outer (unchecked area) shape. | wibox/widget/checkbox.lua:53 |
flex_height | boolean | Allow cells to have flexible height. Flexible height allow cells to adapt their height to fill the empty space at the bottom of the widget. | wibox/widget/calendar.lua:65 |
graph_bg | color | The graph background color. Used, when the background_color property isn't set. | wibox/widget/graph.lua:239 |
graph_border_color | color | The graph border color. Used, when the border_color property isn't set. | wibox/widget/graph.lua:245 |
graph_fg | color | The graph foreground color Used, when the color property isn't set. | wibox/widget/graph.lua:233 |
piechart_border_color | color | The border color. If none is set, it will use current foreground (text) color. | wibox/widget/piechart.lua:193 |
piechart_border_width | number | The pie elements border width. | wibox/widget/piechart.lua:207 |
piechart_colors | table | The pie chart colors. If no color is set, only the border will be drawn. If less colors than required are set, colors will be re-used in order. | wibox/widget/piechart.lua:212 |
progressbar_bar_border_color | color | The progressbar bar border color. | wibox/widget/progressbar.lua:249 |
progressbar_bar_border_width | number | The progressbar bar border width. | wibox/widget/progressbar.lua:244 |
progressbar_bar_shape | gears.shape | The progressbar inner shape. | wibox/widget/progressbar.lua:238 |
progressbar_bg | color | The progressbar background color. | wibox/widget/progressbar.lua:212 |
progressbar_border_color | color | The progressbar border color. | wibox/widget/progressbar.lua:228 |
progressbar_border_width | number | The progressbar outer border width. | wibox/widget/progressbar.lua:233 |
progressbar_fg | color | The progressbar foreground color. | wibox/widget/progressbar.lua:217 |
progressbar_margins | (table|number|nil) | The progressbar margins. Note that if the clip is disabled, this allows the background to be smaller than the bar. | wibox/widget/progressbar.lua:313 |
progressbar_paddings | (table|number|nil) | The progressbar padding. Note that if the clip is disabled, this allows the bar to be taller than the background. | wibox/widget/progressbar.lua:327 |
progressbar_shape | shape | The progressbar shape. | wibox/widget/progressbar.lua:222 |
radialprogressbar_border_color | color | The progressbar border background color. | wibox/container/radialprogressbar.lua:25 |
radialprogressbar_border_width | number | The progressbar border width. | wibox/container/radialprogressbar.lua:35 |
radialprogressbar_color | color | The progressbar foreground color. | wibox/container/radialprogressbar.lua:30 |
radialprogressbar_paddings | table|number | The padding between the outline and the progressbar. | wibox/container/radialprogressbar.lua:40 |
separator_border_color | color | The separator border color. | wibox/widget/separator.lua:107 |
separator_border_width | number | The separator border width. | wibox/widget/separator.lua:112 |
separator_color | color | The separator's color. | wibox/widget/separator.lua:121 |
separator_shape | shape | The separator's shape. | wibox/widget/separator.lua:126 |
separator_span_ratio | number | The relative percentage covered by the bar. | wibox/widget/separator.lua:117 |
separator_thickness | number | The separator thickness. | wibox/widget/separator.lua:102 |
slider_bar_active_color | color | The bar (active) color. Only works when both beautiful.slider_bar_color and beautiful.slider_bar_active_color are hex color strings | wibox/widget/slider.lua:278 |
slider_bar_border_color | color | The bar (background) border color. | wibox/widget/slider.lua:204 |
slider_bar_border_width | number | The bar (background) border width. | wibox/widget/slider.lua:199 |
slider_bar_color | color | The bar (background) color. | wibox/widget/slider.lua:273 |
slider_bar_height | number | The bar (background) height. | wibox/widget/slider.lua:250 |
slider_bar_margins | table | The bar (background) margins. | wibox/widget/slider.lua:255 |
slider_bar_shape | gears.shape | The bar (background) shape. | wibox/widget/slider.lua:244 |
slider_handle_border_color | color | The handle border_color. | wibox/widget/slider.lua:209 |
slider_handle_border_width | number | The handle border width. | wibox/widget/slider.lua:214 |
slider_handle_color | color | The handle color. | wibox/widget/slider.lua:224 |
slider_handle_cursor | string | The cursor icon while grabbing the handle. The available cursor names are: | wibox/widget/slider.lua:235 |
slider_handle_margins | table | The slider handle margins. | wibox/widget/slider.lua:264 |
slider_handle_shape | gears.shape | The handle shape. | wibox/widget/slider.lua:229 |
slider_handle_width | number | The handle width. | wibox/widget/slider.lua:219 |
naughty
47 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
notification_action_bg_normal | color | The background color for normal actions. | naughty/list/actions.lua:91 |
notification_action_bg_selected | color | The background color for selected actions. | naughty/list/actions.lua:96 |
notification_action_bgimage_normal | gears.surface|string | The background image for normal actions. | naughty/list/actions.lua:111 |
notification_action_bgimage_selected | gears.surface|string | The background image for selected actions. | naughty/list/actions.lua:116 |
notification_action_fg_normal | color | The foreground color for normal actions. | naughty/list/actions.lua:101 |
notification_action_fg_selected | color | The foreground color for selected actions. | naughty/list/actions.lua:106 |
notification_action_icon_only | boolean | Whether or not the action label should be shown. | naughty/list/actions.lua:47 |
notification_action_icon_size_normal | number | The action icon size. | naughty/list/actions.lua:83 |
notification_action_icon_size_selected | number | The selected action icon size. | naughty/list/actions.lua:87 |
notification_action_label_only | boolean | Whether or not the action icon should be shown. | naughty/list/actions.lua:51 |
notification_action_shape_border_color_normal | color | The shape border color for normal actions. | naughty/list/actions.lua:65 |
notification_action_shape_border_color_selected | color | The shape border color for selected actions. | naughty/list/actions.lua:70 |
notification_action_shape_border_width_normal | number | The shape border width for normal actions. | naughty/list/actions.lua:75 |
notification_action_shape_border_width_selected | number | The shape border width for selected actions. | naughty/list/actions.lua:79 |
notification_action_shape_normal | gears.shape | The shape used for a normal action. | naughty/list/actions.lua:55 |
notification_action_shape_selected | gears.shape | The shape used for a selected action. | naughty/list/actions.lua:60 |
notification_action_underline_normal | boolean | Whether or not to underline the action name. | naughty/list/actions.lua:39 |
notification_action_underline_selected | boolean | Whether or not to underline the selected action name. | naughty/list/actions.lua:43 |
notification_bg | color | Notifications background color. | naughty/notification.lua:37 |
notification_bg_normal | color | The background color for normal notifications. | naughty/list/notifications.lua:61 |
notification_bg_selected | color | The background color for selected notifications. | naughty/list/notifications.lua:66 |
notification_bgimage_normal | string|gears.surface | The background image for normal notifications. | naughty/list/notifications.lua:81 |
notification_bgimage_selected | string|gears.surface | The background image for selected notifications. | naughty/list/notifications.lua:86 |
notification_border_color | color | Notifications border color. | naughty/notification.lua:49 |
notification_border_width | int | Notifications border width. | naughty/notification.lua:45 |
notification_fg | color | Notifications foreground color. | naughty/notification.lua:41 |
notification_fg_normal | color | The foreground color for normal notifications. | naughty/list/notifications.lua:71 |
notification_fg_selected | color | The foreground color for selected notifications. | naughty/list/notifications.lua:76 |
notification_font | string|lgi.Pango.FontDescription | Notifications font. | naughty/notification.lua:33 |
notification_height | int | Notifications height. | naughty/notification.lua:70 |
notification_icon_resize_strategy | number | The default way to resize the icon. | naughty/widget/icon.lua:28 |
notification_icon_size | number | The default notification icon size. | naughty/widget/icon.lua:135 |
notification_icon_size_normal | number | The notification icon size. | naughty/list/notifications.lua:53 |
notification_icon_size_selected | number | The selected notification icon size. | naughty/list/notifications.lua:57 |
notification_margin | int | The margins inside of the notification widget (or popup). | naughty/notification.lua:62 |
notification_max_width | number | The maximum notification width. | naughty/layout/box.lua:149 |
notification_opacity | int | Notifications opacity. | naughty/notification.lua:58 |
notification_position | string | The maximum notification position. Valid values are: * top_left * top_middle * top_right * bottom_left * bottom_middle * bottom_right | naughty/layout/box.lua:153 |
notification_shape | gears.shape | Notifications shape. | naughty/notification.lua:53 |
notification_shape_border_color_normal | color | The shape border color for normal notifications. | naughty/list/notifications.lua:35 |
notification_shape_border_color_selected | color | The shape border color for selected notifications. | naughty/list/notifications.lua:40 |
notification_shape_border_width_normal | number | The shape border width for normal notifications. | naughty/list/notifications.lua:45 |
notification_shape_border_width_selected | number | The shape border width for selected notifications. | naughty/list/notifications.lua:49 |
notification_shape_normal | gears.shape | The shape used for a normal notification. | naughty/list/notifications.lua:25 |
notification_shape_selected | gears.shape | The shape used for a selected notification. | naughty/list/notifications.lua:30 |
notification_spacing | number | The spacing between the notifications. | naughty/notification.lua:74 |
notification_width | int | Notifications width. | naughty/notification.lua:66 |
menubar
7 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
menubar_bg_focus | color | Menubar selected item background color. | menubar/init.lua:69 |
menubar_bg_normal | color | Menubar normal background color. | menubar/init.lua:53 |
menubar_border_color | color | Menubar border color. | menubar/init.lua:61 |
menubar_border_width | number | Menubar border width. | menubar/init.lua:57 |
menubar_fg_focus | color | Menubar selected item text color. | menubar/init.lua:65 |
menubar_fg_normal | color | Menubar normal text color. | menubar/init.lua:49 |
menubar_font | font | Menubar font. | menubar/init.lua:73 |
root
12 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
awesome_icon | string|gears.surface | The Awesome icon path. | beautiful/init.lua:142 |
bg_focus | color | The default focused element background color. | beautiful/init.lua:105 |
bg_minimize | color | The default minimized element background color. | beautiful/init.lua:113 |
bg_normal | color | The default background color. The background color can be transparent. If there is a compositing manager such as compton, then it will be real transparency and may include blur (provided by the compositor). When there is no compositor, it will take a picture of the wallpaper and blend it. | beautiful/init.lua:94 |
bg_urgent | color | The default urgent element background color. | beautiful/init.lua:109 |
fg_focus | color | The default focused element foreground (text) color. | beautiful/init.lua:121 |
fg_minimize | color | The default minimized element foreground (text) color. | beautiful/init.lua:129 |
fg_normal | color | The default focused element foreground (text) color. | beautiful/init.lua:117 |
fg_urgent | color | The default urgent element foreground (text) color. | beautiful/init.lua:125 |
font | string | The default font. | beautiful/init.lua:90 |
icon_theme | string | The icon theme name. It has to be a directory in /usr/share/icons or an XDG icon folder. | beautiful/init.lua:137 |
wallpaper | string|gears.surface | The wallpaper path. | beautiful/init.lua:133 |
SomeWM Extensions
33 entries.
| Variable | Type | Description | Source |
|---|---|---|---|
screenshot_frame_color | color | The screenshot interactive frame color. | awful/screenshot.lua:78 |
screenshot_frame_shape | shape | The screenshot interactive frame shape. | awful/screenshot.lua:82 |
systray_hover_bg | string | The hover background color. | wibox/widget/systray_icon.lua:50 |
systray_hover_scale | number | The hover scale factor. | wibox/widget/systray_icon.lua:46 |
systray_icon_change_triggers_urgent | boolean | Whether icon changes trigger urgent styling. When an app changes its icon (e.g., Slack adding a notification badge), this triggers urgent styling instead. Best used with icon_override to show a clean icon while still getting notification indicators. | wibox/widget/systray_icon.lua:157 |
systray_icon_spacing | integer | The systray icon spacing. | wibox/widget/systray.lua:45 |
systray_icon_style | function|table | Per-icon style overrides. Can be a function that receives the systray_item and returns a style table, or a table mapping item.id or item.app_name to style tables. Style tables can contain: - icon_override: path to custom icon - hover_scale: scale on hover - hover_bg: background color on hover - urgent_bg: background color when urgent - urgent_color: urgent indicator color - urgent_outline_color: urgent indicator outline - urgent_style: "dot", "ring", "glow", or "none" - urgent_position: "top_right", "top_left", "bottom_right", "bottom_left" - urgent_size: number, ratio if <= 1, pixels if > 1 - urgent_shape: gears.shape function (default: gears.shape.circle) - icon_change_triggers_urgent: boolean, icon changes trigger urgent - overlay_triggers_urgent: boolean, overlay presence triggers urgent styling - overlay_position: "bottom_right", "bottom_left", "top_right", "top_left" - overlay_size: number, ratio if <= 1, pixels if > 1 - overlay_bg: background color for overlay - overlay_shape: "circle", "rounded_rect", "rect" - overlay_padding: padding around overlay within background | wibox/widget/systray_icon.lua:54 |
systray_max_rows | integer | The maximum number of rows for systray icons. | wibox/widget/systray.lua:40 |
systray_menu_bg_focus | string | Context menu focused background color. | wibox/widget/systray_icon.lua:92 |
systray_menu_bg_normal | string | Context menu background color. | wibox/widget/systray_icon.lua:84 |
systray_menu_border_color | string | Context menu border color. | wibox/widget/systray_icon.lua:96 |
systray_menu_border_width | number | Context menu border width. | wibox/widget/systray_icon.lua:100 |
systray_menu_callback | function | Context menu callback for customization. Called with (item, menu_items) before showing menu. Can modify menu_items. | wibox/widget/systray_icon.lua:116 |
systray_menu_fg_focus | string | Context menu focused foreground color. | wibox/widget/systray_icon.lua:88 |
systray_menu_fg_normal | string | Context menu foreground color. | wibox/widget/systray_icon.lua:80 |
systray_menu_font | string | Context menu font. | wibox/widget/systray_icon.lua:104 |
systray_menu_height | number | Context menu height. | wibox/widget/systray_icon.lua:112 |
systray_menu_width | number | Context menu width. | wibox/widget/systray_icon.lua:108 |
systray_overlay_bg | string | Background color for overlay icons. Draws a background shape behind the overlay icon for better visibility. | wibox/widget/systray_icon.lua:144 |
systray_overlay_padding | number | Padding around overlay icon within its background. | wibox/widget/systray_icon.lua:153 |
systray_overlay_position | string | The position of overlay icons on systray items. | wibox/widget/systray_icon.lua:133 |
systray_overlay_shape | string | Shape for overlay background. | wibox/widget/systray_icon.lua:149 |
systray_overlay_size | number | The size of overlay icons relative to the main icon. If value is <= 1, treated as a ratio (e.g., 0.33 = 33% of icon size). If value is > 1, treated as absolute pixels. | wibox/widget/systray_icon.lua:138 |
systray_overlay_triggers_urgent | boolean | Whether overlay presence triggers urgent styling. When true, icons with an overlay will be rendered with urgent styling even if their status is not "NeedsAttention". | wibox/widget/systray_icon.lua:127 |
systray_paddings | integer | The systray paddings (space around icons). | wibox/widget/systray.lua:50 |
systray_show_overlay | boolean | Whether to show overlay icons. Overlay icons are small badges displayed on top of the main icon, typically used to show status (like number of notifications). | wibox/widget/systray_icon.lua:121 |
systray_urgent_bg | string | The urgent background color. Shown when the systray item status is "NeedsAttention". Similar to AwesomeWM's bg_urgent for clients/tags. | wibox/widget/systray_icon.lua:28 |
systray_urgent_color | string | The urgent indicator color. | wibox/widget/systray_icon.lua:34 |
systray_urgent_outline_color | string | The urgent indicator outline color. | wibox/widget/systray_icon.lua:38 |
systray_urgent_position | string | Position of urgent indicators (dot style). | wibox/widget/systray_icon.lua:164 |
systray_urgent_shape | function | Shape function for urgent indicators. Used with "dot" and "ring" styles. Receives (cr, width, height). | wibox/widget/systray_icon.lua:175 |
systray_urgent_size | number | Size of urgent indicator dot. If value is <= 1, treated as a ratio of icon size. If value is > 1, treated as absolute pixels. | wibox/widget/systray_icon.lua:169 |
systray_urgent_style | string | The urgent indicator style. | wibox/widget/systray_icon.lua:42 |
Undocumented (Used in Code)
76 theme variables are read in source but lack an @beautiful annotation. These work, but their type and intended values are not formally documented. Filing upstream PRs to add LDoc is welcome.
See Also
- Theme Tutorial – Build a custom theme
- Key Names – Common keybinding key names
- beautiful (AwesomeWM upstream docs) – Full upstream API