awesomewm-mirrors
/
awesome-wm-widgets
mirror of https://github.com/streetturtle/awesome-wm-widgets.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
awesome-wm-widgets/calendar-widget
History
streetturtle 7eb3b2a453 Fix luacheck issues 2024-11-09 13:57:48 -05:00
..
README.md docs: document new user customization options 2024-08-03 14:55:58 -07:00
calendar.lua Fix luacheck issues 2024-11-09 13:57:48 -05:00
calendar_bottom_right.png themes for calendar widget 2019-12-15 22:10:22 -05:00
calendar_start_sunday.png Add missing screen shot 2022-03-17 23:53:38 +01:00
calendar_top.png add readme for the calendar widget 2019-12-12 22:39:16 -05:00
calendar_top_right.png add readme for the calendar widget 2019-12-12 22:39:16 -05:00
dark.png add light and dark calendar themes 2019-12-17 16:43:36 -05:00
light.png add light and dark calendar themes 2019-12-17 16:43:36 -05:00
nord.png themes for calendar widget 2019-12-15 22:10:22 -05:00
outrun.png themes for calendar widget 2019-12-15 22:10:22 -05:00

README.md

Calendar Widget

Calendar widget for Awesome WM - slightly improved version of the wibox.widget.calendar.

Features

Customization

Name Default Description
theme naughty The theme to use
placement top The position of the popup
radius 8 The popup radius
start_sunday false Start the week on Sunday
week_numbers false Show ISO week numbers (Mon = first)
auto_hide false Auto hide the popup after timeout
timeout 2 Auto hide timeout length

  • themes:

    Name Screenshot
    nord nord_theme
    outrun outrun_theme
    light outrun_theme
    dark outrun_theme
    naughty (default) from local theme

  • setup widget placement

top center - in case you clock is centered:

calendar_top

top right - for default awesome config:

calendar_top_right

bottom right - in case your wibar at the bottom:

calendar_bottom_right

  • setup first day of week

    By setting start_sunday to true: calendar_start_sunday

  • 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! Just after mytextclock is instantiated, create the widget and add the mouse listener to it.

local calendar_widget = require("awesome-wm-widgets.calendar-widget.calendar")
-- ...
-- Create a textclock widget
mytextclock = wibox.widget.textclock()
-- default
local cw = calendar_widget()
-- or customized
local cw = calendar_widget({
    theme = 'outrun',
    placement = 'bottom_right',
    start_sunday = true,
    radius = 8,
-- with customized next/previous (see table above)
    previous_month_button = 1,
    next_month_button = 3,
})
mytextclock:connect_signal("button::press",
    function(_, _, _, button)
        if button == 1 then cw.toggle() end
    end)