Configuration

center_widgetsoptional array WidgetConfig

Center widgets (ordered left-to-right)

font_familyoptional string

Font family

font_sizeoptional number

Font size (default: 12.5)

Format: float
frameoptional FrameConfig

Frame options (see: https://docs.rs/egui/latest/egui/containers/frame/struct.Frame.html)

groupingoptional Grouping

Visual grouping for widgets

heightoptional number

Bar height (default: 50)

Format: float
icon_scaleoptional number

Scale of the icons relative to the font_size [[1.0-2.0]]. (default: 1.4)

Format: float
left_widgetsrequired array WidgetConfig

Left side widgets (ordered left-to-right)

marginoptional SpacingKind

Bar margin. Use one value for all sides or use a grouped margin for horizontal and/or vertical definition which can each take a single value for a symmetric margin or two values for each side, i.e.:

"margin": {
    "horizontal": 10
}

or:

"margin": {
    "vertical": [top, bottom]
}

You can also set individual margin on each side like this:

"margin": {
    "top": 10,
    "bottom": 10,
    "left": 10,
    "right": 10,
}

By default, margin is set to 0 on all sides.

max_label_widthoptional number

Max label width before text truncation (default: 400.0)

Format: float
monitorrequiredMonitorConfigOrIndex

The monitor index or the full monitor options

mouseoptional MouseConfig

Options for mouse interaction on the bar

paddingoptional SpacingKind

Bar padding. Use one value for all sides or use a grouped padding for horizontal and/or vertical definition which can each take a single value for a symmetric padding or two values for each side, i.e.:

"padding": {
    "horizontal": 10
}

or:

"padding": {
    "horizontal": [left, right]
}

You can also set individual padding on each side like this:

"padding": {
    "top": 10,
    "bottom": 10,
    "left": 10,
    "right": 10,
}

By default, padding is set to 10 on all sides.

positionoptional PositionConfig

Bar positioning options

right_widgetsrequired array WidgetConfig

Right side widgets (ordered left-to-right)

themeoptional KomobarTheme

Theme

transparency_alphaoptional integer

Alpha value for the color transparency [[0-255]] (default: 200)

Format: uint8Min: 0Max: 255
widget_spacingoptional number

Spacing between widgets (default: 10.0)

Format: float

Type Definitions

AnimationPrefix

string
Enum variants (2)
  • "movement"
  • "transparency"

AnimationStyle

enum
Enum variants (2)
string
Enum variants (30)
  • "Linear"
  • "EaseInSine"
  • "EaseOutSine"
  • "EaseInOutSine"
  • "EaseInQuad"
  • "EaseOutQuad"
  • "EaseInOutQuad"
  • "EaseInCubic"
  • "EaseInOutCubic"
  • "EaseInQuart"
  • "EaseOutQuart"
  • "EaseInOutQuart"
  • "EaseInQuint"
  • "EaseOutQuint"
  • "EaseInOutQuint"
  • "EaseInExpo"
  • "EaseOutExpo"
  • "EaseInOutExpo"
  • "EaseInCirc"
  • "EaseOutCirc"
  • "EaseInOutCirc"
  • "EaseInBack"
  • "EaseOutBack"
  • "EaseInOutBack"
  • "EaseInElastic"
  • "EaseOutElastic"
  • "EaseInOutElastic"
  • "EaseInBounce"
  • "EaseOutBounce"
  • "EaseInOutBounce"
object
Properties (1)
CubicBezierrequiredarray float; 4

AppConfig

object
Properties (6)
commandrequiredstring

Command to execute (e.g. path to the application or shell command).

displayoptional ApplicationsDisplayFormat

Display format for this application button (optional). Overrides global format if set.

enableoptional boolean

Whether to enable this application button (optional). Inherits from the global Applications setting if omitted.

iconoptional string

Optional icon: a path to an image or a text-based glyph (e.g., from Nerd Fonts). If not set, and if the command is a path to an executable, an icon might be extracted from it. Note: glyphs require a compatible font_family.

namerequiredstring

Display name of the application.

show_command_on_hoveroptional boolean

Whether to show the launch command on hover (optional). Inherits from the global Applications setting if omitted.

ApplicationIdentifier

string
Enum variants (4)
  • "Exe"
  • "Class"
  • "Title"
  • "Path"

Configuration Usage

Referenced by

ApplicationsConfig

object
Properties (5)
displayoptional ApplicationsDisplayFormat

Default display format for all applications (optional). Could be overridden per application. Defaults to Icon.

enablerequiredboolean

Enables or disables the applications widget.

itemsrequired array AppConfig

List of configured applications to display.

show_command_on_hoveroptional boolean

Whether to show the launch command on hover (optional). Could be overridden per application. Defaults to false if not set.

spacingoptional number

Horizontal spacing between application buttons.

Format: float

ApplicationsDisplayFormat

string enum
Enum variants (3)
string

Show only the application icon.

Value: "Icon"
string

Show only the application name as text.

Value: "Text"
string

Show both the application icon and name.

Value: "IconAndText"

Axis

string
Enum variants (3)
  • "Horizontal"
  • "Vertical"
  • "HorizontalAndVertical"

Base16

string
Enum variants (269)
  • "3024"
  • "Apathy"
  • "Apprentice"
  • "Ashes"
  • "AtelierCaveLight"
  • "AtelierCave"
  • "AtelierDuneLight"
  • "AtelierDune"
  • "AtelierEstuaryLight"
  • "AtelierEstuary"
  • "AtelierForestLight"
  • "AtelierForest"
  • "AtelierHeathLight"
  • "AtelierHeath"
  • "AtelierLakesideLight"
  • "AtelierLakeside"
  • "AtelierPlateauLight"
  • "AtelierPlateau"
  • "AtelierSavannaLight"
  • "AtelierSavanna"
  • "AtelierSeasideLight"
  • "AtelierSeaside"
  • "AtelierSulphurpoolLight"
  • "AtelierSulphurpool"
  • "Atlas"
  • "AyuDark"
  • "AyuLight"
  • "AyuMirage"
  • "Aztec"
  • "Bespin"
  • "BlackMetalBathory"
  • "BlackMetalBurzum"
  • "BlackMetalDarkFuneral"
  • "BlackMetalGorgoroth"
  • "BlackMetalImmortal"
  • "BlackMetalKhold"
  • "BlackMetalMarduk"
  • "BlackMetalMayhem"
  • "BlackMetalNile"
  • "BlackMetalVenom"
  • "BlackMetal"
  • "Blueforest"
  • "Blueish"
  • "Brewer"
  • "Bright"
  • "Brogrammer"
  • "BrushtreesDark"
  • "Brushtrees"
  • "Caroline"
  • "CatppuccinFrappe"
  • "CatppuccinLatte"
  • "CatppuccinMacchiato"
  • "CatppuccinMocha"
  • "Chalk"
  • "Circus"
  • "ClassicDark"
  • "ClassicLight"
  • "Codeschool"
  • "Colors"
  • "Cupcake"
  • "Cupertino"
  • "DaOneBlack"
  • "DaOneGray"
  • "DaOneOcean"
  • "DaOnePaper"
  • "DaOneSea"
  • "DaOneWhite"
  • "DanqingLight"
  • "Danqing"
  • "Darcula"
  • "Darkmoss"
  • "Darktooth"
  • "Darkviolet"
  • "Decaf"
  • "DefaultDark"
  • "DefaultLight"
  • "Dirtysea"
  • "Dracula"
  • "EdgeDark"
  • "EdgeLight"
  • "Eighties"
  • "EmbersLight"
  • "Embers"
  • "Emil"
  • "EquilibriumDark"
  • "EquilibriumGrayDark"
  • "EquilibriumGrayLight"
  • "EquilibriumLight"
  • "Eris"
  • "Espresso"
  • "EvaDim"
  • "Eva"
  • "EvenokDark"
  • "EverforestDarkHard"
  • "Everforest"
  • "Flat"
  • "Framer"
  • "FruitSoda"
  • "Gigavolt"
  • "Github"
  • "GoogleDark"
  • "GoogleLight"
  • "Gotham"
  • "GrayscaleDark"
  • "GrayscaleLight"
  • "Greenscreen"
  • "Gruber"
  • "GruvboxDarkHard"
  • "GruvboxDarkMedium"
  • "GruvboxDarkPale"
  • "GruvboxDarkSoft"
  • "GruvboxLightHard"
  • "GruvboxLightMedium"
  • "GruvboxLightSoft"
  • "GruvboxMaterialDarkHard"
  • "GruvboxMaterialDarkMedium"
  • "GruvboxMaterialDarkSoft"
  • "GruvboxMaterialLightHard"
  • "GruvboxMaterialLightMedium"
  • "GruvboxMaterialLightSoft"
  • "Hardcore"
  • "Harmonic16Dark"
  • "Harmonic16Light"
  • "HeetchLight"
  • "Heetch"
  • "Helios"
  • "Hopscotch"
  • "HorizonDark"
  • "HorizonLight"
  • "HorizonTerminalDark"
  • "HorizonTerminalLight"
  • "HumanoidDark"
  • "HumanoidLight"
  • "IaDark"
  • "IaLight"
  • "Icy"
  • "Irblack"
  • "Isotope"
  • "Jabuti"
  • "Kanagawa"
  • "Katy"
  • "Kimber"
  • "Lime"
  • "Macintosh"
  • "Marrakesh"
  • "Materia"
  • "MaterialDarker"
  • "MaterialLighter"
  • "MaterialPalenight"
  • "MaterialVivid"
  • "Material"
  • "MeasuredDark"
  • "MeasuredLight"
  • "MellowPurple"
  • "MexicoLight"
  • "Mocha"
  • "Monokai"
  • "Moonlight"
  • "Mountain"
  • "Nebula"
  • "NordLight"
  • "Nord"
  • "Nova"
  • "Ocean"
  • "Oceanicnext"
  • "OneLight"
  • "OnedarkDark"
  • "Onedark"
  • "OutrunDark"
  • "OxocarbonDark"
  • "OxocarbonLight"
  • "Pandora"
  • "PapercolorDark"
  • "PapercolorLight"
  • "Paraiso"
  • "Pasque"
  • "Phd"
  • "Pico"
  • "Pinky"
  • "Pop"
  • "Porple"
  • "PreciousDarkEleven"
  • "PreciousDarkFifteen"
  • "PreciousLightWarm"
  • "PreciousLightWhite"
  • "PrimerDarkDimmed"
  • "PrimerDark"
  • "PrimerLight"
  • "Purpledream"
  • "Qualia"
  • "Railscasts"
  • "Rebecca"
  • "RosePineDawn"
  • "RosePineMoon"
  • "RosePine"
  • "Saga"
  • "Sagelight"
  • "Sakura"
  • "Sandcastle"
  • "SelenizedBlack"
  • "SelenizedDark"
  • "SelenizedLight"
  • "SelenizedWhite"
  • "Seti"
  • "ShadesOfPurple"
  • "ShadesmearDark"
  • "ShadesmearLight"
  • "Shapeshifter"
  • "SilkDark"
  • "SilkLight"
  • "Snazzy"
  • "SolarflareLight"
  • "Solarflare"
  • "SolarizedDark"
  • "SolarizedLight"
  • "Spaceduck"
  • "Spacemacs"
  • "Sparky"
  • "StandardizedDark"
  • "StandardizedLight"
  • "Stella"
  • "StillAlive"
  • "Summercamp"
  • "SummerfruitDark"
  • "SummerfruitLight"
  • "SynthMidnightDark"
  • "SynthMidnightLight"
  • "Tango"
  • "Tarot"
  • "Tender"
  • "TerracottaDark"
  • "Terracotta"
  • "TokyoCityDark"
  • "TokyoCityLight"
  • "TokyoCityTerminalDark"
  • "TokyoCityTerminalLight"
  • "TokyoNightDark"
  • "TokyoNightLight"
  • "TokyoNightMoon"
  • "TokyoNightStorm"
  • "TokyoNightTerminalDark"
  • "TokyoNightTerminalLight"
  • "TokyoNightTerminalStorm"
  • "TokyodarkTerminal"
  • "Tokyodark"
  • "TomorrowNightEighties"
  • "TomorrowNight"
  • "Tomorrow"
  • "Tube"
  • "Twilight"
  • "UnikittyDark"
  • "UnikittyLight"
  • "UnikittyReversible"
  • "Uwunicorn"
  • "Vesper"
  • "Vice"
  • "Vulcan"
  • "Windows10Light"
  • "Windows10"
  • "Windows95Light"
  • "Windows95"
  • "WindowsHighcontrastLight"
  • "WindowsHighcontrast"
  • "WindowsNtLight"
  • "WindowsNt"
  • "Woodland"
  • "XcodeDusk"
  • "Zenbones"
  • "Zenburn"

Base16ColourPalette

object
Properties (16)
base_00requiredColour
base_01requiredColour
base_02requiredColour
base_03requiredColour
base_04requiredColour
base_05requiredColour
base_06requiredColour
base_07requiredColour
base_08requiredColour
base_09requiredColour
base_0arequiredColour
base_0brequiredColour
base_0crequiredColour
base_0drequiredColour
base_0erequiredColour
base_0frequiredColour

Base16Value

string
Enum variants (16)
  • "Base00"
  • "Base01"
  • "Base02"
  • "Base03"
  • "Base04"
  • "Base05"
  • "Base06"
  • "Base07"
  • "Base08"
  • "Base09"
  • "Base0A"
  • "Base0B"
  • "Base0C"
  • "Base0D"
  • "Base0E"
  • "Base0F"

Configuration Usage

Referenced by

BatteryConfig

object
Properties (5)
auto_select_underoptional integer

Select when the current percentage is under this value [[1-100]]

Format: uint8Min: 0Max: 255
data_refresh_intervaloptional integer

Data refresh interval (default: 10 seconds)

Format: uint64Min: 0
enablerequiredboolean

Enable the Battery widget

hide_on_full_chargeoptional boolean

Hide the widget if the battery is at full charge

label_prefixoptional LabelPrefix

Display label prefix

BorderImplementation

string enum
Enum variants (2)
string

Use the adjustable komorebi border implementation

Value: "Komorebi"
string

Use the thin Windows accent border implementation

Value: "Windows"

BorderStyle

string enum
Enum variants (3)
string

Use the system border style

Value: "System"
string

Use the Windows 11-style rounded borders

Value: "Rounded"
string

Use the Windows 10-style square borders

Value: "Square"

Catppuccin

string
Enum variants (4)
  • "Frappe"
  • "Latte"
  • "Macchiato"
  • "Mocha"

CatppuccinValue

string
Enum variants (26)
  • "Rosewater"
  • "Flamingo"
  • "Pink"
  • "Mauve"
  • "Red"
  • "Maroon"
  • "Peach"
  • "Yellow"
  • "Green"
  • "Teal"
  • "Sky"
  • "Sapphire"
  • "Blue"
  • "Lavender"
  • "Text"
  • "Subtext1"
  • "Subtext0"
  • "Overlay2"
  • "Overlay1"
  • "Overlay0"
  • "Surface2"
  • "Surface1"
  • "Surface0"
  • "Base"
  • "Mantle"
  • "Crust"

Configuration Usage

Referenced by

Colour

enum
Enum variants (2)
Rgb

Colour represented as RGB

Hex

Colour represented as Hex

Configuration Usage

Referenced by

CpuConfig

object
Properties (4)
auto_select_overoptional integer

Select when the current percentage is over this value [[1-100]]

Format: uint8Min: 0Max: 255
data_refresh_intervaloptional integer

Data refresh interval (default: 10 seconds)

Format: uint64Min: 0
enablerequiredboolean

Enable the Cpu widget

label_prefixoptional LabelPrefix

Display label prefix

CustomModifiers

Custom format with additive modifiers for integer format specifiers

object

Custom format with additive modifiers for integer format specifiers

Properties (2)
formatrequiredstring

Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)

modifiersrequiredobject

Additive modifiers for integer format specifiers (e.g. { "%U": 1 } to increment the zero-indexed week number by 1)

Additional Properties
integer
Format: int32

CycleDirection

string
Enum variants (2)
  • "Previous"
  • "Next"

Configuration Usage

Referenced by

DateConfig

object
Properties (4)
enablerequiredboolean

Enable the Date widget

formatrequiredDateFormat

Set the Date format

label_prefixoptional LabelPrefix

Display label prefix

timezoneoptional string

TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html)

Use a custom format to display additional information, i.e.:

{
    "Date": {
        "enable": true,
        "format": { "Custom": "%D %Z (Tokyo)" },
        "timezone": "Asia/Tokyo"
     }
}

DateFormat

enum
Enum variants (6)
string

Month/Date/Year format (09/08/24)

Value: "MonthDateYear"
string

Year-Month-Date format (2024-09-08)

Value: "YearMonthDate"
string

Date-Month-Year format (8-Sep-2024)

Value: "DateMonthYear"
string

Day Date Month Year format (8 September 2024)

Value: "DayDateMonthYear"
object

Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)

Properties (1)
Customrequiredstring
object

Custom format with modifiers

Properties (1)
CustomModifiersrequiredCustomModifiers

DefaultLayout

string
Enum variants (9)
  • "BSP"
  • "Columns"
  • "Rows"
  • "VerticalStack"
  • "HorizontalStack"
  • "UltrawideVerticalStack"
  • "Grid"
  • "RightMainVerticalStack"
  • "Scrolling"

Configuration Usage

DisplayFormat

string enum
Enum variants (5)
string

Show only icon

Value: "Icon"
string

Show only text

Value: "Text"
string

Show an icon and text for the selected element, and text on the rest

Value: "TextAndIconOnSelected"
string

Show both icon and text

Value: "IconAndText"
string

Show an icon and text for the selected element, and icons on the rest

Value: "IconAndTextOnSelected"

FocusFollowsMouseImplementation

string enum
Enum variants (2)
string

A custom FFM implementation (slightly more CPU-intensive)

Value: "Komorebi"
string

The native (legacy) Windows FFM implementation

Value: "Windows"

FrameConfig

object
Properties (1)
inner_marginrequiredPosition

Margin inside the painted frame

Configuration Usage

Grouping

enum
Enum variants (4)
object

No grouping is applied

Properties (1)
kindrequiredstring
Value: "None"
GroupingConfig

Widgets are grouped as a whole

GroupingConfig

Widgets are grouped by alignment

GroupingConfig

Widgets are grouped individually

Configuration Usage

GroupingConfig

object
Properties (3)
roundingoptional RoundingConfig

Rounding values for the 4 corners. Can be a single or 4 values.

styleoptional GroupingStyle

Styles for the grouping

transparency_alphaoptional integer

Alpha value for the color transparency [[0-255]] (default: 200)

Format: uint8Min: 0Max: 255

Configuration Usage

Referenced by

GroupingStyle

enum
Enum variants (7)
string
Enum variants (1)
  • "Default"
string

A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3)

Value: "DefaultWithShadowB4O1S3"
string

A shadow is added under the default group. (blur: 4, offset: x-0 y-0, spread: 3)

Value: "DefaultWithShadowB4O0S3"
string

A shadow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 3)

Value: "DefaultWithShadowB0O1S3"
string

A glow is added under the default group. (blur: 3, offset: x-1 y-1, spread: 2)

Value: "DefaultWithGlowB3O1S2"
string

A glow is added under the default group. (blur: 3, offset: x-0 y-0, spread: 2)

Value: "DefaultWithGlowB3O0S2"
string

A glow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 2)

Value: "DefaultWithGlowB0O1S2"

Hex

string
Format: color-hex

Configuration Usage

Referenced by

HidingBehaviour

string enum
Enum variants (3)
string

END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)

Value: "Hide"
string

Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)

Value: "Minimize"
string

Use the undocumented SetCloak Win32 function to hide windows when switching workspaces

Value: "Cloak"

IndividualSpacingConfig

object
Properties (4)
bottomrequirednumber
Format: float
leftrequirednumber
Format: float
rightrequirednumber
Format: float
toprequirednumber
Format: float

Configuration Usage

Referenced by

KomobarTheme

enum
Enum variants (3)
object

A theme from catppuccin-egui

Properties (5)
accentoptional CatppuccinValue
auto_select_filloptional CatppuccinValue
auto_select_textoptional CatppuccinValue
namerequiredCatppuccin

Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin)

paletterequiredstring
Value: "Catppuccin"
object

A theme from base16-egui-themes

Properties (5)
accentoptional Base16Value
auto_select_filloptional Base16Value
auto_select_textoptional Base16Value
namerequiredBase16

Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/)

paletterequiredstring
Value: "Base16"
object

A custom Base16 theme

Properties (5)
accentoptional Base16Value
auto_select_filloptional Base16Value
auto_select_textoptional Base16Value
coloursrequiredBase16ColourPalette

Colours of the custom Base16 theme palette

paletterequiredstring
Value: "Custom"

Configuration Usage

KomorebiConfig

object
Properties (6)
configuration_switcheroptional KomorebiConfigurationSwitcherConfig

Configure the Configuration Switcher widget

focused_containeroptional KomorebiFocusedContainerConfig

Configure the Focused Container widget

layoutoptional KomorebiLayoutConfig

Configure the Layout widget

locked_containeroptional KomorebiLockedContainerConfig

Configure the Locked Container widget

workspace_layeroptional KomorebiWorkspaceLayerConfig

Configure the Workspace Layer widget

workspacesoptional KomorebiWorkspacesConfig

Configure the Workspaces widget

KomorebiFocusedContainerConfig

object
Properties (3)
displayoptional DisplayFormat

Display format of the currently focused container

enablerequiredboolean

Enable the Komorebi Focused Container widget

show_icondeprecatedoptional boolean

DEPRECATED: use display instead (Show the icon of the currently focused container)

KomorebiMouseMessage

object
Properties (3)
focus_monitor_at_cursoroptional boolean

Send the FocusMonitorAtCursor message (default:true)

ignore_mouse_follows_focusoptional boolean

Wrap the {message} with a MouseFollowsFocus(false) and MouseFollowsFocus({original.value}) message (default:true)

messagerequiredSocketMessage

The message to send to the komorebi client

KomorebiTheme

enum
Enum variants (3)
object

A theme from catppuccin-egui

Properties (12)
bar_accentoptional CatppuccinValue

Komorebi status bar accent (default: Blue)

floating_borderoptional CatppuccinValue

Border colour when the window is floating (default: Yellow)

monocle_borderoptional CatppuccinValue

Border colour when the container is in monocle mode (default: Pink)

namerequiredCatppuccin

Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin)

paletterequiredstring
Value: "Catppuccin"
single_borderoptional CatppuccinValue

Border colour when the container contains a single window (default: Blue)

stack_borderoptional CatppuccinValue

Border colour when the container contains multiple windows (default: Green)

stackbar_backgroundoptional CatppuccinValue

Stackbar tab background colour (default: Base)

stackbar_focused_textoptional CatppuccinValue

Stackbar focused tab text colour (default: Green)

stackbar_unfocused_textoptional CatppuccinValue

Stackbar unfocused tab text colour (default: Text)

unfocused_borderoptional CatppuccinValue

Border colour when the container is unfocused (default: Base)

unfocused_locked_borderoptional CatppuccinValue

Border colour when the container is unfocused and locked (default: Red)

object

A theme from base16-egui-themes

Properties (12)
bar_accentoptional Base16Value

Komorebi status bar accent (default: Base0D)

floating_borderoptional Base16Value

Border colour when the window is floating (default: Base09)

monocle_borderoptional Base16Value

Border colour when the container is in monocle mode (default: Base0F)

namerequiredBase16

Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/)

paletterequiredstring
Value: "Base16"
single_borderoptional Base16Value

Border colour when the container contains a single window (default: Base0D)

stack_borderoptional Base16Value

Border colour when the container contains multiple windows (default: Base0B)

stackbar_backgroundoptional Base16Value

Stackbar tab background colour (default: Base01)

stackbar_focused_textoptional Base16Value

Stackbar focused tab text colour (default: Base0B)

stackbar_unfocused_textoptional Base16Value

Stackbar unfocused tab text colour (default: Base05)

unfocused_borderoptional Base16Value

Border colour when the container is unfocused (default: Base01)

unfocused_locked_borderoptional Base16Value

Border colour when the container is unfocused and locked (default: Base08)

object

A custom Base16 theme

Properties (12)
bar_accentoptional Base16Value

Komorebi status bar accent (default: Base0D)

coloursrequiredBase16ColourPalette

Colours of the custom Base16 theme palette

floating_borderoptional Base16Value

Border colour when the window is floating (default: Base09)

monocle_borderoptional Base16Value

Border colour when the container is in monocle mode (default: Base0F)

paletterequiredstring
Value: "Custom"
single_borderoptional Base16Value

Border colour when the container contains a single window (default: Base0D)

stack_borderoptional Base16Value

Border colour when the container contains multiple windows (default: Base0B)

stackbar_backgroundoptional Base16Value

Stackbar tab background colour (default: Base01)

stackbar_focused_textoptional Base16Value

Stackbar focused tab text colour (default: Base0B)

stackbar_unfocused_textoptional Base16Value

Stackbar unfocused tab text colour (default: Base05)

unfocused_borderoptional Base16Value

Border colour when the container is unfocused (default: Base01)

unfocused_locked_borderoptional Base16Value

Border colour when the container is unfocused and locked (default: Base08)

LabelPrefix

string enum
Enum variants (4)
string

Show no prefix

Value: "None"
string

Show an icon

Value: "Icon"
string

Show text

Value: "Text"
string

Show an icon and text

Value: "IconAndText"

MemoryConfig

object
Properties (4)
auto_select_overoptional integer

Select when the current percentage is over this value [[1-100]]

Format: uint8Min: 0Max: 255
data_refresh_intervaloptional integer

Data refresh interval (default: 10 seconds)

Format: uint64Min: 0
enablerequiredboolean

Enable the Memory widget

label_prefixoptional LabelPrefix

Display label prefix

MonitorConfig

object
Properties (2)
indexrequiredinteger

Komorebi monitor index of the monitor on which to render the bar

Format: uintMin: 0
work_area_offsetoptional Rect

Automatically apply a work area offset for this monitor to accommodate the bar

Configuration Usage

Referenced by

MonitorConfigOrIndex

enum
Enum variants (2)
integer

The monitor index where you want the bar to show

Format: uintMin: 0
MonitorConfig

The full monitor options with the index and an optional work_area_offset

Configuration Usage

MouseConfig

object
Properties (11)
horizontal_scroll_thresholdoptional number

Defines how many points a user needs to scroll horizontally to make a "tick" on a mouse/touchpad/touchscreen (default: 30)

Format: float
on_extra1_clickoptional MouseMessage

Command to send on extra1/back button click

on_extra2_clickoptional MouseMessage

Command to send on extra2/forward button click

on_middle_clickoptional MouseMessage

Command to send on middle button click

on_primary_double_clickoptional MouseMessage

Command to send on primary/left double button click

on_scroll_downoptional MouseMessage

Command to send on scrolling down (every tick)

on_scroll_leftoptional MouseMessage

Command to send on scrolling left (every tick)

on_scroll_rightoptional MouseMessage

Command to send on scrolling right (every tick)

on_scroll_upoptional MouseMessage

Command to send on scrolling up (every tick)

on_secondary_clickoptional MouseMessage

Command to send on secondary/right button click

vertical_scroll_thresholdoptional number

Defines how many points a user needs to scroll vertically to make a "tick" on a mouse/touchpad/touchscreen (default: 30)

Format: float

Configuration Usage

MouseMessage

enum
Enum variants (2)
KomorebiMouseMessage

Send a message to the komorebi client. By default, a batch of messages are sent in the following order: FocusMonitorAtCursor => MouseFollowsFocus(false) => {message} => MouseFollowsFocus({original.value})

Example:

"on_extra2_click": {
  "message": {
    "type": "NewWorkspace"
  }
},

or:

"on_middle_click": {
  "focus_monitor_at_cursor": false,
  "ignore_mouse_follows_focus": false,
  "message": {
    "type": "TogglePause"
  }
}

or:

"on_scroll_up": {
  "message": {
    "type": "CycleFocusWorkspace",
    "content": "Previous"
  }
}
string

Execute a custom command. CMD (%variable%), Bash ($variable) and PowerShell ($Env:variable) variables will be resolved. Example: komorebic toggle-pause

MoveBehaviour

string enum
Enum variants (3)
string

Swap the window container with the window container at the edge of the adjacent monitor

Value: "Swap"
string

Insert the window container into the focused workspace on the adjacent monitor

Value: "Insert"
string

Do nothing if trying to move a window container in the direction of an adjacent monitor

Value: "NoOp"

NetworkConfig

object
Properties (8)
activity_left_paddingoptional integer

Characters to reserve for received and transmitted activity

Format: uintMin: 0
auto_selectoptional NetworkSelectConfig

Select when the value is over a limit (1MiB is 1048576 bytes (1024*1024))

data_refresh_intervaloptional integer

Data refresh interval (default: 10 seconds)

Format: uint64Min: 0
enablerequiredboolean

Enable the Network widget

label_prefixoptional LabelPrefix

Display label prefix

show_activityrequiredboolean

Show received and transmitted activity

show_default_interfaceoptional boolean

Show default interface

show_total_activityrequiredboolean

Show total received and transmitted activity

NetworkSelectConfig

object
Properties (4)
received_overoptional integer

Select the received data when it's over this value

Format: uint64Min: 0
total_received_overoptional integer

Select the total received data when it's over this value

Format: uint64Min: 0
total_transmitted_overoptional integer

Select the total transmitted data when it's over this value

Format: uint64Min: 0
transmitted_overoptional integer

Select the transmitted data when it's over this value

Format: uint64Min: 0

OperationBehaviour

string enum
Enum variants (2)
string

Process komorebic commands on temporarily unmanaged/floated windows

Value: "Op"
string

Ignore komorebic commands on temporarily unmanaged/floated windows

Value: "NoOp"

OperationDirection

string
Enum variants (4)
  • "Left"
  • "Right"
  • "Up"
  • "Down"

Configuration Usage

Referenced by

PathBuf

string

Configuration Usage

Referenced by

PositionConfig

object
Properties (2)
endoptional Position

The desired size of the bar from the starting position (usually monitor width x desired height)

startoptional Position

The desired starting position of the bar (0,0 = top left of the screen)

Configuration Usage

Rect

object
Properties (4)
bottomrequiredinteger

The bottom point in a Win32 Rect

Format: int32
leftrequiredinteger

The left point in a Win32 Rect

Format: int32
rightrequiredinteger

The right point in a Win32 Rect

Format: int32
toprequiredinteger

The top point in a Win32 Rect

Format: int32

Configuration Usage

Rgb

object
Properties (3)
brequiredinteger

Blue

Format: uint32Min: 0
grequiredinteger

Green

Format: uint32Min: 0
rrequiredinteger

Red

Format: uint32Min: 0

Configuration Usage

Referenced by

Sizing

string
Enum variants (2)
  • "Increase"
  • "Decrease"

Configuration Usage

Referenced by

SocketMessage

enum
Enum variants (183)
object
Properties (2)
contentrequiredOperationDirection
typerequiredstring
Value: "FocusWindow"
object
Properties (2)
contentrequiredOperationDirection
typerequiredstring
Value: "MoveWindow"
object
Properties (2)
contentrequiredOperationDirection
typerequiredstring
Value: "PreselectDirection"
object
Properties (1)
typerequiredstring
Value: "CancelPreselect"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleFocusWindow"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleMoveWindow"
object
Properties (2)
contentrequiredOperationDirection
typerequiredstring
Value: "StackWindow"
object
Properties (1)
typerequiredstring
Value: "UnstackWindow"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleStack"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleStackIndex"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "FocusStackWindow"
object
Properties (1)
typerequiredstring
Value: "StackAll"
object
Properties (1)
typerequiredstring
Value: "UnstackAll"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
typerequiredstring
Value: "ResizeWindowEdge"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
[1]
typerequiredstring
Value: "ResizeWindowAxis"
object
Properties (1)
typerequiredstring
Value: "MoveContainerToLastWorkspace"
object
Properties (1)
typerequiredstring
Value: "SendContainerToLastWorkspace"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "MoveContainerToMonitorNumber"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleMoveContainerToMonitor"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "MoveContainerToWorkspaceNumber"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "MoveContainerToNamedWorkspace"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleMoveContainerToWorkspace"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "SendContainerToMonitorNumber"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleSendContainerToMonitor"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "SendContainerToWorkspaceNumber"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleSendContainerToWorkspace"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "SendContainerToMonitorWorkspaceNumber"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "MoveContainerToMonitorWorkspaceNumber"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "SendContainerToNamedWorkspace"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleMoveWorkspaceToMonitor"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "MoveWorkspaceToMonitorNumber"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "SwapWorkspacesToMonitorNumber"
object
Properties (1)
typerequiredstring
Value: "ForceFocus"
object
Properties (1)
typerequiredstring
Value: "Close"
object
Properties (1)
typerequiredstring
Value: "Minimize"
object
Properties (1)
typerequiredstring
Value: "Promote"
object
Properties (1)
typerequiredstring
Value: "PromoteSwap"
object
Properties (1)
typerequiredstring
Value: "PromoteFocus"
object
Properties (2)
contentrequiredOperationDirection
typerequiredstring
Value: "PromoteWindow"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "EagerFocus"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "LockMonitorWorkspaceContainer"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "UnlockMonitorWorkspaceContainer"
object
Properties (1)
typerequiredstring
Value: "ToggleLock"
object
Properties (1)
typerequiredstring
Value: "ToggleFloat"
object
Properties (1)
typerequiredstring
Value: "ToggleMonocle"
object
Properties (1)
typerequiredstring
Value: "ToggleMaximize"
object
Properties (1)
typerequiredstring
Value: "ToggleWindowContainerBehaviour"
object
Properties (1)
typerequiredstring
Value: "ToggleFloatOverride"
object
Properties (2)
contentrequiredHidingBehaviour
typerequiredstring
Value: "WindowHidingBehaviour"
object
Properties (1)
typerequiredstring
Value: "ToggleCrossMonitorMoveBehaviour"
object
Properties (2)
contentrequiredMoveBehaviour
typerequiredstring
Value: "CrossMonitorMoveBehaviour"
object
Properties (2)
contentrequiredOperationBehaviour
typerequiredstring
Value: "UnmanagedWindowOperationBehaviour"
object
Properties (1)
typerequiredstring
Value: "ManageFocusedWindow"
object
Properties (1)
typerequiredstring
Value: "UnmanageFocusedWindow"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
[1]
integer
Format: int32
typerequiredstring
Value: "AdjustContainerPadding"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
[1]
integer
Format: int32
typerequiredstring
Value: "AdjustWorkspacePadding"
object
Properties (2)
contentrequiredDefaultLayout
typerequiredstring
Value: "ChangeLayout"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleLayout"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 1
typerequiredstring
Value: "ScrollingLayoutColumns"
object
Properties (2)
contentrequiredPathBuf
typerequiredstring
Value: "ChangeLayoutCustom"
object
Properties (2)
contentrequiredAxis
typerequiredstring
Value: "FlipLayout"
object
Properties (1)
typerequiredstring
Value: "ToggleWorkspaceWindowContainerBehaviour"
object
Properties (1)
typerequiredstring
Value: "ToggleWorkspaceFloatOverride"
object
Properties (2)
contentrequiredarray integer; 5
typerequiredstring
Value: "MonitorIndexPreference"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
integer
Format: uintMin: 0
[1]
string
typerequiredstring
Value: "DisplayIndexPreference"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "EnsureWorkspaces"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
integer
Format: uintMin: 0
[1]
array string
typerequiredstring
Value: "EnsureNamedWorkspaces"
object
Properties (1)
typerequiredstring
Value: "NewWorkspace"
object
Properties (1)
typerequiredstring
Value: "ToggleTiling"
object
Properties (1)
typerequiredstring
Value: "Stop"
object
Properties (1)
typerequiredstring
Value: "StopIgnoreRestore"
object
Properties (1)
typerequiredstring
Value: "TogglePause"
object
Properties (1)
typerequiredstring
Value: "Retile"
object
Properties (1)
typerequiredstring
Value: "RetileWithResizeDimensions"
object
Properties (1)
typerequiredstring
Value: "QuickSave"
object
Properties (1)
typerequiredstring
Value: "QuickLoad"
object
Properties (2)
contentrequiredPathBuf
typerequiredstring
Value: "Save"
object
Properties (2)
contentrequiredPathBuf
typerequiredstring
Value: "Load"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleFocusMonitor"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleFocusWorkspace"
object
Properties (2)
contentrequiredCycleDirection
typerequiredstring
Value: "CycleFocusEmptyWorkspace"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "FocusMonitorNumber"
object
Properties (1)
typerequiredstring
Value: "FocusMonitorAtCursor"
object
Properties (1)
typerequiredstring
Value: "FocusLastWorkspace"
object
Properties (1)
typerequiredstring
Value: "CloseWorkspace"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "FocusWorkspaceNumber"
object
Properties (2)
contentrequiredinteger
Format: uintMin: 0
typerequiredstring
Value: "FocusWorkspaceNumbers"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "FocusMonitorWorkspaceNumber"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "FocusNamedWorkspace"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "ContainerPadding"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
[1]
integer
Format: int32
typerequiredstring
Value: "NamedWorkspaceContainerPadding"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "FocusedWorkspaceContainerPadding"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "WorkspacePadding"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
[1]
integer
Format: int32
typerequiredstring
Value: "NamedWorkspacePadding"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "FocusedWorkspacePadding"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
boolean
typerequiredstring
Value: "WorkspaceTiling"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
[1]
boolean
typerequiredstring
Value: "NamedWorkspaceTiling"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
string
typerequiredstring
Value: "WorkspaceName"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
typerequiredstring
Value: "WorkspaceLayout"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
typerequiredstring
Value: "NamedWorkspaceLayout"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
typerequiredstring
Value: "WorkspaceLayoutCustom"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
[1]
typerequiredstring
Value: "NamedWorkspaceLayoutCustom"
object
Properties (2)
contentrequiredarray tuple
Min items: 4Max items: 4
Tuple Items (4)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
integer
Format: uintMin: 0
typerequiredstring
Value: "WorkspaceLayoutRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
string
[1]
integer
Format: uintMin: 0
typerequiredstring
Value: "NamedWorkspaceLayoutRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 4Max items: 4
Tuple Items (4)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
integer
Format: uintMin: 0
[3]
typerequiredstring
Value: "WorkspaceLayoutCustomRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
string
[1]
integer
Format: uintMin: 0
[2]
typerequiredstring
Value: "NamedWorkspaceLayoutCustomRule"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "ClearWorkspaceLayoutRules"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "ClearNamedWorkspaceLayoutRules"
object
Properties (1)
typerequiredstring
Value: "ToggleWorkspaceLayer"
object
Properties (1)
typerequiredstring
Value: "ReloadConfiguration"
object
Properties (2)
contentrequiredPathBuf
typerequiredstring
Value: "ReplaceConfiguration"
object
Properties (2)
contentrequiredPathBuf
typerequiredstring
Value: "ReloadStaticConfiguration"
object
Properties (2)
contentrequiredboolean
typerequiredstring
Value: "WatchConfiguration"
object
Properties (1)
typerequiredstring
Value: "CompleteConfiguration"
object
Properties (2)
contentrequiredboolean
typerequiredstring
Value: "AltFocusHack"
object
Properties (2)
contentrequiredKomorebiTheme
typerequiredstring
Value: "Theme"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
boolean
[1]
optional AnimationPrefix
typerequiredstring
Value: "Animation"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
integer
Format: uint64Min: 0
[1]
optional AnimationPrefix
typerequiredstring
Value: "AnimationDuration"
object
Properties (2)
contentrequiredinteger
Format: uint64Min: 0
typerequiredstring
Value: "AnimationFps"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
typerequiredstring
Value: "AnimationStyle"
object
Properties (2)
contentrequiredboolean
typerequiredstring
Value: "Border"
object
Properties (2)
contentrequiredarray tuple
Min items: 4Max items: 4
Tuple Items (4)
[1]
integer
Format: uint32Min: 0
[2]
integer
Format: uint32Min: 0
[3]
integer
Format: uint32Min: 0
typerequiredstring
Value: "BorderColour"
object
Properties (2)
contentrequiredBorderStyle
typerequiredstring
Value: "BorderStyle"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "BorderWidth"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "BorderOffset"
object
Properties (2)
contentrequiredBorderImplementation
typerequiredstring
Value: "BorderImplementation"
object
Properties (2)
contentrequiredboolean
typerequiredstring
Value: "Transparency"
object
Properties (1)
typerequiredstring
Value: "ToggleTransparency"
object
Properties (2)
contentrequiredinteger
Format: uint8Min: 0Max: 255
typerequiredstring
Value: "TransparencyAlpha"
object
Properties (2)
contentrequiredRect
typerequiredstring
Value: "InvisibleBorders"
object
Properties (2)
contentrequiredStackbarMode
typerequiredstring
Value: "StackbarMode"
object
Properties (2)
contentrequiredStackbarLabel
typerequiredstring
Value: "StackbarLabel"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "StackbarFocusedTextColour"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "StackbarUnfocusedTextColour"
object
Properties (2)
contentrequiredarray integer; 3
typerequiredstring
Value: "StackbarBackgroundColour"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "StackbarHeight"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "StackbarTabWidth"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "StackbarFontSize"
object
Properties (2)
contentrequiredoptional string
typerequiredstring
Value: "StackbarFontFamily"
object
Properties (2)
contentrequiredRect
typerequiredstring
Value: "WorkAreaOffset"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
integer
Format: uintMin: 0
[1]
typerequiredstring
Value: "MonitorWorkAreaOffset"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[0]
integer
Format: uintMin: 0
[1]
integer
Format: uintMin: 0
[2]
typerequiredstring
Value: "WorkspaceWorkAreaOffset"
object
Properties (1)
typerequiredstring
Value: "ToggleWindowBasedWorkAreaOffset"
object
Properties (2)
contentrequiredinteger
Format: int32
typerequiredstring
Value: "ResizeDelta"
object
Properties (2)
contentrequiredarray tuple
Min items: 4Max items: 4
Tuple Items (4)
[1]
string
[2]
integer
Format: uintMin: 0
[3]
integer
Format: uintMin: 0
typerequiredstring
Value: "InitialWorkspaceRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[1]
string
[2]
string
typerequiredstring
Value: "InitialNamedWorkspaceRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 4Max items: 4
Tuple Items (4)
[1]
string
[2]
integer
Format: uintMin: 0
[3]
integer
Format: uintMin: 0
typerequiredstring
Value: "WorkspaceRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 3Max items: 3
Tuple Items (3)
[1]
string
[2]
string
typerequiredstring
Value: "NamedWorkspaceRule"
object
Properties (2)
contentrequiredarray integer; 2
typerequiredstring
Value: "ClearWorkspaceRules"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "ClearNamedWorkspaceRules"
object
Properties (1)
typerequiredstring
Value: "ClearAllWorkspaceRules"
object
Properties (1)
typerequiredstring
Value: "EnforceWorkspaceRules"
object
Properties (1)
typerequiredstring
Value: "SessionFloatRule"
object
Properties (1)
typerequiredstring
Value: "SessionFloatRules"
object
Properties (1)
typerequiredstring
Value: "ClearSessionFloatRules"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "IgnoreRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "ManageRule"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "IdentifyObjectNameChangeApplication"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "IdentifyTrayApplication"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "IdentifyLayeredApplication"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "IdentifyBorderOverflowApplication"
object
Properties (1)
typerequiredstring
Value: "State"
object
Properties (1)
typerequiredstring
Value: "GlobalState"
object
Properties (1)
typerequiredstring
Value: "VisibleWindows"
object
Properties (1)
typerequiredstring
Value: "MonitorInformation"
object
Properties (2)
contentrequiredStateQuery
typerequiredstring
Value: "Query"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
typerequiredstring
Value: "FocusFollowsMouse"
object
Properties (2)
typerequiredstring
Value: "ToggleFocusFollowsMouse"
object
Properties (2)
contentrequiredboolean
typerequiredstring
Value: "MouseFollowsFocus"
object
Properties (1)
typerequiredstring
Value: "ToggleMouseFollowsFocus"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[1]
string
typerequiredstring
Value: "RemoveTitleBar"
object
Properties (1)
typerequiredstring
Value: "ToggleTitleBars"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "AddSubscriberSocket"
object
Properties (2)
contentrequiredarray tuple
Min items: 2Max items: 2
Tuple Items (2)
[0]
string
typerequiredstring
Value: "AddSubscriberSocketWithOptions"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "RemoveSubscriberSocket"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "AddSubscriberPipe"
object
Properties (2)
contentrequiredstring
typerequiredstring
Value: "RemoveSubscriberPipe"
object
Properties (1)
typerequiredstring
Value: "ApplicationSpecificConfigurationSchema"
object
Properties (1)
typerequiredstring
Value: "NotificationSchema"
object
Properties (1)
typerequiredstring
Value: "SocketSchema"
object
Properties (1)
typerequiredstring
Value: "StaticConfigSchema"
object
Properties (1)
typerequiredstring
Value: "GenerateStaticConfig"
object
Properties (2)
contentrequiredinteger
Format: int
typerequiredstring
Value: "DebugWindow"

StateQuery

string
Enum variants (8)
  • "FocusedMonitorIndex"
  • "FocusedWorkspaceIndex"
  • "FocusedContainerIndex"
  • "FocusedWindowIndex"
  • "FocusedWorkspaceName"
  • "FocusedWorkspaceLayout"
  • "FocusedContainerKind"
  • "Version"

StorageConfig

object
Properties (7)
auto_hide_underoptional integer

Hide when the current percentage is under this value [[1-100]]

Format: uint8Min: 0Max: 255
auto_select_overoptional integer

Select when the current percentage is over this value [[1-100]]

Format: uint8Min: 0Max: 255
data_refresh_intervaloptional integer

Data refresh interval (default: 10 seconds)

Format: uint64Min: 0
enablerequiredboolean

Enable the Storage widget

label_prefixoptional LabelPrefix

Display label prefix

show_read_only_disksoptional boolean

Show disks that are read only. (default: false)

show_removable_disksoptional boolean

Show removable disks. (default: true)

SubscribeOptions

object
Properties (1)
filter_state_changesrequiredboolean

Only emit notifications when the window manager state has changed

TimeConfig

object
Properties (5)
changing_iconoptional boolean

Change the icon depending on the time. The default icon is used between 8:30 and 12:00. (default: false)

enablerequiredboolean

Enable the Time widget

formatrequiredTimeFormat

Set the Time format

label_prefixoptional LabelPrefix

Display label prefix

timezoneoptional string

TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html)

Use a custom format to display additional information, i.e.:

{
    "Time": {
        "enable": true,
        "format": { "Custom": "%T %Z (Tokyo)" },
        "timezone": "Asia/Tokyo"
     }
}

TimeFormat

enum
Enum variants (7)
string

Twelve-hour format (with seconds)

Value: "TwelveHour"
string

Twelve-hour format (without seconds)

Value: "TwelveHourWithoutSeconds"
string

Twenty-four-hour format (with seconds)

Value: "TwentyFourHour"
string

Twenty-four-hour format (without seconds)

Value: "TwentyFourHourWithoutSeconds"
string

Twenty-four-hour format displayed as a binary clock with circles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock)

Value: "BinaryCircle"
string

Twenty-four-hour format displayed as a binary clock with rectangles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock)

Value: "BinaryRectangle"
object

Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)

Properties (1)
Customrequiredstring

WidgetConfig

enum
Enum variants (12)
object
Properties (1)
ApplicationsrequiredApplicationsConfig
object
Properties (1)
BatteryrequiredBatteryConfig
object
Properties (1)
CpurequiredCpuConfig
object
Properties (1)
DaterequiredDateConfig
object
Properties (1)
KeyboardrequiredKeyboardConfig
object
Properties (1)
KomorebirequiredKomorebiConfig
object
Properties (1)
MediarequiredMediaConfig
object
Properties (1)
MemoryrequiredMemoryConfig
object
Properties (1)
NetworkrequiredNetworkConfig
object
Properties (1)
StoragerequiredStorageConfig
object
Properties (1)
TimerequiredTimeConfig
object
Properties (1)
UpdaterequiredUpdateConfig

WindowKind

string
Enum variants (6)
  • "Single"
  • "Stack"
  • "Monocle"
  • "Unfocused"
  • "UnfocusedLocked"
  • "Floating"