Skip to content

komorebi.bar.json (Windows)

required array WidgetConfig

Left side widgets (ordered left-to-right)


required array WidgetConfig

Right side widgets (ordered left-to-right)


optional array WidgetConfig

Center widgets (ordered left-to-right)


optional string

Font family


optional number

Font size

  • Format: float

Default: 12.5


optional FrameConfig

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


optional Grouping

Visual grouping for widgets


optional number

Bar height

  • Format: float

Default: 50


optional number

Scale of the icons relative to the font_size [[1.0-2.0]]

  • Format: float

Default: 1.4


optional 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.


optional number

Max label width before text truncation

  • Format: float

Default: 400.0


optional MonitorConfigOrIndex

The monitor index or the full monitor options


optional MouseConfig

Options for mouse interaction on the bar


optional 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.


optional PositionConfig

Bar positioning options


optional KomobarTheme

Theme


optional integer

Alpha value for the color transparency [[0-255]]

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

Default: 200


optional number

Spacing between widgets

  • Format: float

Default: 10.0


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

Configuration:

Referenced by:


Mathematical function which describes the rate at which a value changes

Enum variants (32)

Linear

Value: "Linear"


Ease in sine

Value: "EaseInSine"


Ease out sine

Value: "EaseOutSine"


Ease in out sine

Value: "EaseInOutSine"


Ease in quad

Value: "EaseInQuad"


Ease out quad

Value: "EaseOutQuad"


Ease in out quad

Value: "EaseInOutQuad"


Ease in cubic

Value: "EaseInCubic"


Ease out cubic

Value: "EaseOutCubic"


Ease in out cubic

Value: "EaseInOutCubic"


Ease in quart

Value: "EaseInQuart"


Ease out quart

Value: "EaseOutQuart"


Ease in out quart

Value: "EaseInOutQuart"


Ease in quint

Value: "EaseInQuint"


Ease out quint

Value: "EaseOutQuint"


Ease in out quint

Value: "EaseInOutQuint"


Ease in expo

Value: "EaseInExpo"


Ease out expo

Value: "EaseOutExpo"


Ease in out expo

Value: "EaseInOutExpo"


Ease in circ

Value: "EaseInCirc"


Ease out circ

Value: "EaseOutCirc"


Ease in out circ

Value: "EaseInOutCirc"


Ease in back

Value: "EaseInBack"


Ease out back

Value: "EaseOutBack"


Ease in out back

Value: "EaseInOutBack"


Ease in elastic

Value: "EaseInElastic"


Ease out elastic

Value: "EaseOutElastic"


Ease in out elastic

Value: "EaseInOutElastic"


Ease in bounce

Value: "EaseInBounce"


Ease out bounce

Value: "EaseOutBounce"


Ease in out bounce

Value: "EaseInOutBounce"


Custom Cubic Bezier function

Value: CubicBezierarray [double; 4]

Configuration:

Referenced by:


Application button configuration

Properties (6)

required string

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

required string

Display name of the application.

optional ApplicationsDisplayFormat

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

optional boolean

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

optional 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.

optional boolean

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

Referenced by:


Application identifier

Enum variants (4)

Executable name

Value: "Exe"


Class

Value: "Class"


Window title

Value: "Title"


Executable path

Value: "Path"

Configuration:

Referenced by:


Applications widget configuration

Properties (5)

required boolean

Enables or disables the applications widget.

required array AppConfig

List of configured applications to display.

optional ApplicationsDisplayFormat

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

optional boolean

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

optional number

Horizontal spacing between application buttons.

  • Format: float

Referenced by:


Applications widget display format

Enum variants (3)

Show only the application icon.

Value: "Icon"


Show only the application name as text.

Value: "Text"


Show both the application icon and name.

Value: "IconAndText"

Referenced by:


Axis on which to perform an operation

Enum variants (3)

Horizontal axis

Value: "Horizontal"


Vertical axis

Value: "Vertical"


Both horizontal and vertical axes

Value: "HorizontalAndVertical"

Configuration:

Referenced by:


Base 16 colour palette

Enum variants (269)

3024 (https://tinted-theming.github.io/tinted-gallery/#base16-3024)

Value: "3024"


Apathy (https://tinted-theming.github.io/tinted-gallery/#base16-apathy)

Value: "Apathy"


Apprentice (https://tinted-theming.github.io/tinted-gallery/#base16-apprentice)

Value: "Apprentice"


Ashes (https://tinted-theming.github.io/tinted-gallery/#base16-ashes)

Value: "Ashes"


Atelier Cave Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-cave-light)

Value: "AtelierCaveLight"


Atelier Cave (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-cave)

Value: "AtelierCave"


Atelier Dune Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-dune-light)

Value: "AtelierDuneLight"


Atelier Dune (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-dune)

Value: "AtelierDune"


Atelier Estuary Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-estuary-light)

Value: "AtelierEstuaryLight"


Atelier Estuary (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-estuary)

Value: "AtelierEstuary"


Atelier Forest Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-forest-light)

Value: "AtelierForestLight"


Atelier Forest (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-forest)

Value: "AtelierForest"


Atelier Heath Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-heath-light)

Value: "AtelierHeathLight"


Atelier Heath (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-heath)

Value: "AtelierHeath"


Atelier Lakeside Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-lakeside-light)

Value: "AtelierLakesideLight"


Atelier Lakeside (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-lakeside)

Value: "AtelierLakeside"


Atelier Plateau Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-plateau-light)

Value: "AtelierPlateauLight"


Atelier Plateau (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-plateau)

Value: "AtelierPlateau"


Atelier Savanna Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-savanna-light)

Value: "AtelierSavannaLight"


Atelier Savanna (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-savanna)

Value: "AtelierSavanna"


Atelier Seaside Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-seaside-light)

Value: "AtelierSeasideLight"


Atelier Seaside (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-seaside)

Value: "AtelierSeaside"


Atelier Sulphurpool Light (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-sulphurpool-light)

Value: "AtelierSulphurpoolLight"


Atelier Sulphurpool (https://tinted-theming.github.io/tinted-gallery/#base16-atelier-sulphurpool)

Value: "AtelierSulphurpool"


Atlas (https://tinted-theming.github.io/tinted-gallery/#base16-atlas)

Value: "Atlas"


Ayu Dark (https://tinted-theming.github.io/tinted-gallery/#base16-ayu-dark)

Value: "AyuDark"


Ayu Light (https://tinted-theming.github.io/tinted-gallery/#base16-ayu-light)

Value: "AyuLight"


Ayu Mirage (https://tinted-theming.github.io/tinted-gallery/#base16-ayu-mirage)

Value: "AyuMirage"


Aztec (https://tinted-theming.github.io/tinted-gallery/#base16-aztec)

Value: "Aztec"


Bespin (https://tinted-theming.github.io/tinted-gallery/#base16-bespin)

Value: "Bespin"


Black Metal Bathory (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-bathory)

Value: "BlackMetalBathory"


Black Metal Burzum (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-burzum)

Value: "BlackMetalBurzum"


Black Metal Dark Funeral (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-dark-funeral)

Value: "BlackMetalDarkFuneral"


Black Metal Gorgoroth (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-gorgoroth)

Value: "BlackMetalGorgoroth"


Black Metal Immortal (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-immortal)

Value: "BlackMetalImmortal"


Black Metal Khold (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-khold)

Value: "BlackMetalKhold"


Black Metal Marduk (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-marduk)

Value: "BlackMetalMarduk"


Black Metal Mayhem (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-mayhem)

Value: "BlackMetalMayhem"


Black Metal Nile (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-nile)

Value: "BlackMetalNile"


Black Metal Venom (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal-venom)

Value: "BlackMetalVenom"


Black Metal (https://tinted-theming.github.io/tinted-gallery/#base16-black-metal)

Value: "BlackMetal"


Blueforest (https://tinted-theming.github.io/tinted-gallery/#base16-blueforest)

Value: "Blueforest"


Blueish (https://tinted-theming.github.io/tinted-gallery/#base16-blueish)

Value: "Blueish"


Brewer (https://tinted-theming.github.io/tinted-gallery/#base16-brewer)

Value: "Brewer"


Bright (https://tinted-theming.github.io/tinted-gallery/#base16-bright)

Value: "Bright"


Brogrammer (https://tinted-theming.github.io/tinted-gallery/#base16-brogrammer)

Value: "Brogrammer"


Brushtrees Dark (https://tinted-theming.github.io/tinted-gallery/#base16-brushtrees-dark)

Value: "BrushtreesDark"


Brushtrees (https://tinted-theming.github.io/tinted-gallery/#base16-brushtrees)

Value: "Brushtrees"


Caroline (https://tinted-theming.github.io/tinted-gallery/#base16-caroline)

Value: "Caroline"


Catppuccin Frappe (https://tinted-theming.github.io/tinted-gallery/#base16-catppuccin-frappe)

Value: "CatppuccinFrappe"


Catppuccin Latte (https://tinted-theming.github.io/tinted-gallery/#base16-catppuccin-latte)

Value: "CatppuccinLatte"


Catppuccin Macchiato (https://tinted-theming.github.io/tinted-gallery/#base16-catppuccin-macchiato)

Value: "CatppuccinMacchiato"


Catppuccin Mocha (https://tinted-theming.github.io/tinted-gallery/#base16-catppuccin-mocha)

Value: "CatppuccinMocha"


Chalk (https://tinted-theming.github.io/tinted-gallery/#base16-chalk)

Value: "Chalk"


Circus (https://tinted-theming.github.io/tinted-gallery/#base16-circus)

Value: "Circus"


Classic Dark (https://tinted-theming.github.io/tinted-gallery/#base16-classic-dark)

Value: "ClassicDark"


Classic Light (https://tinted-theming.github.io/tinted-gallery/#base16-classic-light)

Value: "ClassicLight"


Codeschool (https://tinted-theming.github.io/tinted-gallery/#base16-codeschool)

Value: "Codeschool"


Colors (https://tinted-theming.github.io/tinted-gallery/#base16-colors)

Value: "Colors"


Cupcake (https://tinted-theming.github.io/tinted-gallery/#base16-cupcake)

Value: "Cupcake"


Cupertino (https://tinted-theming.github.io/tinted-gallery/#base16-cupertino)

Value: "Cupertino"


Da One Black (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-black)

Value: "DaOneBlack"


Da One Gray (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-gray)

Value: "DaOneGray"


Da One Ocean (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-ocean)

Value: "DaOneOcean"


Da One Paper (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-paper)

Value: "DaOnePaper"


Da One Sea (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-sea)

Value: "DaOneSea"


Da One White (https://tinted-theming.github.io/tinted-gallery/#base16-da-one-white)

Value: "DaOneWhite"


Danqing Light (https://tinted-theming.github.io/tinted-gallery/#base16-danqing-light)

Value: "DanqingLight"


Danqing (https://tinted-theming.github.io/tinted-gallery/#base16-danqing)

Value: "Danqing"


Darcula (https://tinted-theming.github.io/tinted-gallery/#base16-darcula)

Value: "Darcula"


Darkmoss (https://tinted-theming.github.io/tinted-gallery/#base16-darkmoss)

Value: "Darkmoss"


Darktooth (https://tinted-theming.github.io/tinted-gallery/#base16-darktooth)

Value: "Darktooth"


Darkviolet (https://tinted-theming.github.io/tinted-gallery/#base16-darkviolet)

Value: "Darkviolet"


Decaf (https://tinted-theming.github.io/tinted-gallery/#base16-decaf)

Value: "Decaf"


Default Dark (https://tinted-theming.github.io/tinted-gallery/#base16-default-dark)

Value: "DefaultDark"


Default Light (https://tinted-theming.github.io/tinted-gallery/#base16-default-light)

Value: "DefaultLight"


Dirtysea (https://tinted-theming.github.io/tinted-gallery/#base16-dirtysea)

Value: "Dirtysea"


Dracula (https://tinted-theming.github.io/tinted-gallery/#base16-dracula)

Value: "Dracula"


Edge Dark (https://tinted-theming.github.io/tinted-gallery/#base16-edge-dark)

Value: "EdgeDark"


Edge Light (https://tinted-theming.github.io/tinted-gallery/#base16-edge-light)

Value: "EdgeLight"


Eighties (https://tinted-theming.github.io/tinted-gallery/#base16-eighties)

Value: "Eighties"


Embers Light (https://tinted-theming.github.io/tinted-gallery/#base16-embers-light)

Value: "EmbersLight"


Embers (https://tinted-theming.github.io/tinted-gallery/#base16-embers)

Value: "Embers"


Emil (https://tinted-theming.github.io/tinted-gallery/#base16-emil)

Value: "Emil"


Equilibrium Dark (https://tinted-theming.github.io/tinted-gallery/#base16-equilibrium-dark)

Value: "EquilibriumDark"


Equilibrium Gray Dark (https://tinted-theming.github.io/tinted-gallery/#base16-equilibrium-gray-dark)

Value: "EquilibriumGrayDark"


Equilibrium Gray Light (https://tinted-theming.github.io/tinted-gallery/#base16-equilibrium-gray-light)

Value: "EquilibriumGrayLight"


Equilibrium Light (https://tinted-theming.github.io/tinted-gallery/#base16-equilibrium-light)

Value: "EquilibriumLight"


Eris (https://tinted-theming.github.io/tinted-gallery/#base16-eris)

Value: "Eris"


Espresso (https://tinted-theming.github.io/tinted-gallery/#base16-espresso)

Value: "Espresso"


Eva Dim (https://tinted-theming.github.io/tinted-gallery/#base16-eva-dim)

Value: "EvaDim"


Eva (https://tinted-theming.github.io/tinted-gallery/#base16-eva)

Value: "Eva"


Evenok Dark (https://tinted-theming.github.io/tinted-gallery/#base16-evenok-dark)

Value: "EvenokDark"


Everforest Dark Hard (https://tinted-theming.github.io/tinted-gallery/#base16-everforest-dark-hard)

Value: "EverforestDarkHard"


Everforest (https://tinted-theming.github.io/tinted-gallery/#base16-everforest)

Value: "Everforest"


Flat (https://tinted-theming.github.io/tinted-gallery/#base16-flat)

Value: "Flat"


Framer (https://tinted-theming.github.io/tinted-gallery/#base16-framer)

Value: "Framer"


Fruit Soda (https://tinted-theming.github.io/tinted-gallery/#base16-fruit-soda)

Value: "FruitSoda"


Gigavolt (https://tinted-theming.github.io/tinted-gallery/#base16-gigavolt)

Value: "Gigavolt"


Github (https://tinted-theming.github.io/tinted-gallery/#base16-github)

Value: "Github"


Google Dark (https://tinted-theming.github.io/tinted-gallery/#base16-google-dark)

Value: "GoogleDark"


Google Light (https://tinted-theming.github.io/tinted-gallery/#base16-google-light)

Value: "GoogleLight"


Gotham (https://tinted-theming.github.io/tinted-gallery/#base16-gotham)

Value: "Gotham"


Grayscale Dark (https://tinted-theming.github.io/tinted-gallery/#base16-grayscale-dark)

Value: "GrayscaleDark"


Grayscale Light (https://tinted-theming.github.io/tinted-gallery/#base16-grayscale-light)

Value: "GrayscaleLight"


Greenscreen (https://tinted-theming.github.io/tinted-gallery/#base16-greenscreen)

Value: "Greenscreen"


Gruber (https://tinted-theming.github.io/tinted-gallery/#base16-gruber)

Value: "Gruber"


Gruvbox Dark Hard (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-dark-hard)

Value: "GruvboxDarkHard"


Gruvbox Dark Medium (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-dark-medium)

Value: "GruvboxDarkMedium"


Gruvbox Dark Pale (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-dark-pale)

Value: "GruvboxDarkPale"


Gruvbox Dark Soft (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-dark-soft)

Value: "GruvboxDarkSoft"


Gruvbox Light Hard (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-light-hard)

Value: "GruvboxLightHard"


Gruvbox Light Medium (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-light-medium)

Value: "GruvboxLightMedium"


Gruvbox Light Soft (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-light-soft)

Value: "GruvboxLightSoft"


Gruvbox Material Dark Hard (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-dark-hard)

Value: "GruvboxMaterialDarkHard"


Gruvbox Material Dark Medium (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-dark-medium)

Value: "GruvboxMaterialDarkMedium"


Gruvbox Material Dark Soft (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-dark-soft)

Value: "GruvboxMaterialDarkSoft"


Gruvbox Material Light Hard (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-light-hard)

Value: "GruvboxMaterialLightHard"


Gruvbox Material Light Medium (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-light-medium)

Value: "GruvboxMaterialLightMedium"


Gruvbox Material Light Soft (https://tinted-theming.github.io/tinted-gallery/#base16-gruvbox-material-light-soft)

Value: "GruvboxMaterialLightSoft"


Hardcore (https://tinted-theming.github.io/tinted-gallery/#base16-hardcore)

Value: "Hardcore"


Harmonic16 Dark (https://tinted-theming.github.io/tinted-gallery/#base16-harmonic16-dark)

Value: "Harmonic16Dark"


Harmonic16 Light (https://tinted-theming.github.io/tinted-gallery/#base16-harmonic16-light)

Value: "Harmonic16Light"


Heetch Light (https://tinted-theming.github.io/tinted-gallery/#base16-heetch-light)

Value: "HeetchLight"


Heetch (https://tinted-theming.github.io/tinted-gallery/#base16-heetch)

Value: "Heetch"


Helios (https://tinted-theming.github.io/tinted-gallery/#base16-helios)

Value: "Helios"


Hopscotch (https://tinted-theming.github.io/tinted-gallery/#base16-hopscotch)

Value: "Hopscotch"


Horizon Dark (https://tinted-theming.github.io/tinted-gallery/#base16-horizon-dark)

Value: "HorizonDark"


Horizon Light (https://tinted-theming.github.io/tinted-gallery/#base16-horizon-light)

Value: "HorizonLight"


Horizon Terminal Dark (https://tinted-theming.github.io/tinted-gallery/#base16-horizon-terminal-dark)

Value: "HorizonTerminalDark"


Horizon Terminal Light (https://tinted-theming.github.io/tinted-gallery/#base16-horizon-terminal-light)

Value: "HorizonTerminalLight"


Humanoid Dark (https://tinted-theming.github.io/tinted-gallery/#base16-humanoid-dark)

Value: "HumanoidDark"


Humanoid Light (https://tinted-theming.github.io/tinted-gallery/#base16-humanoid-light)

Value: "HumanoidLight"


Ia Dark (https://tinted-theming.github.io/tinted-gallery/#base16-ia-dark)

Value: "IaDark"


Ia Light (https://tinted-theming.github.io/tinted-gallery/#base16-ia-light)

Value: "IaLight"


Icy (https://tinted-theming.github.io/tinted-gallery/#base16-icy)

Value: "Icy"


Irblack (https://tinted-theming.github.io/tinted-gallery/#base16-irblack)

Value: "Irblack"


Isotope (https://tinted-theming.github.io/tinted-gallery/#base16-isotope)

Value: "Isotope"


Jabuti (https://tinted-theming.github.io/tinted-gallery/#base16-jabuti)

Value: "Jabuti"


Kanagawa (https://tinted-theming.github.io/tinted-gallery/#base16-kanagawa)

Value: "Kanagawa"


Katy (https://tinted-theming.github.io/tinted-gallery/#base16-katy)

Value: "Katy"


Kimber (https://tinted-theming.github.io/tinted-gallery/#base16-kimber)

Value: "Kimber"


Lime (https://tinted-theming.github.io/tinted-gallery/#base16-lime)

Value: "Lime"


Macintosh (https://tinted-theming.github.io/tinted-gallery/#base16-macintosh)

Value: "Macintosh"


Marrakesh (https://tinted-theming.github.io/tinted-gallery/#base16-marrakesh)

Value: "Marrakesh"


Materia (https://tinted-theming.github.io/tinted-gallery/#base16-materia)

Value: "Materia"


Material Darker (https://tinted-theming.github.io/tinted-gallery/#base16-material-darker)

Value: "MaterialDarker"


Material Lighter (https://tinted-theming.github.io/tinted-gallery/#base16-material-lighter)

Value: "MaterialLighter"


Material Palenight (https://tinted-theming.github.io/tinted-gallery/#base16-material-palenight)

Value: "MaterialPalenight"


Material Vivid (https://tinted-theming.github.io/tinted-gallery/#base16-material-vivid)

Value: "MaterialVivid"


Material (https://tinted-theming.github.io/tinted-gallery/#base16-material)

Value: "Material"


Measured Dark (https://tinted-theming.github.io/tinted-gallery/#base16-measured-dark)

Value: "MeasuredDark"


Measured Light (https://tinted-theming.github.io/tinted-gallery/#base16-measured-light)

Value: "MeasuredLight"


Mellow Purple (https://tinted-theming.github.io/tinted-gallery/#base16-mellow-purple)

Value: "MellowPurple"


Mexico Light (https://tinted-theming.github.io/tinted-gallery/#base16-mexico-light)

Value: "MexicoLight"


Mocha (https://tinted-theming.github.io/tinted-gallery/#base16-mocha)

Value: "Mocha"


Monokai (https://tinted-theming.github.io/tinted-gallery/#base16-monokai)

Value: "Monokai"


Moonlight (https://tinted-theming.github.io/tinted-gallery/#base16-moonlight)

Value: "Moonlight"


Mountain (https://tinted-theming.github.io/tinted-gallery/#base16-mountain)

Value: "Mountain"


Nebula (https://tinted-theming.github.io/tinted-gallery/#base16-nebula)

Value: "Nebula"


Nord Light (https://tinted-theming.github.io/tinted-gallery/#base16-nord-light)

Value: "NordLight"


Nord (https://tinted-theming.github.io/tinted-gallery/#base16-nord)

Value: "Nord"


Nova (https://tinted-theming.github.io/tinted-gallery/#base16-nova)

Value: "Nova"


Ocean (https://tinted-theming.github.io/tinted-gallery/#base16-ocean)

Value: "Ocean"


Oceanicnext (https://tinted-theming.github.io/tinted-gallery/#base16-oceanicnext)

Value: "Oceanicnext"


One Light (https://tinted-theming.github.io/tinted-gallery/#base16-one-light)

Value: "OneLight"


Onedark Dark (https://tinted-theming.github.io/tinted-gallery/#base16-onedark-dark)

Value: "OnedarkDark"


Onedark (https://tinted-theming.github.io/tinted-gallery/#base16-onedark)

Value: "Onedark"


Outrun Dark (https://tinted-theming.github.io/tinted-gallery/#base16-outrun-dark)

Value: "OutrunDark"


Oxocarbon Dark (https://tinted-theming.github.io/tinted-gallery/#base16-oxocarbon-dark)

Value: "OxocarbonDark"


Oxocarbon Light (https://tinted-theming.github.io/tinted-gallery/#base16-oxocarbon-light)

Value: "OxocarbonLight"


Pandora (https://tinted-theming.github.io/tinted-gallery/#base16-pandora)

Value: "Pandora"


Papercolor Dark (https://tinted-theming.github.io/tinted-gallery/#base16-papercolor-dark)

Value: "PapercolorDark"


Papercolor Light (https://tinted-theming.github.io/tinted-gallery/#base16-papercolor-light)

Value: "PapercolorLight"


Paraiso (https://tinted-theming.github.io/tinted-gallery/#base16-paraiso)

Value: "Paraiso"


Pasque (https://tinted-theming.github.io/tinted-gallery/#base16-pasque)

Value: "Pasque"


Phd (https://tinted-theming.github.io/tinted-gallery/#base16-phd)

Value: "Phd"


Pico (https://tinted-theming.github.io/tinted-gallery/#base16-pico)

Value: "Pico"


Pinky (https://tinted-theming.github.io/tinted-gallery/#base16-pinky)

Value: "Pinky"


Pop (https://tinted-theming.github.io/tinted-gallery/#base16-pop)

Value: "Pop"


Porple (https://tinted-theming.github.io/tinted-gallery/#base16-porple)

Value: "Porple"


Precious Dark Eleven (https://tinted-theming.github.io/tinted-gallery/#base16-precious-dark-eleven)

Value: "PreciousDarkEleven"


Precious Dark Fifteen (https://tinted-theming.github.io/tinted-gallery/#base16-precious-dark-fifteen)

Value: "PreciousDarkFifteen"


Precious Light Warm (https://tinted-theming.github.io/tinted-gallery/#base16-precious-light-warm)

Value: "PreciousLightWarm"


Precious Light White (https://tinted-theming.github.io/tinted-gallery/#base16-precious-light-white)

Value: "PreciousLightWhite"


Primer Dark Dimmed (https://tinted-theming.github.io/tinted-gallery/#base16-primer-dark-dimmed)

Value: "PrimerDarkDimmed"


Primer Dark (https://tinted-theming.github.io/tinted-gallery/#base16-primer-dark)

Value: "PrimerDark"


Primer Light (https://tinted-theming.github.io/tinted-gallery/#base16-primer-light)

Value: "PrimerLight"


Purpledream (https://tinted-theming.github.io/tinted-gallery/#base16-purpledream)

Value: "Purpledream"


Qualia (https://tinted-theming.github.io/tinted-gallery/#base16-qualia)

Value: "Qualia"


Railscasts (https://tinted-theming.github.io/tinted-gallery/#base16-railscasts)

Value: "Railscasts"


Rebecca (https://tinted-theming.github.io/tinted-gallery/#base16-rebecca)

Value: "Rebecca"


Rose Pine Dawn (https://tinted-theming.github.io/tinted-gallery/#base16-rose-pine-dawn)

Value: "RosePineDawn"


Rose Pine Moon (https://tinted-theming.github.io/tinted-gallery/#base16-rose-pine-moon)

Value: "RosePineMoon"


Rose Pine (https://tinted-theming.github.io/tinted-gallery/#base16-rose-pine)

Value: "RosePine"


Saga (https://tinted-theming.github.io/tinted-gallery/#base16-saga)

Value: "Saga"


Sagelight (https://tinted-theming.github.io/tinted-gallery/#base16-sagelight)

Value: "Sagelight"


Sakura (https://tinted-theming.github.io/tinted-gallery/#base16-sakura)

Value: "Sakura"


Sandcastle (https://tinted-theming.github.io/tinted-gallery/#base16-sandcastle)

Value: "Sandcastle"


Selenized Black (https://tinted-theming.github.io/tinted-gallery/#base16-selenized-black)

Value: "SelenizedBlack"


Selenized Dark (https://tinted-theming.github.io/tinted-gallery/#base16-selenized-dark)

Value: "SelenizedDark"


Selenized Light (https://tinted-theming.github.io/tinted-gallery/#base16-selenized-light)

Value: "SelenizedLight"


Selenized White (https://tinted-theming.github.io/tinted-gallery/#base16-selenized-white)

Value: "SelenizedWhite"


Seti (https://tinted-theming.github.io/tinted-gallery/#base16-seti)

Value: "Seti"


Shades Of Purple (https://tinted-theming.github.io/tinted-gallery/#base16-shades-of-purple)

Value: "ShadesOfPurple"


Shadesmear Dark (https://tinted-theming.github.io/tinted-gallery/#base16-shadesmear-dark)

Value: "ShadesmearDark"


Shadesmear Light (https://tinted-theming.github.io/tinted-gallery/#base16-shadesmear-light)

Value: "ShadesmearLight"


Shapeshifter (https://tinted-theming.github.io/tinted-gallery/#base16-shapeshifter)

Value: "Shapeshifter"


Silk Dark (https://tinted-theming.github.io/tinted-gallery/#base16-silk-dark)

Value: "SilkDark"


Silk Light (https://tinted-theming.github.io/tinted-gallery/#base16-silk-light)

Value: "SilkLight"


Snazzy (https://tinted-theming.github.io/tinted-gallery/#base16-snazzy)

Value: "Snazzy"


Solarflare Light (https://tinted-theming.github.io/tinted-gallery/#base16-solarflare-light)

Value: "SolarflareLight"


Solarflare (https://tinted-theming.github.io/tinted-gallery/#base16-solarflare)

Value: "Solarflare"


Solarized Dark (https://tinted-theming.github.io/tinted-gallery/#base16-solarized-dark)

Value: "SolarizedDark"


Solarized Light (https://tinted-theming.github.io/tinted-gallery/#base16-solarized-light)

Value: "SolarizedLight"


Spaceduck (https://tinted-theming.github.io/tinted-gallery/#base16-spaceduck)

Value: "Spaceduck"


Spacemacs (https://tinted-theming.github.io/tinted-gallery/#base16-spacemacs)

Value: "Spacemacs"


Sparky (https://tinted-theming.github.io/tinted-gallery/#base16-sparky)

Value: "Sparky"


Standardized Dark (https://tinted-theming.github.io/tinted-gallery/#base16-standardized-dark)

Value: "StandardizedDark"


Standardized Light (https://tinted-theming.github.io/tinted-gallery/#base16-standardized-light)

Value: "StandardizedLight"


Stella (https://tinted-theming.github.io/tinted-gallery/#base16-stella)

Value: "Stella"


Still Alive (https://tinted-theming.github.io/tinted-gallery/#base16-still-alive)

Value: "StillAlive"


Summercamp (https://tinted-theming.github.io/tinted-gallery/#base16-summercamp)

Value: "Summercamp"


Summerfruit Dark (https://tinted-theming.github.io/tinted-gallery/#base16-summerfruit-dark)

Value: "SummerfruitDark"


Summerfruit Light (https://tinted-theming.github.io/tinted-gallery/#base16-summerfruit-light)

Value: "SummerfruitLight"


Synth Midnight Dark (https://tinted-theming.github.io/tinted-gallery/#base16-synth-midnight-dark)

Value: "SynthMidnightDark"


Synth Midnight Light (https://tinted-theming.github.io/tinted-gallery/#base16-synth-midnight-light)

Value: "SynthMidnightLight"


Tango (https://tinted-theming.github.io/tinted-gallery/#base16-tango)

Value: "Tango"


Tarot (https://tinted-theming.github.io/tinted-gallery/#base16-tarot)

Value: "Tarot"


Tender (https://tinted-theming.github.io/tinted-gallery/#base16-tender)

Value: "Tender"


Terracotta Dark (https://tinted-theming.github.io/tinted-gallery/#base16-terracotta-dark)

Value: "TerracottaDark"


Terracotta (https://tinted-theming.github.io/tinted-gallery/#base16-terracotta)

Value: "Terracotta"


Tokyo City Dark (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-city-dark)

Value: "TokyoCityDark"


Tokyo City Light (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-city-light)

Value: "TokyoCityLight"


Tokyo City Terminal Dark (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-city-terminal-dark)

Value: "TokyoCityTerminalDark"


Tokyo City Terminal Light (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-city-terminal-light)

Value: "TokyoCityTerminalLight"


Tokyo Night Dark (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-dark)

Value: "TokyoNightDark"


Tokyo Night Light (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-light)

Value: "TokyoNightLight"


Tokyo Night Moon (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-moon)

Value: "TokyoNightMoon"


Tokyo Night Storm (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-storm)

Value: "TokyoNightStorm"


Tokyo Night Terminal Dark (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-terminal-dark)

Value: "TokyoNightTerminalDark"


Tokyo Night Terminal Light (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-terminal-light)

Value: "TokyoNightTerminalLight"


Tokyo Night Terminal Storm (https://tinted-theming.github.io/tinted-gallery/#base16-tokyo-night-terminal-storm)

Value: "TokyoNightTerminalStorm"


Tokyodark Terminal (https://tinted-theming.github.io/tinted-gallery/#base16-tokyodark-terminal)

Value: "TokyodarkTerminal"


Tokyodark (https://tinted-theming.github.io/tinted-gallery/#base16-tokyodark)

Value: "Tokyodark"


Tomorrow Night Eighties (https://tinted-theming.github.io/tinted-gallery/#base16-tomorrow-night-eighties)

Value: "TomorrowNightEighties"


Tomorrow Night (https://tinted-theming.github.io/tinted-gallery/#base16-tomorrow-night)

Value: "TomorrowNight"


Tomorrow (https://tinted-theming.github.io/tinted-gallery/#base16-tomorrow)

Value: "Tomorrow"


Tube (https://tinted-theming.github.io/tinted-gallery/#base16-tube)

Value: "Tube"


Twilight (https://tinted-theming.github.io/tinted-gallery/#base16-twilight)

Value: "Twilight"


Unikitty Dark (https://tinted-theming.github.io/tinted-gallery/#base16-unikitty-dark)

Value: "UnikittyDark"


Unikitty Light (https://tinted-theming.github.io/tinted-gallery/#base16-unikitty-light)

Value: "UnikittyLight"


Unikitty Reversible (https://tinted-theming.github.io/tinted-gallery/#base16-unikitty-reversible)

Value: "UnikittyReversible"


Uwunicorn (https://tinted-theming.github.io/tinted-gallery/#base16-uwunicorn)

Value: "Uwunicorn"


Vesper (https://tinted-theming.github.io/tinted-gallery/#base16-vesper)

Value: "Vesper"


Vice (https://tinted-theming.github.io/tinted-gallery/#base16-vice)

Value: "Vice"


Vulcan (https://tinted-theming.github.io/tinted-gallery/#base16-vulcan)

Value: "Vulcan"


Windows 10 Light (https://tinted-theming.github.io/tinted-gallery/#base16-windows-10-light)

Value: "Windows10Light"


Windows 10 (https://tinted-theming.github.io/tinted-gallery/#base16-windows-10)

Value: "Windows10"


Windows 95 Light (https://tinted-theming.github.io/tinted-gallery/#base16-windows-95-light)

Value: "Windows95Light"


Windows 95 (https://tinted-theming.github.io/tinted-gallery/#base16-windows-95)

Value: "Windows95"


Windows Highcontrast Light (https://tinted-theming.github.io/tinted-gallery/#base16-windows-highcontrast-light)

Value: "WindowsHighcontrastLight"


Windows Highcontrast (https://tinted-theming.github.io/tinted-gallery/#base16-windows-highcontrast)

Value: "WindowsHighcontrast"


Windows Nt Light (https://tinted-theming.github.io/tinted-gallery/#base16-windows-nt-light)

Value: "WindowsNtLight"


Windows Nt (https://tinted-theming.github.io/tinted-gallery/#base16-windows-nt)

Value: "WindowsNt"


Woodland (https://tinted-theming.github.io/tinted-gallery/#base16-woodland)

Value: "Woodland"


Xcode Dusk (https://tinted-theming.github.io/tinted-gallery/#base16-xcode-dusk)

Value: "XcodeDusk"


Zenbones (https://tinted-theming.github.io/tinted-gallery/#base16-zenbones)

Value: "Zenbones"


Zenburn (https://tinted-theming.github.io/tinted-gallery/#base16-zenburn)

Value: "Zenburn"

Configuration:

Referenced by:


Base16 colour palette: https://github.com/chriskempson/base16

Properties (16)

required Colour

Base00

required Colour

Base01

required Colour

Base02

required Colour

Base03

required Colour

Base04

required Colour

Base05

required Colour

Base06

required Colour

Base07

required Colour

Base08

required Colour

Base09

required Colour

Base0A

required Colour

Base0B

required Colour

Base0C

required Colour

Base0D

required Colour

Base0E

required Colour

Base0F

Configuration:

Referenced by:


Base16 value

Enum variants (16)

Base00

Value: "Base00"


Base01

Value: "Base01"


Base02

Value: "Base02"


Base03

Value: "Base03"


Base04

Value: "Base04"


Base05

Value: "Base05"


Base06

Value: "Base06"


Base07

Value: "Base07"


Base08

Value: "Base08"


Base09

Value: "Base09"


Base0A

Value: "Base0A"


Base0B

Value: "Base0B"


Base0C

Value: "Base0C"


Base0D

Value: "Base0D"


Base0E

Value: "Base0E"


Base0F

Value: "Base0F"

Configuration:

Referenced by:


Battery widget configuration

Properties (5)

required boolean

Enable the Battery widget

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

optional integer

Data refresh interval in seconds

  • Format: uint64
  • Minimum: 0

Default: 10

optional boolean

Hide the widget if the battery is at full charge

optional LabelPrefix

Display label prefix

Referenced by:


Border style

Enum variants (2)

Use the adjustable komorebi border implementation

Value: "Komorebi"


Use the thin Windows accent border implementation

Value: "Windows"

Configuration:

Referenced by:


Border style

Enum variants (3)

Use the system border style

Value: "System"


Use the Windows 11-style rounded borders

Value: "Rounded"


Use the Windows 10-style square borders

Value: "Square"

Configuration:

Referenced by:


Where to place a systray button (refresh, info, shortcuts, etc.)

Enum variants (2)

Show in the main visible area

Value: "Visible"


Show in the overflow/hidden section

Value: "Overflow"

Referenced by:


Catppuccin palette

Enum variants (4)

Frappe (https://catppuccin.com/palette#flavor-frappe)

Value: "Frappe"


Latte (https://catppuccin.com/palette#flavor-latte)

Value: "Latte"


Macchiato (https://catppuccin.com/palette#flavor-macchiato)

Value: "Macchiato"


Mocha (https://catppuccin.com/palette#flavor-mocha)

Value: "Mocha"

Configuration:

Referenced by:


Catppuccin Value

Enum variants (26)

Rosewater

Value: "Rosewater"


Flamingo

Value: "Flamingo"


Pink

Value: "Pink"


Mauve

Value: "Mauve"


Red

Value: "Red"


Maroon

Value: "Maroon"


Peach

Value: "Peach"


Yellow

Value: "Yellow"


Green

Value: "Green"


Teal

Value: "Teal"


Sky

Value: "Sky"


Sapphire

Value: "Sapphire"


Blue

Value: "Blue"


Lavender

Value: "Lavender"


Text

Value: "Text"


Subtext1

Value: "Subtext1"


Subtext0

Value: "Subtext0"


Overlay2

Value: "Overlay2"


Overlay1

Value: "Overlay1"


Overlay0

Value: "Overlay0"


Surface2

Value: "Surface2"


Surface1

Value: "Surface1"


Surface0

Value: "Surface0"


Base

Value: "Base"


Mantle

Value: "Mantle"


Crust

Value: "Crust"

Configuration:

Referenced by:


Colour representation

Enum variants (2)

Colour represented as RGB

Value: Rgb


Colour represented as Hex

Value: Hex

Configuration:

Referenced by:


Enum variants (3)

Value: object

required optional ColumnWidth


Value: object

required optional ColumnSplitWithCapacity


Value: object

required ColumnSplit

Referenced by:


Enum variants (2)
  • "Horizontal"
  • "Vertical"

Referenced by:


Enum variants (2)

Value: Horizontalinteger


Value: Verticalinteger

Referenced by:


Enum variants (1)

Value: WidthPercentagenumber

Referenced by:


Properties (3)

required string

required Ring4

boolean

Configuration:

Referenced by:


CPU widget configuration

Properties (4)

required boolean

Enable the Cpu widget

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

optional integer

Data refresh interval in seconds

  • Format: uint64
  • Minimum: 0

Default: 10

optional LabelPrefix

Display label prefix

Referenced by:


Referenced by:


Custom format with additive modifiers for integer format specifiers

Properties (2)

required string

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

required object

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

Additional Properties

integer

  • Format: int32

Referenced by:


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

Configuration:

Referenced by:


Date widget configuration

Properties (4)

required boolean

Enable the Date widget

required DateFormat

Set the Date format

optional LabelPrefix

Display label prefix

optional 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"
}
}

Referenced by:


Date widget format

Enum variants (6)

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

Value: "MonthDateYear"


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

Value: "YearMonthDate"


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

Value: "DateMonthYear"


Day Date Month Year format (8 September 2024)

Value: "DayDateMonthYear"


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

Value: Customstring


Custom format with modifiers

Value: CustomModifiersCustomModifiers

Referenced by:


A predefined komorebi layout

Enum variants (9)

BSP Layout

+-------+-----+
| | |
| +--+--+
| | |--|
+-------+--+--+

Value: "BSP"


Columns Layout

+--+--+--+--+
| | | | |
| | | | |
| | | | |
+--+--+--+--+

Value: "Columns"


Rows Layout

+-----------+
|-----------|
|-----------|
|-----------|
+-----------+

Value: "Rows"


Vertical Stack Layout

+-------+-----+
| | |
| +-----+
| | |
+-------+-----+

Value: "VerticalStack"


Horizontal Stack Layout

+------+------+
| |
|------+------+
| | |
+------+------+

Value: "HorizontalStack"


Ultrawide Vertical Stack Layout

+-----+-----------+-----+
| | | |
| | +-----+
| | | |
| | +-----+
| | | |
+-----+-----------+-----+

Value: "UltrawideVerticalStack"


Grid Layout

+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
| | | | | | | | | | | | | | |
| | | | | | | | | | | | | +---+
+-----+-----+ | +---+---+ +---+---+---+ +---+---| |
| | | | | | | | | | | | | +---+
| | | | | | | | | | | | | | |
+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
4 windows 5 windows 6 windows 7 windows

Value: "Grid"


Right Main Vertical Stack Layout

+-----+-------+
| | |
+-----+ |
| | |
+-----+-------+

Value: "RightMainVerticalStack"


Scrolling Layout

+--+--+--+--+--+--+
| | | |
| | | |
| | | |
+--+--+--+--+--+--+

Value: "Scrolling"

Configuration:

Referenced by:


Display format

Enum variants (5)

Show only icon

Value: "Icon"


Show only text

Value: "Text"


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

Value: "TextAndIconOnSelected"


Show both icon and text

Value: "IconAndText"


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

Value: "IconAndTextOnSelected"

Referenced by:


A field value with an optional matching strategy.

A plain string uses exact (case-insensitive) matching. An object with value and matching_strategy uses the specified strategy.

Enum variants (2)

Exact case-insensitive match

Value: string


Match using a specific strategy

Value: object

required MatchingStrategy

How to match (Equals, StartsWith, EndsWith, Contains, Regex, etc.)

required string

The value to match against

Referenced by:


Floating layer behaviour when a new window is opened

Enum variants (2)

Tile new windows (unless they match a float rule or float override is active)

Value: "Tile"


Float new windows

Value: "Float"

Configuration:

Referenced by:


Focus follows mouse implementation

Enum variants (2)

Custom FFM implementation (slightly more CPU-intensive)

Value: "Komorebi"


Native (legacy) Windows FFM implementation

Value: "Windows"

Configuration:

Referenced by:


Frame configuration

Properties (1)

required Position

Margin inside the painted frame

Configuration:


Options for the Grid layout

Properties (1)

required integer

Maximum number of rows per grid column

  • Format: uint
  • Minimum: 0

Configuration:

Referenced by:


Grouped vertical and horizontal spacing

Properties (2)

optional GroupedSpacingOptions

Horizontal grouped spacing

optional GroupedSpacingOptions

Vertical grouped spacing

Configuration:

Referenced by:


Grouped spacing options

Enum variants (2)

Symmetrical grouped spacing

Value: number

  • Format: float

Split grouped spacing

Value: array [float; 2]

Configuration:

Referenced by:


Grouping

Enum variants (4)

No grouping is applied

Value: object


Widgets are grouped as a whole

Value: GroupingConfig


Widgets are grouped by alignment

Value: GroupingConfig


Widgets are grouped individually

Value: GroupingConfig

Configuration:


Grouping configuration

Properties (3)

optional RoundingConfig

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

optional GroupingStyle

Styles for the grouping

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

Configuration:

Referenced by:


Grouping Style

Enum variants (7)

Default

Value: "Default"


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

Value: "DefaultWithShadowB4O1S3"


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

Value: "DefaultWithShadowB4O0S3"


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

Value: "DefaultWithShadowB0O1S3"


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

Value: "DefaultWithGlowB3O1S2"


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

Value: "DefaultWithGlowB3O0S2"


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

Value: "DefaultWithGlowB0O1S2"

Configuration:

Referenced by:


Colour represented as a Hex string

  • Format: color-hex

Configuration:

Referenced by:


Rule for matching a systray icon to hide

A plain string matches the exe name (backward compatible). An object with optional exe, tooltip, and/or guid fields uses AND logic: all specified fields must match. Each field can be a plain string (exact match) or an object with value and matching_strategy for advanced matching.

Enum variants (2)

Match by exe name (case-insensitive, exact)

Value: string


Match by one or more properties (all specified fields must match)

Value: object

optional FieldMatch

Exe name to match

optional FieldMatch

Icon GUID to match (most stable identifier across restarts)

optional FieldMatch

Tooltip text to match

Referenced by:


Window hiding behaviour

Enum variants (3)

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

Value: "Hide"


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

Value: "Minimize"


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

Value: "Cloak"

Configuration:

Referenced by:


Rule for matching applications

Properties (3)

required string

Target identifier

required ApplicationIdentifier

Kind of identifier to target

optional MatchingStrategy

Matching strategy to use

Configuration:

Referenced by:


Individual spacing configuration

Properties (4)

required number

Spacing for the bottom

  • Format: float

required number

Spacing for the left

  • Format: float

required number

Spacing for the right

  • Format: float

required number

Spacing for the top

  • Format: float

Configuration:

Referenced by:


Keyboard widget configuration

Properties (3)

required boolean

Enable the Input widget

optional integer

Data refresh interval

  • Format: uint64
  • Minimum: 0

Default: 10

optional LabelPrefix

Display label prefix

Referenced by:


Komorebi bar theme

Enum variants (3)

Theme from catppuccin-egui

Value: KomobarThemeCatppuccin


Theme from base16-egui-themes

Value: KomobarThemeBase16


Custom Base16 theme

Value: KomobarThemeCustom

Configuration:


Theme from base16-egui-themes

Properties (4)

required Base16

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

optional Base16Value

Accent colour

Default: "Base0D"

optional Base16Value

Auto select fill colour

optional Base16Value

Auto select text colour

Configuration:

Referenced by:


Theme from catppuccin-egui

Properties (4)

required Catppuccin

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

optional CatppuccinValue

Accent colour

Default: "Blue"

optional CatppuccinValue

Auto select fill colour

optional CatppuccinValue

Auto select text colour

Configuration:

Referenced by:


Theme from base16-egui-themes

Properties (4)

required Base16ColourPalette

Colours of the custom Base16 theme palette

optional Base16Value

Accent colour

Default: "Blue"

optional Base16Value

Auto select fill colour

optional Base16Value

Auto select text colour

Configuration:

Referenced by:


Komorebi widget configuration

Properties (6)

optional KomorebiConfigurationSwitcherConfig

Configure the Configuration Switcher widget

optional KomorebiFocusedContainerConfig

Configure the Focused Container widget

optional KomorebiLayoutConfig

Configure the Layout widget

optional KomorebiLockedContainerConfig

Configure the Locked Container widget

optional KomorebiWorkspaceLayerConfig

Configure the Workspace Layer widget

optional KomorebiWorkspacesConfig

Configure the Workspaces widget

Referenced by:


Komorebi widget configuration switcher configuration

Properties (2)

required object

A map of display friendly name => path to configuration.json

Additional Properties

string

required boolean

Enable the Komorebi Configurations widget

Referenced by:


Komorebi widget focused container configuration

Properties (3)

required boolean

Enable the Komorebi Focused Container widget

optional DisplayFormat

Display format of the currently focused container

deprecated optional boolean

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

Referenced by:


Komorebi layout kind

Enum variants (5)

Predefined layout

Value: DefaultLayout


Monocle mode

Value: null


Floating layer

Value: null


Paused

Value: null


Custom layout

Value: null

Referenced by:


Komorebi widget layout configuration

Properties (3)

required boolean

Enable the Komorebi Layout widget

optional DisplayFormat

Display format of the current layout

optional array KomorebiLayout

List of layout options

Referenced by:


Komorebi widget locked container configuration

Properties (3)

required boolean

Enable the Komorebi Locked Container widget

optional DisplayFormat

Display format of the current locked state

optional boolean

Show the widget event if the layer is unlocked

Referenced by:


Komorebi socket mouse message

Properties (3)

required SocketMessage

The message to send to the komorebi client

optional boolean

Send the FocusMonitorAtCursor message

Default: true

optional boolean

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

Default: true

Configuration:

Referenced by:


Komorebi theme

Enum variants (3)

Theme from catppuccin-egui

Value: KomorebiThemeCatppuccin


Theme from base16-egui-themes

Value: KomorebiThemeBase16


Custom Base16 theme

Value: KomorebiThemeCustom

Configuration:

Referenced by:


Theme from base16-egui-themes

Properties (11)

required Base16

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

optional Base16Value

Bar accent colour

Default: "Base0D"

optional Base16Value

Floating window border colour

Default: "Base09"

optional Base16Value

Monocle window border colour

Default: "Base0F"

optional Base16Value

Single window border colour

Default: "Base0D"

optional Base16Value

Stack window border colour

Default: "Base0B"

optional Base16Value

Stackbar background colour

Default: "Base01"

optional Base16Value

Stackbar focused text colour

Default: "Base0B"

optional Base16Value

Stackbar unfocused text colour

Default: "Base05"

optional Base16Value

Unfocused window border colour

Default: "Base01"

optional Base16Value

Unfocused locked window border colour

Default: "Base08"

Configuration:

Referenced by:


Theme from catppuccin-egui

Properties (11)

required Catppuccin

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

optional CatppuccinValue

Bar accent colour

Default: "Blue"

optional CatppuccinValue

Floating window border colour

Default: "Yellow"

optional CatppuccinValue

Monocle window border colour

Default: "Pink"

optional CatppuccinValue

Single window border colour

Default: "Blue"

optional CatppuccinValue

Stack window border colour

Default: "Green"

optional CatppuccinValue

Stackbar background colour

Default: "Base"

optional CatppuccinValue

Stackbar focused text colour

Default: "Green"

optional CatppuccinValue

Stackbar unfocused text colour

Default: "Text"

optional CatppuccinValue

Unfocused window border colour

Default: "Base"

optional CatppuccinValue

Unfocused locked window border colour

Default: "Red"

Configuration:

Referenced by:


Custom Base16 theme

Properties (11)

required Base16ColourPalette

Colours of the custom Base16 theme palette

optional Base16Value

Bar accent colour

Default: "Base0D"

optional Base16Value

Floating window border colour

Default: "Base09"

optional Base16Value

Monocle window border colour

Default: "Base0F"

optional Base16Value

Single window border colour

Default: "Base0D"

optional Base16Value

Stack window border colour

Default: "Base0B"

optional Base16Value

Stackbar background colour

Default: "Base01"

optional Base16Value

Stackbar focused text colour

Default: "Base0B"

optional Base16Value

Stackbar unfocused text colour

Default: "Base05"

optional Base16Value

Unfocused window border colour

Default: "Base01"

optional Base16Value

Unfocused locked window border colour

Default: "Base08"

Configuration:

Referenced by:


Komorebi widget workspace layer configuration

Properties (3)

required boolean

Enable the Komorebi Workspace Layer widget

optional DisplayFormat

Display format of the current layer

optional boolean

Show the widget event if the layer is Tiling

Referenced by:


Komorebi widget workspaces configuration

Properties (3)

required boolean

Enable the Komorebi Workspaces widget

required boolean

Hide workspaces without any windows

optional WorkspacesDisplayFormat

Display format of the workspace

Referenced by:


Label prefix

Enum variants (4)

Show no prefix

Value: "None"


Show an icon

Value: "Icon"


Show text

Value: "Text"


Show an icon and text

Value: "IconAndText"

Referenced by:


Enum variants (2)

Value: DefaultDefaultLayout


Value: CustomCustomLayout

Configuration:

Referenced by:


Options for specific layouts

Properties (4)

optional array optional number

Column width ratios (up to MAX_RATIOS values between 0.1 and 0.9)

  • Used by Columns layout: ratios for each column width
  • Used by Grid layout: ratios for column widths
  • Used by BSP, VerticalStack, RightMainVerticalStack: column_ratios[0] as primary split ratio
  • Used by HorizontalStack: column_ratios[0] as primary split ratio (top area height)
  • Used by UltrawideVerticalStack: column_ratios[0] as center ratio, column_ratios[1] as left ratio

Columns without a ratio share remaining space equally. Example: [0.3, 0.4, 0.3] for 30%-40%-30% columns

  • Min items: 5
  • Max items: 5
Array Items

optional number

  • Format: float

optional GridLayoutOptions

Options related to the Grid layout

optional array optional number

Row height ratios (up to MAX_RATIOS values between 0.1 and 0.9)

  • Used by Rows layout: ratios for each row height
  • Used by Grid layout: ratios for row heights

Rows without a ratio share remaining space equally. Example: [0.5, 0.5] for 50%-50% rows

  • Min items: 5
  • Max items: 5
Array Items

optional number

  • Format: float

optional ScrollingLayoutOptions

Options related to the Scrolling layout

Configuration:

Referenced by:


Rule for matching applications

Enum variants (2)

Simple matching rule which must evaluate to true

Value: IdWithIdentifier


Composite matching rule where all conditions must evaluate to true

Value: array IdWithIdentifier

Configuration:

Referenced by:


Strategy for matching identifiers

Enum variants (10)

Should not be used, only kept for backward compatibility

Value: "Legacy"


Equals

Value: "Equals"


Starts With

Value: "StartsWith"


Ends With

Value: "EndsWith"


Contains

Value: "Contains"


Regex

Value: "Regex"


Does not end with

Value: "DoesNotEndWith"


Does not start with

Value: "DoesNotStartWith"


Does not equal

Value: "DoesNotEqual"


Does not contain

Value: "DoesNotContain"

Configuration:

Referenced by:


Media widget configuration

Properties (2)

required boolean

Enable the Media widget

optional MediaDisplayFormat

Display format of the media widget (defaults to IconAndText)

Referenced by:


Media widget display format

Enum variants (7)

Show only the media info icon

Value: "Icon"


Show only the media info text (artist - title)

Value: "Text"


Show both icon and text

Value: "IconAndText"


Show only the control buttons (previous, play/pause, next)

Value: "ControlsOnly"


Show icon with control buttons

Value: "IconAndControls"


Show text with control buttons

Value: "TextAndControls"


Show icon, text, and control buttons

Value: "Full"

Referenced by:


Memory widget configuration

Properties (4)

required boolean

Enable the Memory widget

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

optional integer

Data refresh interval in seconds

  • Format: uint64
  • Minimum: 0

Default: 10

optional LabelPrefix

Display label prefix

Referenced by:


Properties (17)

required string

required string

required integer

  • Format: int

required string

required Rect

required integer

  • Format: int

required Rect

required object

Key: "<integer>" string

required Ring2

optional integer

  • Format: int32

optional FloatingLayerBehaviour

optional integer

  • Format: uint
  • Minimum: 0

optional string

optional Wallpaper

optional Rect

optional Rect

optional integer

  • Format: int32

Configuration:

Referenced by:


Monitor configuration

Properties (2)

required integer

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

  • Format: uint
  • Minimum: 0

optional Rect

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

Configuration:

Referenced by:


Monitor configuration or monitor index

Enum variants (2)

The monitor index where you want the bar to show

Value: integer

  • Format: uint
  • Minimum: 0

The full monitor options with the index and an optional work_area_offset

Value: MonitorConfig

Configuration:


Mouse configuration

Properties (11)

optional number

Defines how many points a user needs to scroll horizontally to make a “tick” on a mouse/touchpad/touchscreen

  • Format: float

Default: 30.0

optional MouseMessage

Command to send on extra1/back button click

optional MouseMessage

Command to send on extra2/forward button click

optional MouseMessage

Command to send on middle button click

optional MouseMessage

Command to send on primary/left double button click

optional MouseMessage

Command to send on scrolling down (every tick)

optional MouseMessage

Command to send on scrolling left (every tick)

optional MouseMessage

Command to send on scrolling right (every tick)

optional MouseMessage

Command to send on scrolling up (every tick)

optional MouseMessage

Command to send on secondary/right button click

optional number

Defines how many points a user needs to scroll vertically to make a “tick” on a mouse/touchpad/touchscreen

  • Format: float

Default: 30.0

Configuration:


Mouse message

Enum variants (2)

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"
}
}

Value: KomorebiMouseMessage


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

Value: string

Configuration:

Referenced by:


Move behaviour when the operation works across a monitor boundary

Enum variants (3)

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

Value: "Swap"


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

Value: "Insert"


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

Value: "NoOp"

Configuration:

Referenced by:


Network widget configuration

Properties (8)

required boolean

Enable the Network widget

required boolean

Show received and transmitted activity

required boolean

Show total received and transmitted activity

optional integer

Characters to reserve for received and transmitted activity

  • Format: uint
  • Minimum: 0

optional NetworkSelectConfig

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

optional integer

Data refresh interval in seconds

  • Format: uint64
  • Minimum: 0

Default: 10

optional LabelPrefix

Display label prefix

optional boolean

Show default interface

Referenced by:


Network select configuration

Properties (4)

optional integer

Select the received data when it’s over this value

  • Format: uint64
  • Minimum: 0

optional integer

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

  • Format: uint64
  • Minimum: 0

optional integer

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

  • Format: uint64
  • Minimum: 0

optional integer

Select the transmitted data when it’s over this value

  • Format: uint64
  • Minimum: 0

Referenced by:


Operation behaviour for temporarily unmanaged and floating windows

Enum variants (2)

Process commands on temporarily unmanaged/floated windows

Value: "Op"


Ignore commands on temporarily unmanaged/floated windows

Value: "NoOp"

Configuration:

Referenced by:


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

Configuration:

Referenced by:


Position of the overflow toggle button

Enum variants (2)

Toggle button appears on the left side (before visible icons)

Value: "Left"


Toggle button appears on the right side (after visible icons)

Value: "Right"

Referenced by:


A file system path. Environment variables like %VAR%, $Env:VAR, or $VAR are automatically resolved.

Configuration:

Referenced by:


Position

Properties (2)

required number

X coordinate

  • Format: float

required number

Y coordinate

  • Format: float

Configuration:

Referenced by:


Position configuration

Properties (2)

optional Position

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

optional Position

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

Configuration:


Rectangle dimensions

Properties (4)

required integer

Height of the rectangle (from the top point)

  • Format: int32

required integer

Left point of the rectangle

  • Format: int32

required integer

Width of the recentangle (from the left point)

  • Format: int32

required integer

Top point of the rectangle

  • Format: int32

Configuration:

Referenced by:


Colour represented as RGB

Properties (3)

required integer

Blue

  • Format: uint32
  • Minimum: 0

required integer

Green

  • Format: uint32
  • Minimum: 0

required integer

Red

  • Format: uint32
  • Minimum: 0

Configuration:

Referenced by:


Properties (2)

required array Monitor

required integer

  • Format: uint
  • Minimum: 0

Configuration:

Referenced by:


Properties (2)

required array Workspace

required integer

  • Format: uint
  • Minimum: 0

Configuration:

Referenced by:


Properties (2)

required array Container

required integer

  • Format: uint
  • Minimum: 0

Configuration:

Referenced by:


Properties (2)

required array Window

required integer

  • Format: uint
  • Minimum: 0

Configuration:

Referenced by:


Rounding configuration

Enum variants (2)

All 4 corners are the same

Value: number

  • Format: float

All 4 corners are custom. Order: NW, NE, SW, SE

Value: array number

  • Min items: 4
  • Max items: 4

Configuration:

Referenced by:


Options for the Scrolling layout

Properties (2)

required integer

Desired number of visible columns (default: 3)

  • Format: uint
  • Minimum: 0

optional boolean

With an odd number of visible columns, keep the focused window column centered

Configuration:

Referenced by:


Sizing

Enum variants (2)

Increase

Value: "Increase"


Decrease

Value: "Decrease"

Configuration:

Referenced by:


Enum variants (185)

Value: object

required OperationDirection


Value: object

required OperationDirection


Value: object

required OperationDirection


Value: object


Value: object

required CycleDirection


Value: object

required CycleDirection


Value: object

required OperationDirection


Value: object


Value: object

required CycleDirection


Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object


Value: object


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] OperationDirection

[1] Sizing


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] Axis

[1] Sizing


Value: object


Value: object


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required string


Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required CycleDirection


Value: object

required array [uint; 2]


Value: object

required array [uint; 2]


Value: object

required string


Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object

required OperationDirection


Value: object

required string


Value: object

required array [uint; 3]


Value: object

required array [uint; 3]


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object

required HidingBehaviour


Value: object


Value: object

required MoveBehaviour


Value: object

required OperationBehaviour


Value: object


Value: object


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] Sizing

[1] integer

  • Format: int32

Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] Sizing

[1] integer

  • Format: int32

Value: object

required DefaultLayout


Value: object

required CycleDirection


Value: object

required array [[array, null]; 2]


Value: object

required integer

  • Format: uint
  • Minimum: 1

Value: object

required PathBuf


Value: object

required Axis


Value: object


Value: object


Value: object

required array [uint; 5]


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] integer

  • Format: uint
  • Minimum: 0

[1] string


Value: object

required array [uint; 2]


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] integer

  • Format: uint
  • Minimum: 0

[1] array string


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object

required PathBuf


Value: object

required PathBuf


Value: object

required CycleDirection


Value: object

required CycleDirection


Value: object

required CycleDirection


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object


Value: object


Value: object


Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required integer

  • Format: uint
  • Minimum: 0

Value: object

required array [uint; 2]


Value: object

required string


Value: object

required array [uint; 3]


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] integer

  • Format: int32

Value: object

required integer

  • Format: int32

Value: object

required array [uint; 3]


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] integer

  • Format: int32

Value: object

required integer

  • Format: int32

Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] boolean


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] boolean


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] string


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] DefaultLayout


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] DefaultLayout


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] PathBuf


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] PathBuf


Value: object

required array tuple

  • Min items: 4
  • Max items: 4
Tuple Items (4)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] integer

  • Format: uint
  • Minimum: 0

[3] DefaultLayout


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] string

[1] integer

  • Format: uint
  • Minimum: 0

[2] DefaultLayout


Value: object

required array tuple

  • Min items: 4
  • Max items: 4
Tuple Items (4)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] integer

  • Format: uint
  • Minimum: 0

[3] PathBuf


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] string

[1] integer

  • Format: uint
  • Minimum: 0

[2] PathBuf


Value: object

required array [uint; 2]


Value: object

required string


Value: object


Value: object


Value: object

required PathBuf


Value: object

required PathBuf


Value: object

required boolean


Value: object


Value: object

required boolean


Value: object

required KomorebiTheme


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] boolean

[1] optional AnimationPrefix


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] integer

  • Format: uint64
  • Minimum: 0

[1] optional AnimationPrefix


Value: object

required integer

  • Format: uint64
  • Minimum: 0

Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] AnimationStyle

[1] optional AnimationPrefix


Value: object

required boolean


Value: object

required array tuple

  • Min items: 4
  • Max items: 4
Tuple Items (4)

[0] WindowKind

[1] integer

  • Format: uint32
  • Minimum: 0

[2] integer

  • Format: uint32
  • Minimum: 0

[3] integer

  • Format: uint32
  • Minimum: 0

Value: object

required BorderStyle


Value: object

required integer

  • Format: int32

Value: object

required integer

  • Format: int32

Value: object

required BorderImplementation


Value: object

required boolean


Value: object


Value: object

required integer

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

Value: object

required Rect


Value: object

required StackbarMode


Value: object

required StackbarLabel


Value: object

required array [uint32; 3]


Value: object

required array [uint32; 3]


Value: object

required array [uint32; 3]


Value: object

required integer

  • Format: int32

Value: object

required integer

  • Format: int32

Value: object

required integer

  • Format: int32

Value: object

required optional string


Value: object

required Rect


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] integer

  • Format: uint
  • Minimum: 0

[1] Rect


Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] integer

  • Format: uint
  • Minimum: 0

[1] integer

  • Format: uint
  • Minimum: 0

[2] Rect


Value: object


Value: object

required integer

  • Format: int32

Value: object

required array tuple

  • Min items: 4
  • Max items: 4
Tuple Items (4)

[0] ApplicationIdentifier

[1] string

[2] integer

  • Format: uint
  • Minimum: 0

[3] integer

  • Format: uint
  • Minimum: 0

Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] ApplicationIdentifier

[1] string

[2] string


Value: object

required array tuple

  • Min items: 4
  • Max items: 4
Tuple Items (4)

[0] ApplicationIdentifier

[1] string

[2] integer

  • Format: uint
  • Minimum: 0

[3] integer

  • Format: uint
  • Minimum: 0

Value: object

required array tuple

  • Min items: 3
  • Max items: 3
Tuple Items (3)

[0] ApplicationIdentifier

[1] string

[2] string


Value: object

required array [uint; 2]


Value: object

required string


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object


Value: object


Value: object


Value: object


Value: object

required StateQuery


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] FocusFollowsMouseImplementation

[1] boolean


Value: object

required FocusFollowsMouseImplementation


Value: object

required boolean


Value: object


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] ApplicationIdentifier

[1] string


Value: object


Value: object

required string


Value: object

required array tuple

  • Min items: 2
  • Max items: 2
Tuple Items (2)

[0] string

[1] SubscribeOptions


Value: object

required string


Value: object

required string


Value: object

required string


Value: object


Value: object


Value: object


Value: object


Value: object


Value: object

required integer

  • Format: int

Value: object

required State

Configuration:

Referenced by:


Spacing kind

Enum variants (3)

Spacing applied to all sides

Value: number

  • Format: float

Individual spacing applied to each side

Value: IndividualSpacingConfig


Grouped vertical and horizontal spacing

Value: GroupedSpacingConfig

Configuration:


Starbar label

Enum variants (2)

Process name

Value: "Process"


Window title

Value: "Title"

Configuration:

Referenced by:


Stackbar mode

Enum variants (3)

Always show

Value: "Always"


Never show

Value: "Never"


Show on stack

Value: "OnStack"

Configuration:

Referenced by:


Properties (13)

required MoveBehaviour

required boolean

required boolean

required boolean

required object

Key: "<integer>" integer

required Ring

required boolean

required WindowContainerBehaviour

required integer

  • Format: int32

required OperationBehaviour

optional FocusFollowsMouseImplementation

optional array integer

optional Rect

Configuration:

Referenced by:


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

Configuration:

Referenced by:


Storage widget configuration

Properties (8)

required boolean

Enable the Storage widget

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

optional integer

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

  • Format: uint8
  • Minimum: 0
  • Maximum: 255

optional integer

Data refresh interval in seconds

  • Format: uint64
  • Minimum: 0

Default: 10

optional LabelPrefix

Display label prefix

optional boolean

Show disks that are read only

optional boolean

Show removable disks

Default: true

optional StorageDisplayName

Storage display name

Referenced by:


Enum variants (4)

Display label as mount point eg. C:\

Value: "Mount"


Display label as name eg. Local Disk

Value: "Name"


Display label as mount then name eg. C:\ Local Disk

Value: "MountAndName"


Display label as name then mount eg. Local Disk C:\

Value: "NameAndMount"

Referenced by:


Properties (1)

required boolean

Only emit notifications when the window manager state has changed

Configuration:

Referenced by:


System tray widget configuration

Properties (7)

required boolean

Enable the System Tray widget

optional array HiddenIconRule

A list of rules for icons to hide from the system tray

Each entry can be a plain string (matches exe name, case-insensitive) or an object with optional exe, tooltip, and/or guid fields (all specified fields must match, AND logic, case-insensitive).

Run komorebi-bar with RUST_LOG=info to see the properties of all systray icons in the log output.

optional ButtonPosition

Show an info button that opens a floating panel listing all systray icons with their exe, tooltip, and GUID. Set to “Visible” to show it in the main area, or “Overflow” to show it in the hidden/overflow section.

optional OverflowTogglePosition

Position of the overflow toggle button (default: Right)

optional ButtonPosition

Show a refresh button that manually triggers stale icon cleanup. Set to “Visible” to show it in the main area, or “Overflow” to show it in the hidden/overflow section.

optional ButtonPosition

Show a button that toggles komorebi-shortcuts (kills the process if running, starts it otherwise). Set to “Visible” to show it in the main area, or “Overflow” to show it in the hidden/overflow section.

optional integer

Interval in seconds to automatically check for and remove stale icons whose owning process has exited. Clamped between 30 and 600 seconds. Defaults to 60. Set to 0 to disable.

  • Format: uint64
  • Minimum: 0

Referenced by:


Theme options

Properties (11)

optional Base16Value

Komorebi status bar accent

Default: "Base0D"

optional Base16Value

Border colour when the window is floating

Default: "Base09"

optional Base16Value

Border colour when the container is in monocle mode

Default: "Base0F"

optional Base16Value

Border colour when the container contains a single window

Default: "Base0D"

optional Base16Value

Border colour when the container contains multiple windows

Default: "Base0B"

optional Base16Value

Stackbar tab background colour

Default: "Base01"

optional Base16Value

Stackbar focused tab text colour

Default: "Base0B"

optional Base16Value

Stackbar unfocused tab text colour

Default: "Base05"

optional ThemeVariant

Specify Light or Dark variant for theme generation

Default: "Dark"

optional Base16Value

Border colour when the container is unfocused

Default: "Base01"

optional Base16Value

Border colour when the container is unfocused and locked

Default: "Base08"

Configuration:

Referenced by:


Theme variant

Enum variants (2)

Dark variant

Value: "Dark"


Light variant

Value: "Light"

Configuration:

Referenced by:


Time widget configuration

Properties (5)

required boolean

Enable the Time widget

required TimeFormat

Set the Time format

optional boolean

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

optional LabelPrefix

Display label prefix

optional 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"
}
}

Referenced by:


Time format

Enum variants (7)

Twelve-hour format (with seconds)

Value: "TwelveHour"


Twelve-hour format (without seconds)

Value: "TwelveHourWithoutSeconds"


Twenty-four-hour format (with seconds)

Value: "TwentyFourHour"


Twenty-four-hour format (without seconds)

Value: "TwentyFourHourWithoutSeconds"


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

Value: "BinaryCircle"


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

Value: "BinaryRectangle"


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

Value: Customstring

Referenced by:


Update widget configuration

Properties (3)

required boolean

Enable the Update widget

optional integer

Data refresh interval in hours

  • Format: uint64
  • Minimum: 0

Default: 12

optional LabelPrefix

Display label prefix

Referenced by:


Wallpaper configuration

Properties (3)

required PathBuf

Path to the wallpaper image file

optional boolean

Generate and apply Base16 theme for this wallpaper

Default: true

optional ThemeOptions

Specify Light or Dark variant for theme generation

Default: "Dark"

Configuration:

Referenced by:


Widget configuration

Enum variants (13)

Applications widget configuration

Value: ApplicationsApplicationsConfig


Battery widget configuration

Value: BatteryBatteryConfig


CPU widget configuration

Value: CpuCpuConfig


Date widget configuration

Value: DateDateConfig


Keyboard widget configuration

Value: KeyboardKeyboardConfig


Komorebi widget configuration

Value: KomorebiKomorebiConfig


Media widget configuration

Value: MediaMediaConfig


Memory widget configuration

Value: MemoryMemoryConfig


Network widget configuration

Value: NetworkNetworkConfig


Storage widget configuration

Value: StorageStorageConfig


System Tray widget configuration (Windows only)

Value: SystraySystrayConfig


Time widget configuration

Value: TimeTimeConfig


Update widget configuration

Value: UpdateUpdateConfig

Configuration:


Properties (1)

required integer

  • Format: int

Configuration:

Referenced by:


Window container behaviour when a new window is opened

Enum variants (2)

Create a new container for each new window

Value: "Create"


Append new windows to the focused window container

Value: "Append"

Configuration:

Referenced by:


Window kind

Enum variants (6)

Single window

Value: "Single"


Stack container

Value: "Stack"


Monocle container

Value: "Monocle"


Unfocused window

Value: "Unfocused"


Unfocused locked container

Value: "UnfocusedLocked"


Floating window

Value: "Floating"

Configuration:

Referenced by:


Properties (29)

required boolean

required Ring3

required Ring4

required array Rect

required WorkspaceLayer

required Layout

required array array tuple

required array optional Rect

Array Items

optional Rect

required boolean

required array array tuple

optional integer

  • Format: int32

optional boolean

optional FloatingLayerBehaviour

optional Axis

optional LayoutOptions

array array tuple

Threshold-based layout options rules (container_count >= threshold -> use these options). Sorted by threshold ascending at load time.

optional Window

optional integer

  • Format: uint
  • Minimum: 0

optional Container

optional integer

  • Format: uint
  • Minimum: 0

optional string

optional integer

  • Format: uint
  • Minimum: 0

optional integer

  • Format: uint
  • Minimum: 0

optional Wallpaper

optional WindowContainerBehaviour

optional array array tuple

optional Rect

optional WorkspaceConfig

optional integer

  • Format: int32

Configuration:

Referenced by:


Workspace configuration

Properties (21)

required string

Name

optional boolean

Apply this monitor’s window-based work area offset

Default: true

optional integer

Container padding (default: global)

  • Format: int32

deprecated optional PathBuf

END OF LIFE FEATURE: Custom Layout

deprecated optional object

END OF LIFE FEATURE: Custom layout rules

Key: "<integer>" string

optional boolean

Enable or disable float override, which makes it so every new window opens in floating mode

optional FloatingLayerBehaviour

Determine what happens to a new window when the Floating workspace layer is active

Default: "Tile"

optional array MatchingRule

Initial workspace application rules

optional DefaultLayout

Layout

Default: "BSP"

optional Axis

Specify an axis on which to flip the selected layout

optional LayoutOptions

Layout-specific options

optional object

Threshold-based layout options rules in the format of threshold => options. When container count >= threshold, the highest matching threshold’s options fully replace the base layout_options. This follows the same threshold logic as layout_rules.

Key: "<integer>" LayoutOptions

optional object

Layout rules in the format of threshold => layout

Key: "<integer>" DefaultLayout

optional boolean

Enable or disable tiling for the workspace

Default: true

optional Wallpaper

Specify a wallpaper for this workspace

optional WindowContainerBehaviour

Determine what happens when a new window is opened

Default: "Create"

optional object

Window container behaviour rules in the format of threshold => behaviour

Key: "<integer>" WindowContainerBehaviour

optional Rect

Workspace specific work area offset

optional object

Work area offset rules in the format of threshold => Rect (default: None)

Key: "<integer>" Rect

optional integer

Workspace padding (default: global)

  • Format: int32

optional array MatchingRule

Permanent workspace application rules

Configuration:

Referenced by:


Enum variants (2)
  • "Tiling"
  • "Floating"

Configuration:

Referenced by:


Workspaces display format

Enum variants (4)

Show all icons only

Value: "AllIcons"


Show both all icons and text

Value: "AllIconsAndText"


Show all icons and text for the selected element, and all icons on the rest

Value: "AllIconsAndTextOnSelected"


Value: DisplayFormat

Referenced by: