Skip to content

clock

Time display with a calendar dropdown.

Add it to your layout with clock:

toml
[[bar.layout]]
monitor = "*"
right = ["clock"]

General

FieldTypeDefaultDescription
formatstring"%a %b %d %I:%M %p"Format string using strftime syntax.
icon-namestring"tb-calendar-time-symbolic"Symbolic icon name.
border-showboolfalseDisplay border around button.
icon-showbooltrueDisplay module icon.
label-showbooltrueDisplay text label.
label-max-lengthu320Max label characters before truncation with ellipsis. Set to 0 to disable.
More about format

Common Specifiers

  • %H - Hour (00-23)
  • %I - Hour (01-12)
  • %M - Minute (00-59)
  • %S - Second (00-59)
  • %p - AM/PM
  • %a - Abbreviated weekday (Mon, Tue)
  • %A - Full weekday (Monday)
  • %b - Abbreviated month (Jan, Feb)
  • %B - Full month (January)
  • %d - Day of month (01-31)
  • %Y - Year (2024)

Examples

  • "%H:%M" - "14:30"
  • "%I:%M %p" - "02:30 PM"
  • "%a %b %d %I:%M %p" - "Mon Jan 15 02:30 PM"

Colors

FieldTypeDefaultDescription
border-colorColorValue"border-accent"Border color token.
icon-colorColorValue"auto"Icon foreground color. Auto selects based on variant for contrast.
icon-bg-colorColorValue"accent"Icon container background color token.
label-colorColorValue"accent"Label text color token.
button-bg-colorColorValue"bg-surface-elevated"Button background color token.

Click actions

FieldTypeDefaultDescription
left-clickClickAction"dropdown:calendar"Action on left click.
right-clickClickAction"dropdown:weather"Action on right click.
middle-clickClickAction""Action on middle click.
scroll-upClickAction""Action on scroll up.
scroll-downClickAction""Action on scroll down.
FieldTypeDefaultDescription
dropdown-show-secondsboolfalseShow seconds in the calendar dropdown clock display.

Default configuration

toml
[modules.clock]
format = "%a %b %d %I:%M %p"
icon-name = "tb-calendar-time-symbolic"
border-show = false
border-color = "border-accent"
icon-show = true
icon-color = "auto"
icon-bg-color = "accent"
label-show = true
label-color = "accent"
label-max-length = 0
button-bg-color = "bg-surface-elevated"
left-click = "dropdown:calendar"
right-click = "dropdown:weather"
middle-click = ""
scroll-up = ""
scroll-down = ""
dropdown-show-seconds = false

Released under the MIT License.