Skip to content

Configuration Schema

Here you will find the definitions of all available configurations

Config values


Name Type Default Description
icon icon Icon (glyph) representing this config file.
iconOffset number 0 Icon offset (‑10 … 10).
configUpdateScript string Absolute path to the script run when the config changes where you can update the theme and configuration for the rest of your system. Theme name and config file name are sent as arguments to the script.
barUpdateScript string Absolute path to the script run when the bar changes. Bar type is sent as an argument to the script.
mainMonitor number 0 Index of the primary monitor (0‑based as reported by Hyprland).
sounds object Global sound configs.
osd object Configuration for on screen displays.
weather object Configuration for the menu bar widget.
notifications object Notification pop‑up behaviour.
systemCommands object Shell commands executed by power options.
frame object Configuration for the frame.
systemMenu object System menu configurations.
barWidgets object Theming configurations for the bars.
theme object Global theme definitions.
topBar object Configuration for the top bar layout.
bottomBar object Configuration for the bottom bar layout.
leftBar object Configuration for the left bar layout.
rightBar object Configuration for the right bar layout.
wallpaper object Wallpaper configs.

sounds

Name Type Default Description
playVolumeChangingSound boolean true Whether or not to play a sound when changing volume
volumeChangingSoundPath string Full path to a sound file that will be used for volume changes
playScreenshotSound boolean true Whether or not to play a sound when taking a screenshot
screenshotSoundPath string Full path to a sound file that will be used for screenshots
playLowBatteryWarningSound boolean true Whether or not to play a sound when the battery is low
lowBatteryWarningSoundPath string Full path to a sound file that will be used for low battery warnings
playChargingSound boolean true Whether or not to play a sound when charging the battery
chargingPlugInSoundPath string Full path to a sound file that will be used for starting battery charging
chargingUnplugSoundPath string Full path to a sound file that will be used for stopping battery charging
timerSoundPath string Full path to a sound file that will be used when the timer goes off

osd

Name Type Default Description
soundOSDEnabled boolean true Enables the sound OSD.
brightnessOSDEnabled boolean true Enables the brightness OSD.

weather

Name Type Default Description
latitude string 0.0 Latitude coordinate for weather location
longitude string 0.0 Longitude coordinate for weather location
temperatureUnit enum (fahrenheit, celsius) fahrenheit Temperature unit
speedUnit enum (mph, kph) mph Speed unit

notifications

Name Type Default Description
position enum (left, right, center) right Screen edge where notification bubbles appear.
respectExclusive boolean true Whether to avoid overlaying exclusive zones declared by widgets.

systemCommands

Name Type Default Description
logout string uwsm stop Command to log the current user out.
logoutConfirmationEnabled boolean true Enable a confirmation dialog when logging out.
lock string uwsm app -- hyprlock Command to lock the screen.
lockConfirmationEnabled boolean false Enable a confirmation dialog when locking the screen.
restart string systemctl reboot Command to reboot the machine.
restartConfirmationEnabled boolean true Enable a confirmation dialog when restarting the computer.
shutdown string systemctl poweroff Command to shut down the machine safely.
shutdownConfirmationEnabled boolean true Enable a confirmation dialog when shutting the computer down.

frame

Name Type Default Description
drawFrame boolean true Whether to draw the frame or not.
margin number 5 Margin (px) between the frame and other windows.
topThickness number 2 Thickness of the full screen frame.
bottomThickness number 2 Thickness of the full screen frame.
leftThickness number 2 Thickness of the full screen frame.
rightThickness number 2 Thickness of the full screen frame.
enableTopSpacer boolean true Enables the top spacer. The spacer pushes window content below the top of the frame.
enableBottomSpacer boolean true Enables the bottom spacer. The spacer pushes window content above the bottom of the frame.
enableLeftSpacer boolean true Enables the left spacer. The spacer pushes window content to the right of the left side of the frame.
enableRightSpacer boolean true Enables the right spacer. The spacer pushes window content to the left of the right side of the frame.
borderRadius number 8 Corner radius (px) for bars.
borderWidth number 2 Bar border width (px).
borderColor color Inherits from: theme.colors.primary Color of the bar border
backgroundColor color Inherits from: theme.colors.background Color of the bar background
menu object Configurations for the expandable menu integration.
notifications object Configurations for the expandable notifications integration.
calendar object Configurations for the expandable calendar integration.
clipboardManager object Configurations for the expandable clipboard manager integration.
screenshotTool object Configurations for the expandable screenshot tool integration.
appLauncher object Configurations for the expandable appLauncher integration.
screenshare object Configurations for the screen share menu integration.

frame.menu

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.notifications

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.calendar

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.clipboardManager

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.screenshotTool

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.appLauncher

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

frame.screenshare

Name Type Default Description
position enum (left, right) left What side of the frame the integration is on.
pushContent boolean false If the integration should push normal windows / content when expanded.

systemMenu

Name Type Default Description
widgets enum[(audioIn, audioOut, bluetooth, clock, lookAndFeel, mprisPlayers, network, notificationHistory, powerProfile, quickActions1, quickActions2)] [clock, quickActions1, network, bluetooth, audioOut, audioIn, lookAndFeel, mprisPlayers, quickActions2, notificationHistory] Widgets inside the system menu
clock object Configurations for the system menu clock.
quickActions1 object Configurations for quick actions.
quickActions2 object Configurations for quick actions.

systemMenu.clock

Name Type Default Description
dayAllCaps boolean false If the week day name text should be in all caps
dayFont string Inherits from: theme.font Font used for the week day name
format24h boolean false If true, use 24-hour format. If false, use 12-hour format with AM/PM

systemMenu.quickActions1

Name Type Default Description
actions enum[(airplaneModeToggle, appLauncherToggle, bluetoothToggle, clipboardManagerToggle, colorPicker, doNotDisturbToggle, lock, logout, nightlightToggle, restart, screenshotToggle, shutdown)] [bluetoothToggle, airplaneModeToggle, nightlightToggle, doNotDisturbToggle] Actions inside the group
maxPerRow number 4 Max number of actions per row. 1-5

systemMenu.quickActions2

Name Type Default Description
actions enum[(airplaneModeToggle, appLauncherToggle, bluetoothToggle, clipboardManagerToggle, colorPicker, doNotDisturbToggle, lock, logout, nightlightToggle, restart, screenshotToggle, shutdown)] [logout, lock, restart, shutdown] Actions inside the group
maxPerRow number 4 Max number of actions per row. 1-5

barWidgets

Name Type Default Description
widgetForeground color Inherits from: theme.colors.foreground Foreground color of the bar widgets.
widgetBackground color Inherits from: theme.colors.background Background color of the bar widgets.
widgetBorderColor color Inherits from: theme.colors.primary Color of the widget borders
widgetBorderRadius number 8 Corner radius (px) for bar widgets.
widgetBorderWidth number 0 Widget border width (px).
widgetMarginStart number 0 Margin at the start of bar widgets.
widgetMarginEnd number 0 Margin at the end of bar widgets.
widgetMarginTop number 0 Margin at the top of bar widgets.
widgetMarginBottom number 0 Margin at the bottom of bar widgets.
appLauncher object Configuration for the app launcher bar widget.
audioIn object Configuration for the audio in bar widget.
audioOut object Configuration for the audio out bar widget.
battery object Configuration for the battery bar widget.
bluetooth object Configuration for the bluetooth bar widget.
cavaWaveform object Configuration for the cava waveform bar widget.
clipboardManager object Configuration for the clipboardManager bar widget.
clock object Configuration for the clock bar widget.
colorPicker object Configuration for the color picker bar widget.
lock object Configuration for the lock bar widget.
logout object Configuration for the logout bar widget.
menu object Theme configuration for the menu bar widget.
mprisControls object Configuration for the mprisControls bar widget.
mprisPrimaryPlayerSwitcher object Configuration for the mpris primary player switcher bar widget.
mprisTrackInfo object Configuration for the mpris track info bar widget.
network object Configuration for the network bar widget.
notificationHistory object Configuration for the notification history bar widget.
powerProfile object Configuration for the power profile bar widget.
recordingIndicator object Configuration for the recording indicator bar widget.
restart object Configuration for the restart bar widget.
screenshot object Configuration for the screenshot bar widget.
shutdown object Configuration for the shutdown bar widget.
timer object Configuration for the timer bar widget.
tray object Configuration for the tray bar widget.
vpnIndicator object Configuration for the vpn indicator bar widget.
workspaces object Configuration for the workspaces bar widget.
custom1 object Configuration for the custom bar widget.
custom2 object Configuration for the custom bar widget.
custom3 object Configuration for the custom bar widget.
custom4 object Configuration for the custom bar widget.
custom5 object Configuration for the custom bar widget.
custom6 object Configuration for the custom bar widget.
custom7 object Configuration for the custom bar widget.
custom8 object Configuration for the custom bar widget.
custom9 object Configuration for the custom bar widget.
custom10 object Configuration for the custom bar widget.
custom11 object Configuration for the custom bar widget.
custom12 object Configuration for the custom bar widget.
custom13 object Configuration for the custom bar widget.
custom14 object Configuration for the custom bar widget.
custom15 object Configuration for the custom bar widget.
custom16 object Configuration for the custom bar widget.
custom17 object Configuration for the custom bar widget.
custom18 object Configuration for the custom bar widget.
custom19 object Configuration for the custom bar widget.
custom20 object Configuration for the custom bar widget.
shortcut1 object Configuration for the shortcut bar widget.
shortcut2 object Configuration for the shortcut bar widget.
shortcut3 object Configuration for the shortcut bar widget.
shortcut4 object Configuration for the shortcut bar widget.
shortcut5 object Configuration for the shortcut bar widget.
shortcut6 object Configuration for the shortcut bar widget.
shortcut7 object Configuration for the shortcut bar widget.
shortcut8 object Configuration for the shortcut bar widget.
shortcut9 object Configuration for the shortcut bar widget.
shortcut10 object Configuration for the shortcut bar widget.
shortcut11 object Configuration for the shortcut bar widget.
shortcut12 object Configuration for the shortcut bar widget.
shortcut13 object Configuration for the shortcut bar widget.
shortcut14 object Configuration for the shortcut bar widget.
shortcut15 object Configuration for the shortcut bar widget.
shortcut16 object Configuration for the shortcut bar widget.
shortcut17 object Configuration for the shortcut bar widget.
shortcut18 object Configuration for the shortcut bar widget.
shortcut19 object Configuration for the shortcut bar widget.
shortcut20 object Configuration for the shortcut bar widget.

barWidgets.appLauncher

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.audioIn

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.audioOut

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.battery

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.bluetooth

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.cavaWaveform

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
length number 200 Length of the cava waveform. This has no effect on the full bar waveform.
expanded boolean false Expands the waveform to fill the empty space. This can expand beyond the set length. This has no effect on the full bar waveform.
position enum (inner, outer, start, end) outer The base position of the waveform
intensityMultiplier number 1 Makes the waves bigger or smaller.

barWidgets.clipboardManager

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.clock

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
format24h boolean false If true, use 24-hour format. If false, use 12-hour format with AM/PM

barWidgets.colorPicker

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.lock

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.logout

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.menu

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
icon icon Icon shown on the menu button (ex: Nerd Font glyph).
iconOffset number 1 Offset of the menu button icon. Use this if the icon is not centered properly

barWidgets.mprisControls

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.mprisPrimaryPlayerSwitcher

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.mprisTrackInfo

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
textLength number 30 The max number of characters to display.
textAlignment enum (start, center, end) center How to align the text.
minimumLength number 300 The minimum length of the widget.

barWidgets.network

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.notificationHistory

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
indicatorForeground color Inherits from: theme.colors.warning Foreground color of the unread notification indicator.

barWidgets.powerProfile

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.recordingIndicator

Name Type Default Description
foreground color Inherits from: theme.colors.warning Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.restart

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.screenshot

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shutdown

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.timer

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.tray

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
collapsable boolean true If true, a tray icon will show and need to be clicked to reveal the tray apps.

barWidgets.vpnIndicator

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.workspaces

Name Type Default Description
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.
largeActive boolean false Make the active workspace icon larger
activeIcon icon Icon of the active workspace
activeOffset number 1 Offset of the active workspace icon. Use this if the icon is not centered properly
inactiveIcon icon Icon of the inactive workspace
inactiveOffset number 1 Offset of the active workspace icon. Use this if the icon is not centered properly
inactiveForeground color Inherits from: barWidgets.workspaces.foreground Foreground color of inactive workspaces.
scrollUpCommand string r-1 The hyprland workspace argument to dispatch when scrolling up while hovering over the workspaces bar widget. See all options here https://wiki.hypr.land/Configuring/Dispatchers/#workspaces
scrollDownCommand string r+1 The hyprland workspace argument to dispatch when scrolling down while hovering over the workspaces bar widget. See all options here https://wiki.hypr.land/Configuring/Dispatchers/#workspaces

barWidgets.custom1

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom2

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom3

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom4

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom5

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom6

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom7

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom8

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom9

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom10

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom11

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom12

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom13

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom14

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom15

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom16

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom17

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom18

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom19

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.custom20

Name Type Default Description
label string The initial label for the custom widget. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnInit string The absolute path of the script to execute when the widget is created. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
execOnClick string The absolute path of the script to execute when the widget is clicked. This is not reactive, so you need to restart OkPanel or switch configs after changing this value.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut1

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut2

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut3

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut4

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut5

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut6

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut7

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut8

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut9

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut10

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut11

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut12

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut13

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut14

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut15

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut16

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut17

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut18

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut19

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

barWidgets.shortcut20

Name Type Default Description
icon icon 󰘔 The icon for the shortcut widget.
iconOffset number 0 Offset for the icon.
launch string The command to execute when launching the program.
newWindow string The command to execute when launching a new window.
class string The window class of the program. You can find this by running hyprctl clients
selectedBackground color Inherits from: theme.colors.buttonPrimary Background color of the widget when selected.
foreground color Inherits from: barWidgets.widgetForeground Foreground color of the widget.
background color Inherits from: barWidgets.widgetBackground Background color of the widget.
borderRadius number Inherits from: barWidgets.widgetBorderRadius Corner radius (px) for the widget.
borderWidth number Inherits from: barWidgets.widgetBorderWidth Widget border width (px).
borderColor color Inherits from: barWidgets.widgetBorderColor Color of the widget border
marginStart number Inherits from: barWidgets.widgetMarginStart Margin at the start of the widget.
marginEnd number Inherits from: barWidgets.widgetMarginEnd Margin at the end of the widget.
marginTop number Inherits from: barWidgets.widgetMarginTop Margin at the top of the widget.
marginBottom number Inherits from: barWidgets.widgetMarginBottom Margin at the bottom of the widget.

theme

Name Type Default Description
name string myTheme Theme name. Passed as the first argument to the configUpdateScript when changing configs.
buttonBorderRadius number 8 Border radius (px) used by regular buttons.
largeButtonBorderRadius number 16 Border radius (px) used by large buttons.
font string JetBrainsMono NF Default font family used across the panel widgets.
nightLightTemperature number 5000 The temperature of the night light.
colors object Palette used by widgets & windows.
windows object Global window styling defaults.

theme.colors

Name Type Default Description
background color #1F2932 Background color
foreground color #AFB3BD Foreground color
primary color #7C545F Primary / accent color
buttonPrimary color #7C545F Button color
warning color #7C7C54 Warning color
alertBorder color #7C545F Color of alert borders (OSD)
scrimColor color #00000001 Color used for translucent overlays (RGBA hex).

theme.windows

Name Type Default Description
gaps number 5 Gap (px) between windows.
borderRadius number 8 Corner radius (px) for client‑side decorations.
borderWidth number 2 Window border width (px).
backgroundColor color Inherits from: theme.colors.background Color of window backgrounds
borderColor color Inherits from: theme.colors.foreground Color of window borders

topBar

Name Type Default Description
leftWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored left.
centerWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets centered horizontally.
rightWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored right.
minimumWidth number 600 The minimum width of the bar if not expanded.
expanded boolean true If true, the group expands to full width
compact boolean false Enabled compact bar mode.
widgetSpacing number 0 Spacing (px) between widgets inside the bar.
borderRadius number 0 Corner radius (px) for bars.
borderWidth number 0 Bar border width (px).
borderColor color Inherits from: theme.colors.primary Color of the bar border
backgroundColor color Inherits from: frame.backgroundColor Color of the bar background
marginStart number 0 Starting margin of the bar
marginEnd number 0 Ending margin of the bar
marginTop number 0 Top margin of the bar
marginBottom number 0 Bottom margin of the bar
paddingStart number 0 Starting padding of the bar.
paddingEnd number 0 Ending padding of the bar.
paddingTop number 0 Top padding of the bar.
paddingBottom number 0 Bottom padding of the bar.

bottomBar

Name Type Default Description
leftWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored left.
centerWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets centered horizontally.
rightWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored right.
minimumWidth number 600 The minimum width of the bar if not expanded.
expanded boolean true If true, the group expands to full width
compact boolean false Enabled compact bar mode.
widgetSpacing number 0 Spacing (px) between widgets inside the bar.
borderRadius number 0 Corner radius (px) for bars.
borderWidth number 0 Bar border width (px).
borderColor color Inherits from: theme.colors.primary Color of the bar border
backgroundColor color Inherits from: frame.backgroundColor Color of the bar background
marginStart number 0 Starting margin of the bar
marginEnd number 0 Ending margin of the bar
marginTop number 0 Top margin of the bar
marginBottom number 0 Bottom margin of the bar
paddingStart number 0 Starting padding of the bar.
paddingEnd number 0 Ending padding of the bar.
paddingTop number 0 Top padding of the bar.
paddingBottom number 0 Bottom padding of the bar.

leftBar

Name Type Default Description
topWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored at the top.
centerWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets centered vertically.
bottomWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored at the bottom.
minimumHeight number 800 The minimum height of the bar if not expanded.
expanded boolean true If true, the group expands to full width
compact boolean false Enabled compact bar mode.
widgetSpacing number 0 Spacing (px) between widgets inside the bar.
borderRadius number 0 Corner radius (px) for bars.
borderWidth number 0 Bar border width (px).
borderColor color Inherits from: theme.colors.primary Color of the bar border
backgroundColor color Inherits from: frame.backgroundColor Color of the bar background
marginStart number 0 Starting margin of the bar
marginEnd number 0 Ending margin of the bar
marginTop number 0 Top margin of the bar
marginBottom number 0 Bottom margin of the bar
paddingStart number 0 Starting padding of the bar.
paddingEnd number 0 Ending padding of the bar.
paddingTop number 0 Top padding of the bar.
paddingBottom number 0 Bottom padding of the bar.

rightBar

Name Type Default Description
topWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored at the top.
centerWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets centered vertically.
bottomWidgets enum[(appLauncher, audioIn, audioOut, battery, bluetooth, cavaWaveform, clipboardManager, clock, colorPicker, lock, logout, menu, mprisControls, mprisPrimaryPlayerSwitcher, mprisTrackInfo, network, notificationHistory, powerProfile, recordingIndicator, restart, screenshot, shutdown, timer, tray, vpnIndicator, workspaces, custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9, custom10, custom11, custom12, custom13, custom14, custom15, custom16, custom17, custom18, custom19, custom20, shortcut1, shortcut2, shortcut3, shortcut4, shortcut5, shortcut6, shortcut7, shortcut8, shortcut9, shortcut10, shortcut11, shortcut12, shortcut13, shortcut14, shortcut15, shortcut16, shortcut17, shortcut18, shortcut19, shortcut20)] Widgets anchored at the bottom.
minimumHeight number 800 The minimum height of the bar if not expanded.
expanded boolean true If true, the group expands to full width
compact boolean false Enabled compact bar mode.
widgetSpacing number 0 Spacing (px) between widgets inside the bar.
borderRadius number 0 Corner radius (px) for bars.
borderWidth number 0 Bar border width (px).
borderColor color Inherits from: theme.colors.primary Color of the bar border
backgroundColor color Inherits from: frame.backgroundColor Color of the bar background
marginStart number 0 Starting margin of the bar
marginEnd number 0 Ending margin of the bar
marginTop number 0 Top margin of the bar
marginBottom number 0 Bottom margin of the bar
paddingStart number 0 Starting padding of the bar.
paddingEnd number 0 Ending padding of the bar.
paddingTop number 0 Top padding of the bar.
paddingBottom number 0 Bottom padding of the bar.

wallpaper

Name Type Default Description
showWallpaper boolean true Show the wallpaper in OkPanel. Set to false if you want to use another wallpaper program
wallpaperUpdateScript string Absolute path to the script run when the wallpaper changes. Wallpaper path is sent as an argument to the script.
wallpaperDir string Directory containing theme wallpapers (may be empty).
transitionType enum (none, crossfade, slideRight, slideLeft, slideUp, slideDown, slideLeftRight, slideUpDown, overUp, overDown, overLeft, overRight, underUp, underDown, underLeft, underRight, overUpDown, overDownUp, overLeftRight, overRightLeft, rotateLeft, rotateRight, rotateLeftRight) crossfade The type of transition animation when switching wallpapers.
transitionDuration number 200 The duration of the transition animation when switching wallpapers in milliseconds.