summaryrefslogtreecommitdiff
path: root/calendar-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2021-11-19 20:24:58 -0500
committerGitHub <noreply@github.com>2021-11-19 20:24:58 -0500
commit050f328c321c0d9fc585a63452bb830e20ce62a0 (patch)
tree6085c920d06ac19a0193d147d84fc9ace134cd1d /calendar-widget/README.md
parent2fae9e01a7e007f7fe8fc36c6676d79f160c3198 (diff)
parent80f6bb2c05f7b3fc81c0b8c881e7f52bdc88c00a (diff)
Merge pull request #312 from miselico/master
Added the option to customize te mousebuttons for going to the previous and next month
Diffstat (limited to 'calendar-widget/README.md')
-rw-r--r--calendar-widget/README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/calendar-widget/README.md b/calendar-widget/README.md
index 3d878bf..c7b46e2 100644
--- a/calendar-widget/README.md
+++ b/calendar-widget/README.md
@@ -4,7 +4,6 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.
## Features
- - mouse support: scroll up - shows next month, scroll down - previous
- themes:
| Name | Screenshot |
@@ -30,6 +29,23 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget.
![calendar_bottom_right](./calendar_bottom_right.png)
+ - mouse support:
+ move to the next and previous month. Using mouse buttons or scroll wheel.
+
+ You can configure this by specifying the button to move to next/previous.
+ Usually these are configured as follows. If you want to use other mouse buttons, you can find their number using `xev`.
+
+ | number | button |
+ |--------|--------|
+ | 4 | scroll up |
+ | 5 | scroll down |
+ | 1 | left click |
+ | 2 | right click |
+ | 3 | middles click |
+
+ By default `previous_month_button` is 5, `next_month_button` is 4.
+
+
## How to use
This widget needs an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate!
@@ -47,6 +63,9 @@ local cw = calendar_widget({
theme = 'outrun',
placement = 'bottom_right',
radius = 8,
+-- with customized next/previous (see table above)
+ previous_month_button = 1,
+ next_month_button = 3,
})
mytextclock:connect_signal("button::press",
function(_, _, _, button)