awesome-wm-widgets/_widgets/calendar-widget.md

31 lines
1.1 KiB
Markdown
Raw Normal View History

2019-12-15 21:38:54 +01:00
---
layout: page
---
# Calendar Widget
Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.calendar`. Also supports mouse scroll up/down in order ot switch month - scroll up - shows next month, scroll down - previous.
Top center placement:
![calendar_top](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/calendar_top.png)
Top right placement:
![calendar_top_right](../awesome-wm-widgets/assets/img/screenshots/calendar-widget/calendar_top_right.png)
The placement is setup in theme.lua by `calendar_placement` variable, currently supported `top` (default), `top_right`, `bottom_right`.
# How to use
This widget needs an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate!
```lua
local calendar_widget = require("awesome-wm-widgets.calendar-widget.calendar")
-- ...
-- Create a textclock widget
mytextclock = wibox.widget.textclock()
mytextclock:connect_signal("button::press",
function(_, _, _, button)
if button == 1 then calendar_widget.toggle() end
end)
```