Miroirs/awesome-wm-widgets
1
0
Fork 0
mirror of https://github.com/streetturtle/awesome-wm-widgets.git synced 2024-11-15 19:48:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Calendar: Add documentation about the args to customize

Browse source 
Remove trailing spaces
This commit is contained in:
Aurélien LAJOIE 2021-10-20 14:15:18 +02:00
parent 8e39d6a535
commit 3d611c0531
No known key found for this signature in database
GPG key ID: B843917229D6F3CE
1 changed files with 18 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
calendar-widget/README.md
View file

@ -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)