From 8fea20806e7735a5d480a9a69b9b7966b2f5f2e4 Mon Sep 17 00:00:00 2001 From: streetturtle Date: Thu, 12 Dec 2019 22:39:16 -0500 Subject: add readme for the calendar widget --- calendar-widget/README.md | 28 ++++++++++++++++++++++++++++ calendar-widget/calendar_top.png | Bin 0 -> 65350 bytes calendar-widget/calendar_top_right.png | Bin 0 -> 133425 bytes 3 files changed, 28 insertions(+) create mode 100644 calendar-widget/README.md create mode 100644 calendar-widget/calendar_top.png create mode 100644 calendar-widget/calendar_top_right.png (limited to 'calendar-widget') diff --git a/calendar-widget/README.md b/calendar-widget/README.md new file mode 100644 index 0000000..a7d1561 --- /dev/null +++ b/calendar-widget/README.md @@ -0,0 +1,28 @@ +# 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](./calendar_top.png) + +Top right placement: + +![calendar_top_right](./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 need 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) +``` \ No newline at end of file diff --git a/calendar-widget/calendar_top.png b/calendar-widget/calendar_top.png new file mode 100644 index 0000000..3e6b66b Binary files /dev/null and b/calendar-widget/calendar_top.png differ diff --git a/calendar-widget/calendar_top_right.png b/calendar-widget/calendar_top_right.png new file mode 100644 index 0000000..4a29022 Binary files /dev/null and b/calendar-widget/calendar_top_right.png differ -- cgit v1.2.3