From 3d611c0531fa37ce982269a3d09035424a5a9408 Mon Sep 17 00:00:00 2001 From: Aurélien LAJOIE Date: Wed, 20 Oct 2021 14:15:18 +0200 Subject: Calendar: Add documentation about the args to customize Remove trailing spaces --- calendar-widget/README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) (limited to 'calendar-widget') diff --git a/calendar-widget/README.md b/calendar-widget/README.md index c7b46e2..0c2b940 100644 --- a/calendar-widget/README.md +++ b/calendar-widget/README.md @@ -4,18 +4,27 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget. ## Features + +### Customization + +| Name | Default | Description | +|---|---|---| +| theme | `naughty` | The theme to use | +| placement | `top` | The position of the popup | +| radius | 8 | The popup radius | + - themes: - + | Name | Screenshot | |---|---| - | nord (default) | ![nord_theme](./nord.png) | - | outrun | ![outrun_theme](./outrun.png) | - | light | ![outrun_theme](./light.png) | - | dark | ![outrun_theme](./dark.png) | + | nord | ![nord_theme](./nord.png) | + | outrun | ![outrun_theme](./outrun.png) | + | light | ![outrun_theme](./light.png) | + | dark | ![outrun_theme](./dark.png) | | naughty (default) | from local theme | - + - setup widget placement - + top center - in case you clock is centered: ![calendar_top](./calendar_top.png) @@ -48,7 +57,7 @@ Calendar widget for Awesome WM - slightly improved version of the `wibox.widget. ## How to use -This widget needs an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate! +This widget needs an 'anchor' - another widget which triggers visibility of the calendar. Default `mytextclock` is the perfect candidate! Just after mytextclock is instantiated, create the widget and add the mouse listener to it. ```lua @@ -67,7 +76,7 @@ local cw = calendar_widget({ previous_month_button = 1, next_month_button = 3, }) -mytextclock:connect_signal("button::press", +mytextclock:connect_signal("button::press", function(_, _, _, button) if button == 1 then cw.toggle() end end) -- cgit v1.2.3