sbar / docsSource ↗
sbar / Documentation

Providers

Compare provider output, updates, and configuration.

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 text settings below describe the default presentation.

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
Mail30-second polling-
NetworkNative eventsnetwork 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

These compose the bar rather than collect system data. 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.

Where the options differ

  • Date and time supports localised styles and custom patterns. Front application follows the application owning the menu bar and can show its native icon alongside its name or on its own.
  • Battery and Volume provide state symbols and colours.
  • The Audio devices provider shows the default output or input device name. It supports custom labels, symbols, and colours, and can hide missing devices while keeping read errors visible.
  • Mail shows Apple Mail’s combined inbox unread count. It needs Automation permission and a running Mail app, and uses shared item settings only.
  • Network supports custom labels and connection-type filtering, including Wi-Fi.
  • VPN lists registered service names and connection states, with custom labels, symbols, and colours. It can hide the item when disconnected.
  • Bluetooth shows power state and connected device names, with custom labels, symbols, and colours. It can hide the item when no devices are connected while keeping access errors visible.
  • CPU supports per-item smoothing and usage thresholds. Memory offers used bytes, percentage, or used/total values. Disk supports volume paths, capacity formats, and free-space thresholds.
  • Throughput supports interface selection, byte or bit rates, and smoothing. Media supports player selection, metadata visibility, playback state icons, and hiding every state except playing.
  • Spaces, AeroSpace, and Yabai support focused or per-display lists. Text loops customise each entry while retaining its colour and emphasis; Yabai uses its configured Space labels by default. Workspace providers have no built-in switching controls.
  • Shell command captures a completed result. Process plugin streams updates. Both support structured JSON output, state appearance, and error policies.
sbar documentation Built with Hugo · Reference reviewed 12 Sep 2026