Configuration

animationoptional AnimationsConfig

Animations configuration options

app_specific_configuration_pathoptional AppSpecificConfigurationPath

Path to applications.json from komorebi-application-specific-configurations (default: None)

bar_configurationsoptional array PathBuf

Komorebi status bar configuration files for multiple instances on different monitors

borderoptional boolean

Display window borders (default: true)

border_coloursoptional BorderColours

Window border colours for different container types (has no effect if a theme is defined)

border_implementationoptional BorderImplementation

Window border implementation (default: Komorebi)

border_offsetoptional integer

Offset of window borders (default: -1)

Format: int32
border_overflow_applicationsoptional array MatchingRule

Identify border overflow applications

border_styleoptional BorderStyle

Window border style (default: System)

border_widthoptional integer

Width of window borders (default: 8)

Format: int32
border_z_orderdeprecatedoptional ZOrder

DEPRECATED from v0.1.31: no longer required

cross_boundary_behaviouroptional CrossBoundaryBehaviour

Determine what happens when an action is called on a window at a monitor boundary (default: Monitor)

cross_monitor_move_behaviouroptional MoveBehaviour

Determine what happens when a window is moved across a monitor boundary (default: Swap)

default_container_paddingoptional integer

Global default container padding (default: 10)

Format: int32
default_workspace_paddingoptional integer

Global default workspace padding (default: 10)

Format: int32
display_index_preferencesoptional object

Set display index preferences

"<integer>"→ string
float_overrideoptional boolean

Enable or disable float override, which makes it so every new window opens in floating mode (default: false)

float_override_placementoptional Placement

Determines the Placement to be used when spawning a window with float override active (default: None)

float_rule_placementoptional Placement

Determines the Placement to be used when spawning a window that matches a 'floating_applications' rule (default: None)

floating_applicationsoptional array MatchingRule

Identify applications which should be managed as floating windows

floating_layer_behaviouroptional FloatingLayerBehaviour

Determines what happens on a new window when on the FloatingLayer (default: Tile)

floating_layer_placementoptional Placement

Determines the Placement to be used when spawning a window on the floating layer with the FloatingLayerBehaviour set to FloatingLayerBehaviour::Float (default: Center)

floating_window_aspect_ratiooptional AspectRatio

Aspect ratio to resize with when toggling floating mode for a window

focus_follows_mousedeprecatedoptional FocusFollowsMouseImplementation

END OF LIFE FEATURE: Use https://github.com/LGUG2Z/masir instead

global_work_area_offsetoptional Rect

Global work area (space used for tiling) offset (default: None)

ignore_rulesoptional array MatchingRule

Individual window floating rules

invisible_bordersdeprecatedoptional Rect

DEPRECATED from v0.1.22: no longer required

layered_applicationsoptional array MatchingRule

Identify applications that have the WS_EX_LAYERED extended window style

manage_rulesoptional array MatchingRule

Individual window force-manage rules

minimum_window_heightoptional integer

DISCOURAGED: Minimum height for a window to be eligible for tiling

Format: int32
minimum_window_widthoptional integer

DISCOURAGED: Minimum width for a window to be eligible for tiling

Format: int32
monitor_index_preferencesoptional object

Set monitor index preferences

"<integer>"→ Rect
monitorsoptional array MonitorConfig

Monitor and workspace configurations

mouse_follows_focusoptional boolean

Enable or disable mouse follows focus (default: true)

object_name_change_applicationsoptional array MatchingRule

Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare)

object_name_change_title_ignore_listoptional array string

Do not process EVENT_OBJECT_NAMECHANGE events as Show events for identified applications matching these title regexes

remove_titlebar_applicationsoptional array MatchingRule

HEAVILY DISCOURAGED: Identify applications for which komorebi should forcibly remove title bars

resize_deltaoptional integer

Delta to resize windows by (default 50)

Format: int32
slow_application_compensation_timeoptional integer

How long to wait when compensating for slow applications, in milliseconds (default: 20)

Format: uint64Min: 0
slow_application_identifiersoptional array MatchingRule

Identify applications which are slow to send initial event notifications

stackbaroptional StackbarConfig

Stackbar configuration options

themeoptional KomorebiTheme

Theme configuration options

toggle_float_placementoptional Placement

Determines the placement of a new window when toggling to float (default: CenterAndResize)

transparencyoptional boolean

Add transparency to unfocused windows (default: false)

transparency_alphaoptional integer

Alpha value for unfocused window transparency [[0-255]] (default: 200)

Format: uint8Min: 0Max: 255
transparency_ignore_rulesoptional array MatchingRule

Individual window transparency ignore rules

tray_and_multi_window_applicationsoptional array MatchingRule

Identify tray and multi-window applications

unmanaged_window_operation_behaviouroptional OperationBehaviour

Determine what happens when commands are sent while an unmanaged window is in the foreground (default: Op)

window_container_behaviouroptional WindowContainerBehaviour

Determine what happens when a new window is opened (default: Create)

window_handling_behaviouroptional WindowHandlingBehaviour

Which Windows API behaviour to use when manipulating windows (default: Sync)

window_hiding_behaviouroptional HidingBehaviour

Which Windows signal to use when hiding windows (default: Cloak)

Type Definitions

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

Configuration Usage

Referenced by

ApplicationIdentifier

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

Configuration Usage

Referenced by

Base

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"

Configuration Usage

Referenced by

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

BorderColours

object
Properties (6)
floatingoptional Colour

Border colour when the container is in floating mode

monocleoptional Colour

Border colour when the container is in monocle mode

singleoptional Colour

Border colour when the container contains a single window

stackoptional Colour

Border colour when the container contains multiple windows

unfocusedoptional Colour

Border colour when the container is unfocused

unfocused_lockedoptional Colour

Border colour when the container is unfocused and locked

Configuration Usage

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"

Configuration Usage

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"

Configuration Usage

Catppuccin

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

Configuration Usage

Referenced by

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

CrossBoundaryBehaviour

string enum
Enum variants (2)
string

Attempt to perform actions across a workspace boundary

Value: "Workspace"
string

Attempt to perform actions across a monitor boundary

Value: "Monitor"

Configuration Usage

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"

Configuration Usage

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"

Configuration Usage

IdWithIdentifier

object
Properties (3)
idrequiredstring
kindrequiredApplicationIdentifier
matching_strategyoptional MatchingStrategy

Configuration Usage

Referenced by

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)

namerequiredBase

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)

Configuration Usage

MatchingStrategy

string
Enum variants (10)
  • "Legacy"
  • "Equals"
  • "StartsWith"
  • "EndsWith"
  • "Contains"
  • "Regex"
  • "DoesNotEndWith"
  • "DoesNotStartWith"
  • "DoesNotEqual"
  • "DoesNotContain"

Configuration Usage

Referenced by

MonitorConfig

object
Properties (8)
container_paddingoptional integer

Container padding (default: global)

Format: int32
floating_layer_behaviouroptional FloatingLayerBehaviour

Determine what happens to a new window when the Floating workspace layer is active (default: Tile)

wallpaperoptional Wallpaper

Specify a wallpaper for this monitor

window_based_work_area_offsetoptional Rect

Window based work area offset (default: None)

window_based_work_area_offset_limitoptional integer

Open window limit after which the window based work area offset will no longer be applied (default: 1)

Format: int
work_area_offsetoptional Rect

Monitor-specific work area offset (default: None)

workspace_paddingoptional integer

Workspace padding (default: global)

Format: int32
workspacesrequired array WorkspaceConfig

Workspace configurations

Configuration Usage

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"

Configuration Usage

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"

Configuration Usage

PredefinedAspectRatio

string enum
Enum variants (3)
string

21:9

Value: "Ultrawide"
string

16:9

Value: "Widescreen"
string

4:3

Value: "Standard"

Configuration Usage

Referenced by

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

Referenced by

Rgb

object
Properties (3)
brequiredinteger

Blue

Format: uint32Min: 0
grequiredinteger

Green

Format: uint32Min: 0
rrequiredinteger

Red

Format: uint32Min: 0

Configuration Usage

Referenced by

ScrollingLayoutOptions

object
Properties (2)
center_focused_columnoptional boolean

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

columnsrequiredinteger

Desired number of visible columns (default: 3)

Format: uintMin: 0

Configuration Usage

Referenced by

StackbarConfig

object
Properties (4)
heightoptional integer

Stackbar height

Format: int32
labeloptional StackbarLabel

Stackbar label

modeoptional StackbarMode

Stackbar mode (default: Never)

tabsoptional TabsConfig

Stackbar tab configuration options

Configuration Usage

TabsConfig

object
Properties (6)
backgroundoptional Colour

Tab background colour

focused_textoptional Colour

Focused tab text colour

font_familyoptional string

Font family

font_sizeoptional integer

Font size

Format: int32
unfocused_textoptional Colour

Unfocused tab text colour

widthoptional integer

Width of a stackbar tab

Format: int32

Configuration Usage

Referenced by

ThemeOptions

object
Properties (11)
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)

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)

theme_variantoptional ThemeVariant

Specify Light or Dark variant for theme generation (default: Dark)

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)

Configuration Usage

Referenced by

WorkspaceConfig

object
Properties (19)
apply_window_based_work_area_offsetoptional boolean

Apply this monitor's window-based work area offset (default: true)

container_paddingoptional integer

Container padding (default: global)

Format: int32
custom_layoutdeprecatedoptional PathBuf

END OF LIFE FEATURE: Custom Layout (default: None)

custom_layout_rulesdeprecatedoptional object

END OF LIFE FEATURE: Custom layout rules (default: None)

"<integer>"→ string
float_overrideoptional boolean

Enable or disable float override, which makes it so every new window opens in floating mode (default: false)

floating_layer_behaviouroptional FloatingLayerBehaviour

Determine what happens to a new window when the Floating workspace layer is active (default: Tile)

initial_workspace_rulesoptional array MatchingRule

Initial workspace application rules

layoutoptional DefaultLayout

Layout (default: BSP)

layout_flipoptional Axis

Specify an axis on which to flip the selected layout (default: None)

layout_optionsoptional LayoutOptions

Layout-specific options (default: None)

layout_rulesoptional object

Layout rules in the format of threshold => layout (default: None)

"<integer>"→ DefaultLayout
namerequiredstring

Name

tileoptional boolean

Enable or disable tiling for the workspace (default: true)

wallpaperoptional Wallpaper

Specify a wallpaper for this workspace

window_container_behaviouroptional WindowContainerBehaviour

Determine what happens when a new window is opened (default: Create)

window_container_behaviour_rulesoptional object

Window container behaviour rules in the format of threshold => behaviour (default: None)

"<integer>"→ WindowContainerBehaviour
work_area_offsetoptional Rect

Workspace specific work area offset (default: None)

workspace_paddingoptional integer

Workspace padding (default: global)

Format: int32
workspace_rulesoptional array MatchingRule

Permanent workspace application rules

Configuration Usage

Referenced by

ZOrder

string
Enum variants (4)
  • "Top"
  • "NoTopMost"
  • "Bottom"
  • "TopMost"

Configuration Usage