Every provider uses the same item structure. Start with id and type, then add the settings listed on its page. Shared styling, actions, and refresh controls are available to every provider. Use text templates to customise displayed labels; provider pages describe their default labels.

Provider reference #

ProviderUpdatesDedicated configuration
Date and timeEvery secondformat, dateStyle, timeStyle
Front applicationNative eventsfrontApplication block
BatteryNative eventsbattery block
VolumeNative eventsvolume block
Audio devicesNative events / 2-second retries when unavailableaudioDevice block
MailConfigurable polling; 30 seconds by defaultmail
NetworkNative eventsnetwork block
WeatherConfigurable polling; 15 minutes by defaultweather block
VPNNative events / 2-second retries when unavailablevpn block
BluetoothNative events / 2-second retries when unavailablebluetooth block
CPU2-second samplingcpu block
Memory2-second samplingmemory block
Disk2-second samplingdisk block
Throughput2-second samplingthroughput block
MediaPlayback notificationsmedia block
SpacesNative eventsspaces block
AeroSpace2-second polling / fresh triggersaerospace block
Yabai2-second polling / fresh triggersyabai block
Shell commandStartup / trigger / intervalcommand block
Process pluginProcess streamplugin block

Layout items #

Use these items for fixed text, containers, and spacing. See shared item options for containers and overflow.

TypeConfigurationBehaviour
texttextStatic text or a template using id and value; empty when omitted.
groupchildrenInline children, nesting up to eight levels.
popuptext, childrenClick to reveal children; label defaults to the item ID unless overridden.
dividerShared stylingVertical separator.
spacerNo dedicated optionsFlexible empty space.

Search docs

Enter a word or command.