Skip to content

Information applets ​

These applets show the time, your calendar, the weather, what is playing and what has happened.

Some applets also have a table named after the service behind them, shown after the applet's own. The service table changes the service for everything that uses it; the applet table changes only that applet.

clock ​

[applets.clock]

The time and date, with a calendar in its popover.

hide-all-dayboolean default false

Hide all-day events from your calendar's day list and month grid.

label-formatstring default "%a, %-d %b, %H:%M"

A strftime format string for the bar, such as %H:%M or %a %d %b %H:%M.

timezonestringnot set by default

Your clock's time zone, such as UTC or Asia/Tokyo. Leave it unset to use your local time.

timezoneslist of tables

The other zones the popover lists under its world clock. Empty hides the section.

Its settings are listed under [[applets.clock.timezones]].

tooltip-formatstringnot set by default

What the bar's tooltip reads. A strftime format, such as %A, %-d %B %Y. Unset shows no tooltip.

week-numbersboolean default true

Show today's week number above your calendar.

Screenshot
The clock popoverThe clock popover
[calendar]

Share your calendar events between the clock grid, day list and next-event. You get events from 31 days back to 62 days ahead; browsing the clock moves that window, with a maximum span of 400 days. Up to 512 events are kept, with 512 occurrences per recurring event and titles cut at 120 characters.

poll-intervalinteger default 600

How often online calendars update, in seconds, unless a source sets its own interval. Local calendars update when their files change.

sourceslist of tables

The calendars you read events from.

Its settings are listed under [[calendar.sources]].

next-event ​

[applets.next-event]

The next entry from the configured calendars.

all-dayboolean default false

Show all-day events on your bar when there are no timed events to show.

countdowninteger default 60

How many minutes before an event starts you see a countdown beside its title. With 0, you only see a countdown after the event starts.

horizoninteger default 720

How many minutes ahead your event list reaches, with within as the minimum.

tooltip-formatstringnot set by default

What the bar's tooltip reads. {summary} is the event's title, {detail} its location or description, {when} when it starts and {conflicts} the events overlapping it. Unset shows no tooltip.

upcominginteger default 5

How many upcoming events you see below the current one.

withininteger default 60

How many minutes before an event starts it appears on your bar. With 0, you only see events already under way.

Screenshot
The next-event popoverThe next-event popover

weather ​

[applets.weather]

Current weather and forecast.

daysinteger from 0 to 255 default 6

How many days after today the popover's list shows. Today always leads the list, holding the current conditions.

hoursinteger from 0 to 255 default 4

How many forecast hours you see, starting with the next hour.

labelstringnot set by default

Your place's name in the tooltip and weather panel. Leave it unset to use the city name.

placetable default { at = "here" }

Which place this applet shows.

What the bar's tooltip reads. {place}, {temperature}, {feels-like} and {condition}.

Default
{place}
{condition}, {temperature}, feels like {feels-like}

label sets the name in the applet's tooltip and at the top of its popover; the bar itself shows only the icon and the temperature. With no label, a latlon place reads as the nearest city, such as Amsterdam, NL. The hour strip shows at most 23 hours however high hours is set, and the day list never goes past [weather] forecast-days rows counting today (7 by default).

Screenshot
The weather popoverThe weather popover
[weather]

How a forecast is fetched. There are no places here: a place is registered by whatever wants to see it, through WatchPlace, and held for as long as it keeps asking. Nothing is fetched and no location is resolved until something does.

forecast-daysinteger from 0 to 255 default 7

How many forecast days you get, including today, from 1 to 10.

poll-intervalinteger default 900

How often the forecast updates, in seconds, with a minimum of 600.

providerone of default "open-meteo"

Your weather forecast service.

  • "open-meteo" Open-Meteo.
  • "met-no" The Norwegian Meteorological Institute.

mpris ​

[applets.mpris]

Music and playback controls.

label-formatstring default "{title} — {artist}"

Your track label, using {player}, {title}, {artist}, {album}, {state}, {position}, {duration} and {remaining}.

max-lengthinteger from 0 to 255 default 40

How many characters of your track label you see before it ends in ….

tooltip-formatstringnot set by default

Your tooltip text, using the same placeholders as label-format.

Screenshot
The mpris popoverThe mpris popover
[mpris]

Choose which media players you follow and whether to download their artwork. Playing players take priority over paused, then stopped players, with the most recently active first.

art-max-kibinteger default 4096

The largest artwork download you allow, in kibibytes, from 16 to 65536.

fetch-artboolean default true

Download album artwork from the internet. Artwork from local files still works when this is off.

ignorelist of strings default []

Hide media players whose names match these case-sensitive regular expressions. Upper and lower case must match the name; start an entry with (?i) to ignore case, as in '(?i)firefox'. Use single quotes around each entry.

notifications ​

[applets.notifications]

Unread notifications, with their history in its popover.

indicator-styleone of default "icon-dot"

How the bar marks unread notifications: icon-dot adds a dot, icon-counter shows how many, icon-only shows the bell alone.

  • "icon-only"
  • "icon-dot"
  • "icon-counter"
tooltip-formatstringnot set by default

Your tooltip text, with {count} for the number of unread notifications.

Screenshot
The notifications popoverThe notifications popover

Released under the BSD 3-Clause license.