diff --git a/src/content/docs/reference/bar-windows.mdx b/src/content/docs/reference/bar-windows.mdx index f15a0e27..b6b15cc7 100644 --- a/src/content/docs/reference/bar-windows.mdx +++ b/src/content/docs/reference/bar-windows.mdx @@ -15,7 +15,6 @@ Center widgets (ordered left-to-right) - --- ### font_family {#font_family} @@ -25,20 +24,21 @@ Font family - --- ### font_size {#font_size} `number` -Font size (default: 12.5) - +Font size - **Format:** `float` +**Default:** `12.5` + + --- ### frame {#frame} @@ -48,7 +48,6 @@ Frame options (see: https://docs.rs/egui/latest/egui/containers/frame/struct.Fra - --- ### grouping {#grouping} @@ -58,33 +57,36 @@ Visual grouping for widgets - --- ### height {#height} `number` -Bar height (default: 50) - +Bar height - **Format:** `float` +**Default:** `50.0` + + --- ### icon_scale {#icon_scale} `number` -Scale of the icons relative to the font_size [[1.0-2.0]]. (default: 1.4) - +Scale of the icons relative to the font_size [[1.0-2.0]] - **Format:** `float` +**Default:** `1.399999976158142` + + --- ### left_widgets {#left_widgets} @@ -94,7 +96,6 @@ Left side widgets (ordered left-to-right) - --- ### margin {#margin} @@ -103,41 +104,45 @@ Left side widgets (ordered left-to-right) 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": \{ +```json +"margin": { "horizontal": 10 -\} - +} +``` or: -"margin": \{ +```json +"margin": { "vertical": [top, bottom] -\} - +} +``` You can also set individual margin on each side like this: -"margin": \{ +```json +"margin": { "top": 10, "bottom": 10, "left": 10, "right": 10, -\} - +} +``` By default, margin is set to 0 on all sides. - --- ### max_label_width {#max_label_width} `number` -Max label width before text truncation (default: 400.0) - +Max label width before text truncation - **Format:** `float` +**Default:** `400.0` + + --- ### monitor {#monitor} @@ -147,7 +152,6 @@ The monitor index or the full monitor options - --- ### mouse {#mouse} @@ -157,7 +161,6 @@ Options for mouse interaction on the bar - --- ### padding {#padding} @@ -166,28 +169,30 @@ Options for mouse interaction on the bar 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": \{ +```json +"padding": { "horizontal": 10 -\} - +} +``` or: -"padding": \{ +```json +"padding": { "horizontal": [left, right] -\} - +} +``` You can also set individual padding on each side like this: -"padding": \{ +```json +"padding": { "top": 10, "bottom": 10, "left": 10, "right": 10, -\} - +} +``` By default, padding is set to 10 on all sides. - --- ### position {#position} @@ -197,7 +202,6 @@ Bar positioning options - --- ### right_widgets {#right_widgets} @@ -207,7 +211,6 @@ Right side widgets (ordered left-to-right) - --- ### theme {#theme} @@ -217,14 +220,12 @@ Theme - --- ### transparency_alpha {#transparency_alpha} `integer` -Alpha value for the color transparency [[0-255]] (default: 200) - +Alpha value for the color transparency [[0-255]] @@ -233,19 +234,24 @@ Alpha value for the color transparency [[0-255]] (default: 200) - **Maximum:** 255 +**Default:** `200` + + --- ### widget_spacing {#widget_spacing} `number` -Spacing between widgets (default: 10.0) - +Spacing between widgets - **Format:** `float` +**Default:** `10.0` + + --- @@ -319,7 +325,6 @@ Spacing between widgets (default: 10.0) --- `string` -
Enum variants (30) @@ -358,7 +363,6 @@ Spacing between widgets (default: 10.0) --- `object` -
Properties (1) @@ -412,7 +416,6 @@ Spacing between widgets (default: 10.0) Command to execute (e.g. path to the application or shell command). - #### display {#appconfig-display} [`ApplicationsDisplayFormat`](#applicationsdisplayformat) @@ -420,14 +423,12 @@ Command to execute (e.g. path to the application or shell command). Display format for this application button (optional). Overrides global format if set. - #### enable {#appconfig-enable} `boolean` Whether to enable this application button (optional). -Inherits from the global Applications setting if omitted. - +Inherits from the global `Applications` setting if omitted. #### icon {#appconfig-icon} @@ -435,9 +436,8 @@ Inherits from the global Applications setting if omitted. `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. - +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`. #### name {#appconfig-name} @@ -447,14 +447,12 @@ Note: glyphs require a compatible font_family. Display name of the application. - #### show_command_on_hover {#appconfig-show_command_on_hover} `boolean` Whether to show the launch command on hover (optional). -Inherits from the global Applications setting if omitted. - +Inherits from the global `Applications` setting if omitted. @@ -618,8 +616,7 @@ Inherits from the global Applications setting if omitted. [`ApplicationsDisplayFormat`](#applicationsdisplayformat) Default display format for all applications (optional). -Could be overridden per application. Defaults to Icon. - +Could be overridden per application. Defaults to `Icon`. #### enable {#applicationsconfig-enable} @@ -629,7 +626,6 @@ Could be overridden per application. Defaults to Icon. Enables or disables the applications widget. - #### items {#applicationsconfig-items} `array` [`AppConfig`](#appconfig) @@ -637,14 +633,12 @@ Enables or disables the applications widget. List of configured applications to display. - #### show_command_on_hover {#applicationsconfig-show_command_on_hover} `boolean` Whether to show the launch command on hover (optional). -Could be overridden per application. Defaults to false if not set. - +Could be overridden per application. Defaults to `false` if not set. #### spacing {#applicationsconfig-spacing} @@ -655,7 +649,6 @@ Horizontal spacing between application buttons. - - **Format:** `float` @@ -688,21 +681,15 @@ Horizontal spacing between application buttons. --- -`string` - Show only the application icon. - - +Show only the application icon. **Value:** `"Icon"` --- -`string` - Show only the application name as text. - - +Show only the application name as text. **Value:** `"Text"` --- -`string` - Show both the application icon and name. - - +Show both the application icon and name. **Value:** `"IconAndText"`
@@ -1471,7 +1458,6 @@ Select when the current percentage is under this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -1480,14 +1466,16 @@ Select when the current percentage is under this value [[1-100]] `integer` -Data refresh interval (default: 10 seconds) - +Data refresh interval in seconds - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#batteryconfig-enable} `boolean` @@ -1495,7 +1483,6 @@ Data refresh interval (default: 10 seconds) Enable the Battery widget - #### hide_on_full_charge {#batteryconfig-hide_on_full_charge} `boolean` @@ -1503,7 +1490,6 @@ Enable the Battery widget Hide the widget if the battery is at full charge - #### label_prefix {#batteryconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -1512,7 +1498,6 @@ Display label prefix -
#### Usages @@ -1542,15 +1527,11 @@ Display label prefix --- -`string` - Use the adjustable komorebi border implementation - - +Use the adjustable komorebi border implementation **Value:** `"Komorebi"` --- -`string` - Use the thin Windows accent border implementation - - +Use the thin Windows accent border implementation **Value:** `"Windows"` @@ -1588,21 +1569,15 @@ Display label prefix --- -`string` - Use the system border style - - +Use the system border style **Value:** `"System"` --- -`string` - Use the Windows 11-style rounded borders - - +Use the Windows 11-style rounded borders **Value:** `"Rounded"` --- -`string` - Use the Windows 10-style square borders - - +Use the Windows 10-style square borders **Value:** `"Square"` @@ -1828,14 +1803,10 @@ Display label prefix [`Rgb`](#rgb) - Colour represented as RGB - - --- [`Hex`](#hex) - Colour represented as Hex - - #### Usages @@ -2028,7 +1999,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -2037,14 +2007,16 @@ Select when the current percentage is over this value [[1-100]] `integer` -Data refresh interval (default: 10 seconds) - +Data refresh interval in seconds - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#cpuconfig-enable} `boolean` @@ -2052,7 +2024,6 @@ Data refresh interval (default: 10 seconds) Enable the Cpu widget - #### label_prefix {#cpuconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -2061,7 +2032,6 @@ Display label prefix - #### Usages @@ -2086,7 +2056,6 @@ Display label prefix Custom format with additive modifiers for integer format specifiers -
Properties (2) @@ -2097,21 +2066,18 @@ Custom format with additive modifiers for integer format specifiers Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) - #### modifiers {#custommodifiers-modifiers} `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`
@@ -2294,7 +2260,6 @@ Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to incremen Enable the Date widget - #### format {#dateconfig-format} [`DateFormat`](#dateformat) @@ -2302,7 +2267,6 @@ Enable the Date widget Set the Date format - #### label_prefix {#dateconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -2310,22 +2274,22 @@ Set the Date format Display label prefix - #### timezone {#dateconfig-timezone} `string` TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) + Use a custom format to display additional information, i.e.: -\{ - "Date": \{ +```json +{ + "Date": { "enable": true, - "format": \{ "Custom": "%D %Z (Tokyo)" \}, + "format": { "Custom": "%D %Z (Tokyo)" }, "timezone": "Asia/Tokyo" - \} -\} - - + } +} +``` @@ -2358,33 +2322,23 @@ Use a custom format to display additional information, i.e.: --- -`string` - Month/Date/Year format (09/08/24) - - +Month/Date/Year format (09/08/24) **Value:** `"MonthDateYear"` --- -`string` - Year-Month-Date format (2024-09-08) - - +Year-Month-Date format (2024-09-08) **Value:** `"YearMonthDate"` --- -`string` - Date-Month-Year format (8-Sep-2024) - - +Date-Month-Year format (8-Sep-2024) **Value:** `"DateMonthYear"` --- -`string` - Day Date Month Year format (8 September 2024) - - +Day Date Month Year format (8 September 2024) **Value:** `"DayDateMonthYear"` --- `object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) - -
Properties (1) @@ -2400,8 +2354,6 @@ Use a custom format to display additional information, i.e.: --- `object` - Custom format with modifiers - -
Properties (1) @@ -2527,33 +2479,23 @@ Use a custom format to display additional information, i.e.: --- -`string` - Show only icon - - +Show only icon **Value:** `"Icon"` --- -`string` - Show only text - - +Show only text **Value:** `"Text"` --- -`string` - Show an icon and text for the selected element, and text on the rest - - +Show an icon and text for the selected element, and text on the rest **Value:** `"TextAndIconOnSelected"` --- -`string` - Show both icon and text - - +Show both icon and text **Value:** `"IconAndText"` --- -`string` - Show an icon and text for the selected element, and icons on the rest - - +Show an icon and text for the selected element, and icons on the rest **Value:** `"IconAndTextOnSelected"`
@@ -2601,15 +2543,11 @@ Use a custom format to display additional information, i.e.: --- -`string` - A custom FFM implementation (slightly more CPU-intensive) - - +A custom FFM implementation (slightly more CPU-intensive) **Value:** `"Komorebi"` --- -`string` - The native (legacy) Windows FFM implementation - - +The native (legacy) Windows FFM implementation **Value:** `"Windows"`
@@ -2662,7 +2600,6 @@ Margin inside the painted frame -
#### Usages @@ -2731,7 +2668,6 @@ Margin inside the painted frame `number` - - **Format:** `float` @@ -2739,7 +2675,6 @@ Margin inside the painted frame `array` `[float; 2]` - #### Usages @@ -2771,8 +2706,6 @@ Margin inside the painted frame --- `object` - No grouping is applied - -
Properties (1) @@ -2790,20 +2723,14 @@ Margin inside the painted frame [`GroupingConfig`](#groupingconfig) - Widgets are grouped as a whole - - --- [`GroupingConfig`](#groupingconfig) - Widgets are grouped by alignment - - --- [`GroupingConfig`](#groupingconfig) - Widgets are grouped individually - -
#### Usages @@ -2833,7 +2760,6 @@ Margin inside the painted frame Rounding values for the 4 corners. Can be a single or 4 values. - #### style {#groupingconfig-style} [`GroupingStyle`](#groupingstyle) @@ -2841,7 +2767,6 @@ Rounding values for the 4 corners. Can be a single or 4 values. Styles for the grouping - #### transparency_alpha {#groupingconfig-transparency_alpha} `integer` @@ -2850,7 +2775,6 @@ Alpha value for the color transparency [[0-255]] (default: 200) - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -2886,7 +2810,6 @@ Alpha value for the color transparency [[0-255]] (default: 200) --- `string` -
Enum variants (1) @@ -2895,39 +2818,27 @@ Alpha value for the color transparency [[0-255]] (default: 200)
--- -`string` - A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3) - - +A shadow is added under the default group. (blur: 4, offset: x-1 y-1, spread: 3) **Value:** `"DefaultWithShadowB4O1S3"` --- -`string` - A shadow is added under the default group. (blur: 4, offset: x-0 y-0, spread: 3) - - +A shadow is added under the default group. (blur: 4, offset: x-0 y-0, spread: 3) **Value:** `"DefaultWithShadowB4O0S3"` --- -`string` - A shadow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 3) - - +A shadow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 3) **Value:** `"DefaultWithShadowB0O1S3"` --- -`string` - A glow is added under the default group. (blur: 3, offset: x-1 y-1, spread: 2) - - +A glow is added under the default group. (blur: 3, offset: x-1 y-1, spread: 2) **Value:** `"DefaultWithGlowB3O1S2"` --- -`string` - A glow is added under the default group. (blur: 3, offset: x-0 y-0, spread: 2) - - +A glow is added under the default group. (blur: 3, offset: x-0 y-0, spread: 2) **Value:** `"DefaultWithGlowB3O0S2"` --- -`string` - A glow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 2) - - +A glow is added under the default group. (blur: 0, offset: x-1 y-1, spread: 2) **Value:** `"DefaultWithGlowB0O1S2"` @@ -3143,21 +3054,15 @@ Alpha value for the color transparency [[0-255]] (default: 200) --- -`string` - END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps) - - +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) - - +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 - - +Use the undocumented SetCloak Win32 function to hide windows when switching workspaces **Value:** `"Cloak"` @@ -3264,14 +3169,16 @@ Alpha value for the color transparency [[0-255]] (default: 200) `integer` -Data refresh interval (default: 1 second) - +Data refresh interval - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#keyboardconfig-enable} `boolean` @@ -3279,7 +3186,6 @@ Data refresh interval (default: 1 second) Enable the Input widget - #### label_prefix {#keyboardconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -3288,7 +3194,6 @@ Display label prefix - #### Usages @@ -3319,8 +3224,6 @@ Display label prefix --- `object` - A theme from catppuccin-egui - -
Properties (5) @@ -3352,7 +3255,6 @@ Display label prefix Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) - #### palette {#komobartheme-oneof[0]-palette} `string` @@ -3365,8 +3267,6 @@ Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catp --- `object` - A theme from base16-egui-themes - -
Properties (5) @@ -3398,7 +3298,6 @@ Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catp Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) - #### palette {#komobartheme-oneof[1]-palette} `string` @@ -3411,8 +3310,6 @@ Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinte --- `object` - A custom Base16 theme - -
Properties (5) @@ -3444,7 +3341,6 @@ Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinte Colours of the custom Base16 theme palette - #### palette {#komobartheme-oneof[2]-palette} `string` @@ -3484,7 +3380,6 @@ Colours of the custom Base16 theme palette Configure the Configuration Switcher widget - #### focused_container {#komorebiconfig-focused_container} [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) @@ -3492,7 +3387,6 @@ Configure the Configuration Switcher widget Configure the Focused Container widget - #### layout {#komorebiconfig-layout} [`KomorebiLayoutConfig`](#komorebilayoutconfig) @@ -3500,7 +3394,6 @@ Configure the Focused Container widget Configure the Layout widget - #### locked_container {#komorebiconfig-locked_container} [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) @@ -3508,7 +3401,6 @@ Configure the Layout widget Configure the Locked Container widget - #### workspace_layer {#komorebiconfig-workspace_layer} [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) @@ -3516,7 +3408,6 @@ Configure the Locked Container widget Configure the Workspace Layer widget - #### workspaces {#komorebiconfig-workspaces} [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) @@ -3525,7 +3416,6 @@ Configure the Workspaces widget -
#### Usages @@ -3557,15 +3447,13 @@ Configure the Workspaces widget `object` -A map of display friendly name => path to configuration.json - +A map of display friendly name => path to configuration.json
Additional Properties `string` -
#### enable {#komorebiconfigurationswitcherconfig-enable} @@ -3575,7 +3463,6 @@ Enable the Komorebi Configurations widget -
#### Usages @@ -3610,7 +3497,6 @@ Enable the Komorebi Configurations widget Display format of the currently focused container - #### enable {#komorebifocusedcontainerconfig-enable} `boolean` @@ -3618,13 +3504,11 @@ Display format of the currently focused container Enable the Komorebi Focused Container widget - #### show_icon {#komorebifocusedcontainerconfig-show_icon} `boolean` -DEPRECATED: use display instead (Show the icon of the currently focused container) - +DEPRECATED: use `display` instead (Show the icon of the currently focused container) @@ -3660,27 +3544,22 @@ DEPRECATED: use display instead (Show the icon of the currently focused containe [`DefaultLayout`](#defaultlayout) - --- `null` - --- `null` - --- `null` - --- `null` -
#### Usages @@ -3715,7 +3594,6 @@ DEPRECATED: use display instead (Show the icon of the currently focused containe Display format of the current layout - #### enable {#komorebilayoutconfig-enable} `boolean` @@ -3723,7 +3601,6 @@ Display format of the current layout Enable the Komorebi Layout widget - #### options {#komorebilayoutconfig-options} `array` [`KomorebiLayout`](#komorebilayout) @@ -3732,7 +3609,6 @@ List of layout options - #### Usages @@ -3767,7 +3643,6 @@ List of layout options Display format of the current locked state - #### enable {#komorebilockedcontainerconfig-enable} `boolean` @@ -3775,7 +3650,6 @@ Display format of the current locked state Enable the Komorebi Locked Container widget - #### show_when_unlocked {#komorebilockedcontainerconfig-show_when_unlocked} `boolean` @@ -3784,7 +3658,6 @@ Show the widget event if the layer is unlocked - #### Usages @@ -3816,18 +3689,22 @@ Show the widget event if the layer is unlocked `boolean` -Send the FocusMonitorAtCursor message (default:true) +Send the FocusMonitorAtCursor message +**Default:** `true` + #### ignore_mouse_follows_focus {#komorebimousemessage-ignore_mouse_follows_focus} `boolean` -Wrap the \{message\} with a MouseFollowsFocus(false) and MouseFollowsFocus(\{original.value\}) message (default:true) +Wrap the \{message\} with a MouseFollowsFocus(false) and MouseFollowsFocus(\{original.value\}) message +**Default:** `true` + #### message {#komorebimousemessage-message} [`SocketMessage`](#socketmessage) @@ -3836,7 +3713,6 @@ The message to send to the komorebi client - #### Usages @@ -3873,8 +3749,6 @@ The message to send to the komorebi client --- `object` - A theme from catppuccin-egui - -
Properties (12) @@ -3882,26 +3756,32 @@ The message to send to the komorebi client [`CatppuccinValue`](#catppuccinvalue) -Komorebi status bar accent (default: Blue) +Komorebi status bar accent +**Default:** [`"Blue"`](#catppuccinvalue) + #### floating_border {#komorebitheme-oneof[0]-floating_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the window is floating (default: Yellow) +Border colour when the window is floating +**Default:** [`"Yellow"`](#catppuccinvalue) + #### monocle_border {#komorebitheme-oneof[0]-monocle_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is in monocle mode (default: Pink) +Border colour when the container is in monocle mode +**Default:** [`"Pink"`](#catppuccinvalue) + #### name {#komorebitheme-oneof[0]-name} [`Catppuccin`](#catppuccin) @@ -3909,7 +3789,6 @@ Border colour when the container is in monocle mode (default: Pink) Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) - #### palette {#komorebitheme-oneof[0]-palette} `string` @@ -3921,65 +3800,77 @@ Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catp [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container contains a single window (default: Blue) +Border colour when the container contains a single window +**Default:** [`"Blue"`](#catppuccinvalue) + #### stack_border {#komorebitheme-oneof[0]-stack_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container contains multiple windows (default: Green) +Border colour when the container contains multiple windows +**Default:** [`"Green"`](#catppuccinvalue) + #### stackbar_background {#komorebitheme-oneof[0]-stackbar_background} [`CatppuccinValue`](#catppuccinvalue) -Stackbar tab background colour (default: Base) +Stackbar tab background colour +**Default:** [`"Base"`](#catppuccinvalue) + #### stackbar_focused_text {#komorebitheme-oneof[0]-stackbar_focused_text} [`CatppuccinValue`](#catppuccinvalue) -Stackbar focused tab text colour (default: Green) +Stackbar focused tab text colour +**Default:** [`"Green"`](#catppuccinvalue) + #### stackbar_unfocused_text {#komorebitheme-oneof[0]-stackbar_unfocused_text} [`CatppuccinValue`](#catppuccinvalue) -Stackbar unfocused tab text colour (default: Text) +Stackbar unfocused tab text colour +**Default:** [`"Text"`](#catppuccinvalue) + #### unfocused_border {#komorebitheme-oneof[0]-unfocused_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is unfocused (default: Base) +Border colour when the container is unfocused +**Default:** [`"Base"`](#catppuccinvalue) + #### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is unfocused and locked (default: Red) +Border colour when the container is unfocused and locked +**Default:** [`"Red"`](#catppuccinvalue) +
--- `object` - A theme from base16-egui-themes - -
Properties (12) @@ -3987,26 +3878,32 @@ Border colour when the container is unfocused and locked (default: Red) [`Base16Value`](#base16value) -Komorebi status bar accent (default: Base0D) +Komorebi status bar accent +**Default:** [`"Base0D"`](#base16value) + #### floating_border {#komorebitheme-oneof[1]-floating_border} [`Base16Value`](#base16value) -Border colour when the window is floating (default: Base09) +Border colour when the window is floating +**Default:** [`"Base09"`](#base16value) + #### monocle_border {#komorebitheme-oneof[1]-monocle_border} [`Base16Value`](#base16value) -Border colour when the container is in monocle mode (default: Base0F) +Border colour when the container is in monocle mode +**Default:** [`"Base0F"`](#base16value) + #### name {#komorebitheme-oneof[1]-name} [`Base16`](#base16) @@ -4014,7 +3911,6 @@ Border colour when the container is in monocle mode (default: Base0F) Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) - #### palette {#komorebitheme-oneof[1]-palette} `string` @@ -4026,65 +3922,77 @@ Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinte [`Base16Value`](#base16value) -Border colour when the container contains a single window (default: Base0D) +Border colour when the container contains a single window +**Default:** [`"Base0D"`](#base16value) + #### stack_border {#komorebitheme-oneof[1]-stack_border} [`Base16Value`](#base16value) -Border colour when the container contains multiple windows (default: Base0B) +Border colour when the container contains multiple windows +**Default:** [`"Base0B"`](#base16value) + #### stackbar_background {#komorebitheme-oneof[1]-stackbar_background} [`Base16Value`](#base16value) -Stackbar tab background colour (default: Base01) +Stackbar tab background colour +**Default:** [`"Base01"`](#base16value) + #### stackbar_focused_text {#komorebitheme-oneof[1]-stackbar_focused_text} [`Base16Value`](#base16value) -Stackbar focused tab text colour (default: Base0B) +Stackbar focused tab text colour +**Default:** [`"Base0B"`](#base16value) + #### stackbar_unfocused_text {#komorebitheme-oneof[1]-stackbar_unfocused_text} [`Base16Value`](#base16value) -Stackbar unfocused tab text colour (default: Base05) +Stackbar unfocused tab text colour +**Default:** [`"Base05"`](#base16value) + #### unfocused_border {#komorebitheme-oneof[1]-unfocused_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused (default: Base01) +Border colour when the container is unfocused +**Default:** [`"Base01"`](#base16value) + #### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused and locked (default: Base08) +Border colour when the container is unfocused and locked +**Default:** [`"Base08"`](#base16value) +
--- `object` - A custom Base16 theme - -
Properties (12) @@ -4092,10 +4000,12 @@ Border colour when the container is unfocused and locked (default: Base08) [`Base16Value`](#base16value) -Komorebi status bar accent (default: Base0D) +Komorebi status bar accent +**Default:** [`"Base0D"`](#base16value) + #### colours {#komorebitheme-oneof[2]-colours} [`Base16ColourPalette`](#base16colourpalette) @@ -4103,23 +4013,26 @@ Komorebi status bar accent (default: Base0D) Colours of the custom Base16 theme palette - #### floating_border {#komorebitheme-oneof[2]-floating_border} [`Base16Value`](#base16value) -Border colour when the window is floating (default: Base09) +Border colour when the window is floating +**Default:** [`"Base09"`](#base16value) + #### monocle_border {#komorebitheme-oneof[2]-monocle_border} [`Base16Value`](#base16value) -Border colour when the container is in monocle mode (default: Base0F) +Border colour when the container is in monocle mode +**Default:** [`"Base0F"`](#base16value) + #### palette {#komorebitheme-oneof[2]-palette} `string` @@ -4131,58 +4044,72 @@ Border colour when the container is in monocle mode (default: Base0F) [`Base16Value`](#base16value) -Border colour when the container contains a single window (default: Base0D) +Border colour when the container contains a single window +**Default:** [`"Base0D"`](#base16value) + #### stack_border {#komorebitheme-oneof[2]-stack_border} [`Base16Value`](#base16value) -Border colour when the container contains multiple windows (default: Base0B) +Border colour when the container contains multiple windows +**Default:** [`"Base0B"`](#base16value) + #### stackbar_background {#komorebitheme-oneof[2]-stackbar_background} [`Base16Value`](#base16value) -Stackbar tab background colour (default: Base01) +Stackbar tab background colour +**Default:** [`"Base01"`](#base16value) + #### stackbar_focused_text {#komorebitheme-oneof[2]-stackbar_focused_text} [`Base16Value`](#base16value) -Stackbar focused tab text colour (default: Base0B) +Stackbar focused tab text colour +**Default:** [`"Base0B"`](#base16value) + #### stackbar_unfocused_text {#komorebitheme-oneof[2]-stackbar_unfocused_text} [`Base16Value`](#base16value) -Stackbar unfocused tab text colour (default: Base05) +Stackbar unfocused tab text colour +**Default:** [`"Base05"`](#base16value) + #### unfocused_border {#komorebitheme-oneof[2]-unfocused_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused (default: Base01) +Border colour when the container is unfocused +**Default:** [`"Base01"`](#base16value) + #### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused and locked (default: Base08) +Border colour when the container is unfocused and locked +**Default:** [`"Base08"`](#base16value) +
@@ -4226,7 +4153,6 @@ Border colour when the container is unfocused and locked (default: Base08) Display format of the current layer - #### enable {#komorebiworkspacelayerconfig-enable} `boolean` @@ -4234,7 +4160,6 @@ Display format of the current layer Enable the Komorebi Workspace Layer widget - #### show_when_tiling {#komorebiworkspacelayerconfig-show_when_tiling} `boolean` @@ -4243,7 +4168,6 @@ Show the widget event if the layer is Tiling - #### Usages @@ -4278,7 +4202,6 @@ Show the widget event if the layer is Tiling Display format of the workspace - #### enable {#komorebiworkspacesconfig-enable} `boolean` @@ -4286,7 +4209,6 @@ Display format of the workspace Enable the Komorebi Workspaces widget - #### hide_empty_workspaces {#komorebiworkspacesconfig-hide_empty_workspaces} `boolean` @@ -4295,7 +4217,6 @@ Hide workspaces without any windows - #### Usages @@ -4325,27 +4246,19 @@ Hide workspaces without any windows --- -`string` - Show no prefix - - +Show no prefix **Value:** `"None"` --- -`string` - Show an icon - - +Show an icon **Value:** `"Icon"` --- -`string` - Show text - - +Show text **Value:** `"Text"` --- -`string` - Show an icon and text - - +Show an icon and text **Value:** `"IconAndText"` @@ -4415,7 +4328,6 @@ Enable the Media widget - #### Usages @@ -4451,7 +4363,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -4460,14 +4371,16 @@ Select when the current percentage is over this value [[1-100]] `integer` -Data refresh interval (default: 10 seconds) - +Data refresh interval in seconds - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#memoryconfig-enable} `boolean` @@ -4475,7 +4388,6 @@ Data refresh interval (default: 10 seconds) Enable the Memory widget - #### label_prefix {#memoryconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -4484,7 +4396,6 @@ Display label prefix - #### Usages @@ -4520,7 +4431,6 @@ Komorebi monitor index of the monitor on which to render the bar - - **Format:** `uint` - **Minimum:** 0 @@ -4532,7 +4442,6 @@ Automatically apply a work area offset for this monitor to accommodate the bar - #### Usages @@ -4563,8 +4472,6 @@ Automatically apply a work area offset for this monitor to accommodate the bar `integer` - The monitor index where you want the bar to show - - - **Format:** `uint` - **Minimum:** 0 @@ -4573,8 +4480,6 @@ Automatically apply a work area offset for this monitor to accommodate the bar [`MonitorConfig`](#monitorconfig) - The full monitor options with the index and an optional work_area_offset - - #### Usages @@ -4601,13 +4506,15 @@ Automatically apply a work area offset for this monitor to accommodate the bar `number` -Defines how many points a user needs to scroll horizontally to make a "tick" on a mouse/touchpad/touchscreen (default: 30) - +Defines how many points a user needs to scroll horizontally to make a "tick" on a mouse/touchpad/touchscreen - **Format:** `float` + +**Default:** `30.0` + #### on_extra1_click {#mouseconfig-on_extra1_click} [`MouseMessage`](#mousemessage) @@ -4615,7 +4522,6 @@ Defines how many points a user needs to scroll horizontally to make a "tick" on Command to send on extra1/back button click - #### on_extra2_click {#mouseconfig-on_extra2_click} [`MouseMessage`](#mousemessage) @@ -4623,7 +4529,6 @@ Command to send on extra1/back button click Command to send on extra2/forward button click - #### on_middle_click {#mouseconfig-on_middle_click} [`MouseMessage`](#mousemessage) @@ -4631,7 +4536,6 @@ Command to send on extra2/forward button click Command to send on middle button click - #### on_primary_double_click {#mouseconfig-on_primary_double_click} [`MouseMessage`](#mousemessage) @@ -4639,7 +4543,6 @@ Command to send on middle button click Command to send on primary/left double button click - #### on_scroll_down {#mouseconfig-on_scroll_down} [`MouseMessage`](#mousemessage) @@ -4647,7 +4550,6 @@ Command to send on primary/left double button click Command to send on scrolling down (every tick) - #### on_scroll_left {#mouseconfig-on_scroll_left} [`MouseMessage`](#mousemessage) @@ -4655,7 +4557,6 @@ Command to send on scrolling down (every tick) Command to send on scrolling left (every tick) - #### on_scroll_right {#mouseconfig-on_scroll_right} [`MouseMessage`](#mousemessage) @@ -4663,7 +4564,6 @@ Command to send on scrolling left (every tick) Command to send on scrolling right (every tick) - #### on_scroll_up {#mouseconfig-on_scroll_up} [`MouseMessage`](#mousemessage) @@ -4671,7 +4571,6 @@ Command to send on scrolling right (every tick) Command to send on scrolling up (every tick) - #### on_secondary_click {#mouseconfig-on_secondary_click} [`MouseMessage`](#mousemessage) @@ -4679,19 +4578,20 @@ Command to send on scrolling up (every tick) Command to send on secondary/right button click - #### vertical_scroll_threshold {#mouseconfig-vertical_scroll_threshold} `number` -Defines how many points a user needs to scroll vertically to make a "tick" on a mouse/touchpad/touchscreen (default: 30) - +Defines how many points a user needs to scroll vertically to make a "tick" on a mouse/touchpad/touchscreen - **Format:** `float` +**Default:** `30.0` + + #### Usages @@ -4718,44 +4618,44 @@ Defines how many points a user needs to scroll vertically to make a "tick" on a --- [`KomorebiMouseMessage`](#komorebimousemessage) - Send a message to the komorebi client. By default, a batch of messages are sent in the following order: -FocusMonitorAtCursor => -MouseFollowsFocus(false) => -\{message\} => +FocusMonitorAtCursor => +MouseFollowsFocus(false) => +\{message\} => MouseFollowsFocus(\{original.value\}) -Example: -"on_extra2_click": \{ - "message": \{ - "type": "NewWorkspace" - \} -\}, +Example: +```json +"on_extra2_click": { + "message": { + "type": "NewWorkspace" + } +}, +``` or: -"on_middle_click": \{ +```json +"on_middle_click": { "focus_monitor_at_cursor": false, "ignore_mouse_follows_focus": false, - "message": \{ + "message": { "type": "TogglePause" - \} -\} - + } +} +``` or: -"on_scroll_up": \{ - "message": \{ +```json +"on_scroll_up": { + "message": { "type": "CycleFocusWorkspace", "content": "Previous" - \} -\} - - - + } +} +``` --- `string` - Execute a custom command. CMD (%variable%), Bash ($variable) and PowerShell ($Env:variable) variables will be resolved. -Example: komorebic toggle-pause - - +Example: `komorebic toggle-pause` @@ -4793,21 +4693,15 @@ Example: komorebic toggle-pause --- -`string` - Swap the window container with the window container at the edge of the adjacent monitor - - +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 - - +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 - - +Do nothing if trying to move a window container in the direction of an adjacent monitor **Value:** `"NoOp"` @@ -4851,7 +4745,6 @@ Characters to reserve for received and transmitted activity - - **Format:** `uint` - **Minimum:** 0 @@ -4862,19 +4755,20 @@ Characters to reserve for received and transmitted activity Select when the value is over a limit (1MiB is 1048576 bytes (1024*1024)) - #### data_refresh_interval {#networkconfig-data_refresh_interval} `integer` -Data refresh interval (default: 10 seconds) - +Data refresh interval in seconds - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#networkconfig-enable} `boolean` @@ -4882,7 +4776,6 @@ Data refresh interval (default: 10 seconds) Enable the Network widget - #### label_prefix {#networkconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -4890,7 +4783,6 @@ Enable the Network widget Display label prefix - #### show_activity {#networkconfig-show_activity} `boolean` @@ -4898,7 +4790,6 @@ Display label prefix Show received and transmitted activity - #### show_default_interface {#networkconfig-show_default_interface} `boolean` @@ -4906,7 +4797,6 @@ Show received and transmitted activity Show default interface - #### show_total_activity {#networkconfig-show_total_activity} `boolean` @@ -4915,7 +4805,6 @@ Show total received and transmitted activity - #### Usages @@ -4951,7 +4840,6 @@ Select the received data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -4963,7 +4851,6 @@ Select the total received data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -4975,7 +4862,6 @@ Select the total transmitted data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -4987,7 +4873,6 @@ Select the transmitted data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -5021,15 +4906,11 @@ Select the transmitted data when it's over this value --- -`string` - Process komorebic commands on temporarily unmanaged/floated windows - - +Process komorebic commands on temporarily unmanaged/floated windows **Value:** `"Op"` --- -`string` - Ignore komorebic commands on temporarily unmanaged/floated windows - - +Ignore komorebic commands on temporarily unmanaged/floated windows **Value:** `"NoOp"` @@ -5258,7 +5139,6 @@ X coordinate - - **Format:** `float` #### y {#position-y} @@ -5269,7 +5149,6 @@ Y coordinate - - **Format:** `float` @@ -5308,7 +5187,6 @@ Y coordinate The desired size of the bar from the starting position (usually monitor width x desired height) - #### start {#positionconfig-start} [`Position`](#position) @@ -5317,7 +5195,6 @@ The desired starting position of the bar (0,0 = top left of the screen) - #### Usages @@ -5348,7 +5225,6 @@ The bottom point in a Win32 Rect - - **Format:** `int32` #### left {#rect-left} @@ -5359,7 +5235,6 @@ The left point in a Win32 Rect - - **Format:** `int32` #### right {#rect-right} @@ -5370,7 +5245,6 @@ The right point in a Win32 Rect - - **Format:** `int32` #### top {#rect-top} @@ -5381,7 +5255,6 @@ The top point in a Win32 Rect - - **Format:** `int32` @@ -5455,7 +5328,6 @@ Blue - - **Format:** `uint32` - **Minimum:** 0 @@ -5467,7 +5339,6 @@ Green - - **Format:** `uint32` - **Minimum:** 0 @@ -5479,7 +5350,6 @@ Red - - **Format:** `uint32` - **Minimum:** 0 @@ -5673,8 +5543,6 @@ Red `number` - All 4 corners are the same - - - **Format:** `float` @@ -5682,8 +5550,6 @@ Red `array` `number` - All 4 corners are custom. Order: NW, NE, SW, SE - - - **Min items:** 4 - **Max items:** 4 @@ -5781,7 +5647,6 @@ Red --- `object` -
Properties (2) @@ -5804,7 +5669,6 @@ Red --- `object` -
Properties (2) @@ -5827,7 +5691,6 @@ Red --- `object` -
Properties (2) @@ -5850,7 +5713,6 @@ Red --- `object` -
Properties (1) @@ -5866,7 +5728,6 @@ Red --- `object` -
Properties (2) @@ -5889,7 +5750,6 @@ Red --- `object` -
Properties (2) @@ -5912,7 +5772,6 @@ Red --- `object` -
Properties (2) @@ -5935,7 +5794,6 @@ Red --- `object` -
Properties (1) @@ -5951,7 +5809,6 @@ Red --- `object` -
Properties (2) @@ -5974,7 +5831,6 @@ Red --- `object` -
Properties (2) @@ -5997,7 +5853,6 @@ Red --- `object` -
Properties (2) @@ -6024,7 +5879,6 @@ Red --- `object` -
Properties (1) @@ -6040,7 +5894,6 @@ Red --- `object` -
Properties (1) @@ -6056,7 +5909,6 @@ Red --- `object` -
Properties (2) @@ -6077,11 +5929,9 @@ Red **[0]** [`OperationDirection`](#operationdirection) - **[1]** [`Sizing`](#sizing) -
#### type {#socketmessage-oneof[13]-type} @@ -6095,7 +5945,6 @@ Red --- `object` -
Properties (2) @@ -6116,11 +5965,9 @@ Red **[0]** [`Axis`](#axis) - **[1]** [`Sizing`](#sizing) -
#### type {#socketmessage-oneof[14]-type} @@ -6134,7 +5981,6 @@ Red --- `object` -
Properties (1) @@ -6150,7 +5996,6 @@ Red --- `object` -
Properties (1) @@ -6166,7 +6011,6 @@ Red --- `object` -
Properties (2) @@ -6193,7 +6037,6 @@ Red --- `object` -
Properties (2) @@ -6216,7 +6059,6 @@ Red --- `object` -
Properties (2) @@ -6243,7 +6085,6 @@ Red --- `object` -
Properties (2) @@ -6266,7 +6107,6 @@ Red --- `object` -
Properties (2) @@ -6289,7 +6129,6 @@ Red --- `object` -
Properties (2) @@ -6316,7 +6155,6 @@ Red --- `object` -
Properties (2) @@ -6339,7 +6177,6 @@ Red --- `object` -
Properties (2) @@ -6366,7 +6203,6 @@ Red --- `object` -
Properties (2) @@ -6389,7 +6225,6 @@ Red --- `object` -
Properties (2) @@ -6412,7 +6247,6 @@ Red --- `object` -
Properties (2) @@ -6435,7 +6269,6 @@ Red --- `object` -
Properties (2) @@ -6458,7 +6291,6 @@ Red --- `object` -
Properties (2) @@ -6481,7 +6313,6 @@ Red --- `object` -
Properties (2) @@ -6508,7 +6339,6 @@ Red --- `object` -
Properties (2) @@ -6535,7 +6365,6 @@ Red --- `object` -
Properties (1) @@ -6551,7 +6380,6 @@ Red --- `object` -
Properties (1) @@ -6567,7 +6395,6 @@ Red --- `object` -
Properties (1) @@ -6583,7 +6410,6 @@ Red --- `object` -
Properties (1) @@ -6599,7 +6425,6 @@ Red --- `object` -
Properties (1) @@ -6615,7 +6440,6 @@ Red --- `object` -
Properties (1) @@ -6631,7 +6455,6 @@ Red --- `object` -
Properties (2) @@ -6654,7 +6477,6 @@ Red --- `object` -
Properties (2) @@ -6677,7 +6499,6 @@ Red --- `object` -
Properties (2) @@ -6700,7 +6521,6 @@ Red --- `object` -
Properties (2) @@ -6723,7 +6543,6 @@ Red --- `object` -
Properties (1) @@ -6739,7 +6558,6 @@ Red --- `object` -
Properties (1) @@ -6755,7 +6573,6 @@ Red --- `object` -
Properties (1) @@ -6771,7 +6588,6 @@ Red --- `object` -
Properties (1) @@ -6787,7 +6603,6 @@ Red --- `object` -
Properties (1) @@ -6803,7 +6618,6 @@ Red --- `object` -
Properties (1) @@ -6819,7 +6633,6 @@ Red --- `object` -
Properties (2) @@ -6842,7 +6655,6 @@ Red --- `object` -
Properties (1) @@ -6858,7 +6670,6 @@ Red --- `object` -
Properties (2) @@ -6881,7 +6692,6 @@ Red --- `object` -
Properties (2) @@ -6904,7 +6714,6 @@ Red --- `object` -
Properties (1) @@ -6920,7 +6729,6 @@ Red --- `object` -
Properties (1) @@ -6936,7 +6744,6 @@ Red --- `object` -
Properties (2) @@ -6957,11 +6764,9 @@ Red **[0]** [`Sizing`](#sizing) - **[1]** `integer` - - **Format:** `int32` @@ -6978,7 +6783,6 @@ Red --- `object` -
Properties (2) @@ -6999,11 +6803,9 @@ Red **[0]** [`Sizing`](#sizing) - **[1]** `integer` - - **Format:** `int32` @@ -7020,7 +6822,6 @@ Red --- `object` -
Properties (2) @@ -7043,7 +6844,6 @@ Red --- `object` -
Properties (2) @@ -7066,7 +6866,6 @@ Red --- `object` -
Properties (2) @@ -7093,7 +6892,6 @@ Red --- `object` -
Properties (2) @@ -7116,7 +6914,6 @@ Red --- `object` -
Properties (2) @@ -7139,7 +6936,6 @@ Red --- `object` -
Properties (1) @@ -7155,7 +6951,6 @@ Red --- `object` -
Properties (1) @@ -7171,7 +6966,6 @@ Red --- `object` -
Properties (2) @@ -7194,7 +6988,6 @@ Red --- `object` -
Properties (2) @@ -7215,7 +7008,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -7223,7 +7015,6 @@ Red **[1]** `string` -
#### type {#socketmessage-oneof[64]-type} @@ -7237,7 +7028,6 @@ Red --- `object` -
Properties (2) @@ -7260,7 +7050,6 @@ Red --- `object` -
Properties (2) @@ -7281,7 +7070,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -7289,7 +7077,6 @@ Red **[1]** `array` `string` -
#### type {#socketmessage-oneof[66]-type} @@ -7303,7 +7090,6 @@ Red --- `object` -
Properties (1) @@ -7319,7 +7105,6 @@ Red --- `object` -
Properties (1) @@ -7335,7 +7120,6 @@ Red --- `object` -
Properties (1) @@ -7351,7 +7135,6 @@ Red --- `object` -
Properties (1) @@ -7367,7 +7150,6 @@ Red --- `object` -
Properties (1) @@ -7383,7 +7165,6 @@ Red --- `object` -
Properties (1) @@ -7399,7 +7180,6 @@ Red --- `object` -
Properties (1) @@ -7415,7 +7195,6 @@ Red --- `object` -
Properties (1) @@ -7431,7 +7210,6 @@ Red --- `object` -
Properties (1) @@ -7447,7 +7225,6 @@ Red --- `object` -
Properties (2) @@ -7470,7 +7247,6 @@ Red --- `object` -
Properties (2) @@ -7493,7 +7269,6 @@ Red --- `object` -
Properties (2) @@ -7516,7 +7291,6 @@ Red --- `object` -
Properties (2) @@ -7539,7 +7313,6 @@ Red --- `object` -
Properties (2) @@ -7562,7 +7335,6 @@ Red --- `object` -
Properties (2) @@ -7589,7 +7361,6 @@ Red --- `object` -
Properties (1) @@ -7605,7 +7376,6 @@ Red --- `object` -
Properties (1) @@ -7621,7 +7391,6 @@ Red --- `object` -
Properties (1) @@ -7637,7 +7406,6 @@ Red --- `object` -
Properties (2) @@ -7664,7 +7432,6 @@ Red --- `object` -
Properties (2) @@ -7691,7 +7458,6 @@ Red --- `object` -
Properties (2) @@ -7714,7 +7480,6 @@ Red --- `object` -
Properties (2) @@ -7737,7 +7502,6 @@ Red --- `object` -
Properties (2) @@ -7760,7 +7524,6 @@ Red --- `object` -
Properties (2) @@ -7781,11 +7544,9 @@ Red **[0]** `string` - **[1]** `integer` - - **Format:** `int32` @@ -7802,7 +7563,6 @@ Red --- `object` -
Properties (2) @@ -7828,7 +7588,6 @@ Red --- `object` -
Properties (2) @@ -7851,7 +7610,6 @@ Red --- `object` -
Properties (2) @@ -7872,11 +7630,9 @@ Red **[0]** `string` - **[1]** `integer` - - **Format:** `int32` @@ -7893,7 +7649,6 @@ Red --- `object` -
Properties (2) @@ -7919,7 +7674,6 @@ Red --- `object` -
Properties (2) @@ -7940,7 +7694,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -7948,7 +7701,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -7956,7 +7708,6 @@ Red **[2]** `boolean` -
#### type {#socketmessage-oneof[95]-type} @@ -7970,7 +7721,6 @@ Red --- `object` -
Properties (2) @@ -7991,11 +7741,9 @@ Red **[0]** `string` - **[1]** `boolean` -
#### type {#socketmessage-oneof[96]-type} @@ -8009,7 +7757,6 @@ Red --- `object` -
Properties (2) @@ -8030,7 +7777,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8038,7 +7784,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8046,7 +7791,6 @@ Red **[2]** `string` -
#### type {#socketmessage-oneof[97]-type} @@ -8060,7 +7804,6 @@ Red --- `object` -
Properties (2) @@ -8081,7 +7824,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8089,7 +7831,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8097,7 +7838,6 @@ Red **[2]** [`DefaultLayout`](#defaultlayout) -
#### type {#socketmessage-oneof[98]-type} @@ -8111,7 +7851,6 @@ Red --- `object` -
Properties (2) @@ -8132,11 +7871,9 @@ Red **[0]** `string` - **[1]** [`DefaultLayout`](#defaultlayout) -
#### type {#socketmessage-oneof[99]-type} @@ -8150,7 +7887,6 @@ Red --- `object` -
Properties (2) @@ -8171,7 +7907,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8179,7 +7914,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8187,7 +7921,6 @@ Red **[2]** [`PathBuf`](#pathbuf) -
#### type {#socketmessage-oneof[100]-type} @@ -8201,7 +7934,6 @@ Red --- `object` -
Properties (2) @@ -8222,11 +7954,9 @@ Red **[0]** `string` - **[1]** [`PathBuf`](#pathbuf) -
#### type {#socketmessage-oneof[101]-type} @@ -8240,7 +7970,6 @@ Red --- `object` -
Properties (2) @@ -8261,7 +7990,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8269,7 +7997,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8277,7 +8004,6 @@ Red **[2]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8285,7 +8011,6 @@ Red **[3]** [`DefaultLayout`](#defaultlayout) -
#### type {#socketmessage-oneof[102]-type} @@ -8299,7 +8024,6 @@ Red --- `object` -
Properties (2) @@ -8320,11 +8044,9 @@ Red **[0]** `string` - **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8332,7 +8054,6 @@ Red **[2]** [`DefaultLayout`](#defaultlayout) -
#### type {#socketmessage-oneof[103]-type} @@ -8346,7 +8067,6 @@ Red --- `object` -
Properties (2) @@ -8367,7 +8087,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8375,7 +8094,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8383,7 +8101,6 @@ Red **[2]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8391,7 +8108,6 @@ Red **[3]** [`PathBuf`](#pathbuf) -
#### type {#socketmessage-oneof[104]-type} @@ -8405,7 +8121,6 @@ Red --- `object` -
Properties (2) @@ -8426,11 +8141,9 @@ Red **[0]** `string` - **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -8438,7 +8151,6 @@ Red **[2]** [`PathBuf`](#pathbuf) -
#### type {#socketmessage-oneof[105]-type} @@ -8452,7 +8164,6 @@ Red --- `object` -
Properties (2) @@ -8475,7 +8186,6 @@ Red --- `object` -
Properties (2) @@ -8498,7 +8208,6 @@ Red --- `object` -
Properties (1) @@ -8514,7 +8223,6 @@ Red --- `object` -
Properties (1) @@ -8530,7 +8238,6 @@ Red --- `object` -
Properties (2) @@ -8553,7 +8260,6 @@ Red --- `object` -
Properties (2) @@ -8576,7 +8282,6 @@ Red --- `object` -
Properties (2) @@ -8599,7 +8304,6 @@ Red --- `object` -
Properties (1) @@ -8615,7 +8319,6 @@ Red --- `object` -
Properties (2) @@ -8638,7 +8341,6 @@ Red --- `object` -
Properties (2) @@ -8661,7 +8363,6 @@ Red --- `object` -
Properties (2) @@ -8682,11 +8383,9 @@ Red **[0]** `boolean` - **[1]** [`AnimationPrefix`](#animationprefix) -
#### type {#socketmessage-oneof[116]-type} @@ -8700,7 +8399,6 @@ Red --- `object` -
Properties (2) @@ -8721,7 +8419,6 @@ Red **[0]** `integer` - - **Format:** `uint64` - **Minimum:** 0 @@ -8729,7 +8426,6 @@ Red **[1]** [`AnimationPrefix`](#animationprefix) -
#### type {#socketmessage-oneof[117]-type} @@ -8743,7 +8439,6 @@ Red --- `object` -
Properties (2) @@ -8770,7 +8465,6 @@ Red --- `object` -
Properties (2) @@ -8791,11 +8485,9 @@ Red **[0]** [`AnimationStyle`](#animationstyle) - **[1]** [`AnimationPrefix`](#animationprefix) -
#### type {#socketmessage-oneof[119]-type} @@ -8809,7 +8501,6 @@ Red --- `object` -
Properties (2) @@ -8832,7 +8523,6 @@ Red --- `object` -
Properties (2) @@ -8853,11 +8543,9 @@ Red **[0]** [`WindowKind`](#windowkind) - **[1]** `integer` - - **Format:** `uint32` - **Minimum:** 0 @@ -8865,7 +8553,6 @@ Red **[2]** `integer` - - **Format:** `uint32` - **Minimum:** 0 @@ -8873,7 +8560,6 @@ Red **[3]** `integer` - - **Format:** `uint32` - **Minimum:** 0 @@ -8891,7 +8577,6 @@ Red --- `object` -
Properties (2) @@ -8914,7 +8599,6 @@ Red --- `object` -
Properties (2) @@ -8940,7 +8624,6 @@ Red --- `object` -
Properties (2) @@ -8966,7 +8649,6 @@ Red --- `object` -
Properties (2) @@ -8989,7 +8671,6 @@ Red --- `object` -
Properties (2) @@ -9012,7 +8693,6 @@ Red --- `object` -
Properties (1) @@ -9028,7 +8708,6 @@ Red --- `object` -
Properties (2) @@ -9056,7 +8735,6 @@ Red --- `object` -
Properties (2) @@ -9079,7 +8757,6 @@ Red --- `object` -
Properties (2) @@ -9102,7 +8779,6 @@ Red --- `object` -
Properties (2) @@ -9125,7 +8801,6 @@ Red --- `object` -
Properties (2) @@ -9148,7 +8823,6 @@ Red --- `object` -
Properties (2) @@ -9171,7 +8845,6 @@ Red --- `object` -
Properties (2) @@ -9194,7 +8867,6 @@ Red --- `object` -
Properties (2) @@ -9220,7 +8892,6 @@ Red --- `object` -
Properties (2) @@ -9246,7 +8917,6 @@ Red --- `object` -
Properties (2) @@ -9272,7 +8942,6 @@ Red --- `object` -
Properties (2) @@ -9295,7 +8964,6 @@ Red --- `object` -
Properties (2) @@ -9318,7 +8986,6 @@ Red --- `object` -
Properties (2) @@ -9339,7 +9006,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9347,7 +9013,6 @@ Red **[1]** [`Rect`](#rect) -
#### type {#socketmessage-oneof[140]-type} @@ -9361,7 +9026,6 @@ Red --- `object` -
Properties (2) @@ -9382,7 +9046,6 @@ Red **[0]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9390,7 +9053,6 @@ Red **[1]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9398,7 +9060,6 @@ Red **[2]** [`Rect`](#rect) -
#### type {#socketmessage-oneof[141]-type} @@ -9412,7 +9073,6 @@ Red --- `object` -
Properties (1) @@ -9428,7 +9088,6 @@ Red --- `object` -
Properties (2) @@ -9454,7 +9113,6 @@ Red --- `object` -
Properties (2) @@ -9475,15 +9133,12 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` - **[2]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9491,7 +9146,6 @@ Red **[3]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9509,7 +9163,6 @@ Red --- `object` -
Properties (2) @@ -9530,15 +9183,12 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` - **[2]** `string` -
#### type {#socketmessage-oneof[145]-type} @@ -9552,7 +9202,6 @@ Red --- `object` -
Properties (2) @@ -9573,15 +9222,12 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` - **[2]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9589,7 +9235,6 @@ Red **[3]** `integer` - - **Format:** `uint` - **Minimum:** 0 @@ -9607,7 +9252,6 @@ Red --- `object` -
Properties (2) @@ -9628,15 +9272,12 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` - **[2]** `string` -
#### type {#socketmessage-oneof[147]-type} @@ -9650,7 +9291,6 @@ Red --- `object` -
Properties (2) @@ -9673,7 +9313,6 @@ Red --- `object` -
Properties (2) @@ -9696,7 +9335,6 @@ Red --- `object` -
Properties (1) @@ -9712,7 +9350,6 @@ Red --- `object` -
Properties (1) @@ -9728,7 +9365,6 @@ Red --- `object` -
Properties (1) @@ -9744,7 +9380,6 @@ Red --- `object` -
Properties (1) @@ -9760,7 +9395,6 @@ Red --- `object` -
Properties (1) @@ -9776,7 +9410,6 @@ Red --- `object` -
Properties (2) @@ -9797,11 +9430,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[155]-type} @@ -9815,7 +9446,6 @@ Red --- `object` -
Properties (2) @@ -9836,11 +9466,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[156]-type} @@ -9854,7 +9482,6 @@ Red --- `object` -
Properties (2) @@ -9875,11 +9502,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[157]-type} @@ -9893,7 +9518,6 @@ Red --- `object` -
Properties (2) @@ -9914,11 +9538,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[158]-type} @@ -9932,7 +9554,6 @@ Red --- `object` -
Properties (2) @@ -9953,11 +9574,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[159]-type} @@ -9971,7 +9590,6 @@ Red --- `object` -
Properties (2) @@ -9992,11 +9610,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[160]-type} @@ -10010,7 +9626,6 @@ Red --- `object` -
Properties (1) @@ -10026,7 +9641,6 @@ Red --- `object` -
Properties (1) @@ -10042,7 +9656,6 @@ Red --- `object` -
Properties (1) @@ -10058,7 +9671,6 @@ Red --- `object` -
Properties (1) @@ -10074,7 +9686,6 @@ Red --- `object` -
Properties (2) @@ -10097,7 +9708,6 @@ Red --- `object` -
Properties (2) @@ -10118,11 +9728,9 @@ Red **[0]** [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation) - **[1]** `boolean` -
#### type {#socketmessage-oneof[166]-type} @@ -10136,7 +9744,6 @@ Red --- `object` -
Properties (2) @@ -10159,7 +9766,6 @@ Red --- `object` -
Properties (2) @@ -10182,7 +9788,6 @@ Red --- `object` -
Properties (1) @@ -10198,7 +9803,6 @@ Red --- `object` -
Properties (2) @@ -10219,11 +9823,9 @@ Red **[0]** [`ApplicationIdentifier`](#applicationidentifier) - **[1]** `string` -
#### type {#socketmessage-oneof[170]-type} @@ -10237,7 +9839,6 @@ Red --- `object` -
Properties (1) @@ -10253,7 +9854,6 @@ Red --- `object` -
Properties (2) @@ -10276,7 +9876,6 @@ Red --- `object` -
Properties (2) @@ -10297,11 +9896,9 @@ Red **[0]** `string` - **[1]** [`SubscribeOptions`](#subscribeoptions) -
#### type {#socketmessage-oneof[173]-type} @@ -10315,7 +9912,6 @@ Red --- `object` -
Properties (2) @@ -10338,7 +9934,6 @@ Red --- `object` -
Properties (2) @@ -10361,7 +9956,6 @@ Red --- `object` -
Properties (2) @@ -10384,7 +9978,6 @@ Red --- `object` -
Properties (1) @@ -10400,7 +9993,6 @@ Red --- `object` -
Properties (1) @@ -10416,7 +10008,6 @@ Red --- `object` -
Properties (1) @@ -10432,7 +10023,6 @@ Red --- `object` -
Properties (1) @@ -10448,7 +10038,6 @@ Red --- `object` -
Properties (1) @@ -10464,7 +10053,6 @@ Red --- `object` -
Properties (2) @@ -10526,7 +10114,6 @@ Red `number` - - **Format:** `float` @@ -10534,12 +10121,10 @@ Red [`IndividualSpacingConfig`](#individualspacingconfig) - --- [`GroupedSpacingConfig`](#groupedspacingconfig) -
#### Usages @@ -10686,7 +10271,6 @@ Hide when the current percentage is under this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -10699,7 +10283,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -10708,14 +10291,16 @@ Select when the current percentage is over this value [[1-100]] `integer` -Data refresh interval (default: 10 seconds) - +Data refresh interval in seconds - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `10` + #### enable {#storageconfig-enable} `boolean` @@ -10723,7 +10308,6 @@ Data refresh interval (default: 10 seconds) Enable the Storage widget - #### label_prefix {#storageconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -10731,23 +10315,23 @@ Enable the Storage widget Display label prefix - #### show_read_only_disks {#storageconfig-show_read_only_disks} `boolean` -Show disks that are read only. (default: false) - +Show disks that are read only #### show_removable_disks {#storageconfig-show_removable_disks} `boolean` -Show removable disks. (default: true) +Show removable disks +**Default:** `true` +
#### Usages @@ -10784,7 +10368,6 @@ Only emit notifications when the window manager state has changed -
#### Usages @@ -10822,8 +10405,7 @@ Only emit notifications when the window manager state has changed `boolean` -Change the icon depending on the time. The default icon is used between 8:30 and 12:00. (default: false) - +Change the icon depending on the time. The default icon is used between 8:30 and 12:00 #### enable {#timeconfig-enable} @@ -10833,7 +10415,6 @@ Change the icon depending on the time. The default icon is used between 8:30 and Enable the Time widget - #### format {#timeconfig-format} [`TimeFormat`](#timeformat) @@ -10841,7 +10422,6 @@ Enable the Time widget Set the Time format - #### label_prefix {#timeconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -10849,22 +10429,22 @@ Set the Time format Display label prefix - #### timezone {#timeconfig-timezone} `string` TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html) + Use a custom format to display additional information, i.e.: -\{ - "Time": \{ +```json +{ + "Time": { "enable": true, - "format": \{ "Custom": "%T %Z (Tokyo)" \}, + "format": { "Custom": "%T %Z (Tokyo)" }, "timezone": "Asia/Tokyo" - \} -\} - - + } +} +``` @@ -10897,45 +10477,31 @@ Use a custom format to display additional information, i.e.: --- -`string` - Twelve-hour format (with seconds) - - +Twelve-hour format (with seconds) **Value:** `"TwelveHour"` --- -`string` - Twelve-hour format (without seconds) - - +Twelve-hour format (without seconds) **Value:** `"TwelveHourWithoutSeconds"` --- -`string` - Twenty-four-hour format (with seconds) - - +Twenty-four-hour format (with seconds) **Value:** `"TwentyFourHour"` --- -`string` - Twenty-four-hour format (without seconds) - - +Twenty-four-hour format (without seconds) **Value:** `"TwentyFourHourWithoutSeconds"` --- -`string` - Twenty-four-hour format displayed as a binary clock with circles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) - - +Twenty-four-hour format displayed as a binary clock with circles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) **Value:** `"BinaryCircle"` --- -`string` - Twenty-four-hour format displayed as a binary clock with rectangles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) - - +Twenty-four-hour format displayed as a binary clock with rectangles (with seconds) (https://en.wikipedia.org/wiki/Binary_clock) **Value:** `"BinaryRectangle"` --- `object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html) - -
Properties (1) @@ -10980,14 +10546,16 @@ Use a custom format to display additional information, i.e.: `integer` -Data refresh interval (default: 12 hours) - +Data refresh interval in hours - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `12` + #### enable {#updateconfig-enable} `boolean` @@ -10995,7 +10563,6 @@ Data refresh interval (default: 12 hours) Enable the Update widget - #### label_prefix {#updateconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -11004,7 +10571,6 @@ Display label prefix -
#### Usages @@ -11035,7 +10601,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11051,7 +10616,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11067,7 +10631,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11083,7 +10646,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11099,7 +10661,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11115,7 +10676,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11131,7 +10691,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11147,7 +10706,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11163,7 +10721,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11179,7 +10736,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11195,7 +10751,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11211,7 +10766,6 @@ Display label prefix --- `object` -
Properties (1) @@ -11291,28 +10845,21 @@ Display label prefix --- -`string` - Show all icons only - - +Show all icons only **Value:** `"AllIcons"` --- -`string` - Show both all icons and text - - +Show both all icons and text **Value:** `"AllIconsAndText"` --- -`string` - Show all icons and text for the selected element, and all icons on the rest - - +Show all icons and text for the selected element, and all icons on the rest **Value:** `"AllIconsAndTextOnSelected"` --- [`DisplayFormat`](#displayformat) -
#### Usages diff --git a/src/content/docs/reference/komorebi-windows.mdx b/src/content/docs/reference/komorebi-windows.mdx index fc889096..75fe8b49 100644 --- a/src/content/docs/reference/komorebi-windows.mdx +++ b/src/content/docs/reference/komorebi-windows.mdx @@ -15,14 +15,12 @@ Animations configuration options - --- ### app_specific_configuration_path {#app_specific_configuration_path} [`AppSpecificConfigurationPath`](#appspecificconfigurationpath) -Path to applications.json from komorebi-application-specific-configurations (default: None) - +Path to applications.json from komorebi-application-specific-configurations @@ -35,16 +33,17 @@ Komorebi status bar configuration files for multiple instances on different moni - --- ### border {#border} `boolean` -Display window borders (default: true) +Display window borders +**Default:** `true` + --- ### border_colours {#border_colours} @@ -55,30 +54,33 @@ Window border colours for different container types (has no effect if a theme is - --- ### border_implementation {#border_implementation} [`BorderImplementation`](#borderimplementation) -Window border implementation (default: Komorebi) +Window border implementation +**Default:** [`"Komorebi"`](#borderimplementation) + --- ### border_offset {#border_offset} `integer` -Offset of window borders (default: -1) - +Offset of window borders - **Format:** `int32` +**Default:** `-1` + + --- ### border_overflow_applications {#border_overflow_applications} @@ -88,30 +90,33 @@ Identify border overflow applications - --- ### border_style {#border_style} [`BorderStyle`](#borderstyle) -Window border style (default: System) +Window border style +**Default:** [`"System"`](#borderstyle) + --- ### border_width {#border_width} `integer` -Width of window borders (default: 8) - +Width of window borders - **Format:** `int32` +**Default:** `8` + + --- ### border_z_order {#border_z_order} @@ -121,53 +126,60 @@ DEPRECATED from v0.1.31: no longer required - --- ### cross_boundary_behaviour {#cross_boundary_behaviour} [`CrossBoundaryBehaviour`](#crossboundarybehaviour) -Determine what happens when an action is called on a window at a monitor boundary (default: Monitor) +Determine what happens when an action is called on a window at a monitor boundary +**Default:** [`"Monitor"`](#crossboundarybehaviour) + --- ### cross_monitor_move_behaviour {#cross_monitor_move_behaviour} [`MoveBehaviour`](#movebehaviour) -Determine what happens when a window is moved across a monitor boundary (default: Swap) +Determine what happens when a window is moved across a monitor boundary +**Default:** [`"Swap"`](#movebehaviour) + --- ### default_container_padding {#default_container_padding} `integer` -Global default container padding (default: 10) - +Global default container padding - **Format:** `int32` +**Default:** `10` + + --- ### default_workspace_padding {#default_workspace_padding} `integer` -Global default workspace padding (default: 10) - +Global default workspace padding - **Format:** `int32` +**Default:** `10` + + --- ### display_index_preferences {#display_index_preferences} @@ -178,7 +190,6 @@ Set display index preferences - **Key:** `""` **→** `string` @@ -191,8 +202,6 @@ Set display index preferences `boolean` Enable or disable float override, which makes it so every new window opens in floating mode -(default: false) - @@ -201,9 +210,7 @@ Enable or disable float override, which makes it so every new window opens in fl [`Placement`](#placement) -Determines the Placement to be used when spawning a window with float override active -(default: None) - +Determines the `Placement` to be used when spawning a window with float override active @@ -212,9 +219,8 @@ Determines the Placement to be used when spawning a window with float override a [`Placement`](#placement) -Determines the Placement to be used when spawning a window that matches a -floating_applications rule (default: None) - +Determines the `Placement` to be used when spawning a window that matches a +`floating_applications` rule @@ -227,28 +233,30 @@ Identify applications which should be managed as floating windows - --- ### floating_layer_behaviour {#floating_layer_behaviour} [`FloatingLayerBehaviour`](#floatinglayerbehaviour) -Determines what happens on a new window when on the FloatingLayer -(default: Tile) +Determines what happens on a new window when on the `FloatingLayer` +**Default:** [`"Tile"`](#floatinglayerbehaviour) + --- ### floating_layer_placement {#floating_layer_placement} [`Placement`](#placement) -Determines the Placement to be used when spawning a window on the floating layer with the -FloatingLayerBehaviour set to FloatingLayerBehaviour::Float (default: Center) +Determines the `Placement` to be used when spawning a window on the floating layer with the +`FloatingLayerBehaviour` set to `FloatingLayerBehaviour::Float` +**Default:** [`"Center"`](#placement) + --- ### floating_window_aspect_ratio {#floating_window_aspect_ratio} @@ -259,7 +267,6 @@ Aspect ratio to resize with when toggling floating mode for a window - --- ### focus_follows_mouse {#focus_follows_mouse} @@ -269,14 +276,12 @@ END OF LIFE FEATURE: Use https://github.com/LGUG2Z/masir instead - --- ### global_work_area_offset {#global_work_area_offset} [`Rect`](#rect) -Global work area (space used for tiling) offset (default: None) - +Global work area (space used for tiling) offset @@ -289,7 +294,6 @@ Individual window floating rules - --- ### invisible_borders {#invisible_borders} @@ -299,14 +303,12 @@ DEPRECATED from v0.1.22: no longer required - --- ### layered_applications {#layered_applications} `array` [`MatchingRule`](#matchingrule) -Identify applications that have the WS_EX_LAYERED extended window style - +Identify applications that have the `WS_EX_LAYERED` extended window style @@ -319,7 +321,6 @@ Individual window force-manage rules - --- ### minimum_window_height {#minimum_window_height} @@ -329,7 +330,6 @@ DISCOURAGED: Minimum height for a window to be eligible for tiling - - **Format:** `int32` @@ -342,7 +342,6 @@ DISCOURAGED: Minimum width for a window to be eligible for tiling - - **Format:** `int32` @@ -356,7 +355,6 @@ Set monitor index preferences - **Key:** `""` **→** [`Rect`](#rect) @@ -372,24 +370,24 @@ Monitor and workspace configurations - --- ### mouse_follows_focus {#mouse_follows_focus} `boolean` -Enable or disable mouse follows focus (default: true) +Enable or disable mouse follows focus +**Default:** `true` + --- ### object_name_change_applications {#object_name_change_applications} `array` [`MatchingRule`](#matchingrule) -Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare) - +Identify applications that send `EVENT_OBJECT_NAMECHANGE` on launch (very rare) @@ -398,8 +396,7 @@ Identify applications that send EVENT_OBJECT_NAMECHANGE on launch (very rare) `array` `string` -Do not process EVENT_OBJECT_NAMECHANGE events as Show events for identified applications matching these title regexes - +Do not process `EVENT_OBJECT_NAMECHANGE` events as Show events for identified applications matching these title regexes @@ -412,27 +409,27 @@ HEAVILY DISCOURAGED: Identify applications for which komorebi should forcibly re - --- ### resize_delta {#resize_delta} `integer` -Delta to resize windows by (default 50) - +Delta to resize windows by - **Format:** `int32` +**Default:** `50` + + --- ### slow_application_compensation_time {#slow_application_compensation_time} `integer` -How long to wait when compensating for slow applications, in milliseconds (default: 20) - +How long to wait when compensating for slow applications, in milliseconds @@ -440,6 +437,9 @@ How long to wait when compensating for slow applications, in milliseconds (defau - **Minimum:** 0 +**Default:** `20` + + --- ### slow_application_identifiers {#slow_application_identifiers} @@ -449,7 +449,6 @@ Identify applications which are slow to send initial event notifications - --- ### stackbar {#stackbar} @@ -459,7 +458,6 @@ Stackbar configuration options - --- ### theme {#theme} @@ -469,24 +467,24 @@ Theme configuration options - --- ### toggle_float_placement {#toggle_float_placement} [`Placement`](#placement) -Determines the placement of a new window when toggling to float (default: CenterAndResize) +Determines the placement of a new window when toggling to float +**Default:** [`"CenterAndResize"`](#placement) + --- ### transparency {#transparency} `boolean` -Add transparency to unfocused windows (default: false) - +Add transparency to unfocused windows @@ -495,8 +493,7 @@ Add transparency to unfocused windows (default: false) `integer` -Alpha value for unfocused window transparency [[0-255]] (default: 200) - +Alpha value for unfocused window transparency [[0-255]] @@ -505,6 +502,9 @@ Alpha value for unfocused window transparency [[0-255]] (default: 200) - **Maximum:** 255 +**Default:** `200` + + --- ### transparency_ignore_rules {#transparency_ignore_rules} @@ -514,7 +514,6 @@ Individual window transparency ignore rules - --- ### tray_and_multi_window_applications {#tray_and_multi_window_applications} @@ -524,46 +523,53 @@ Identify tray and multi-window applications - --- ### unmanaged_window_operation_behaviour {#unmanaged_window_operation_behaviour} [`OperationBehaviour`](#operationbehaviour) -Determine what happens when commands are sent while an unmanaged window is in the foreground (default: Op) +Determine what happens when commands are sent while an unmanaged window is in the foreground +**Default:** [`"Op"`](#operationbehaviour) + --- ### window_container_behaviour {#window_container_behaviour} [`WindowContainerBehaviour`](#windowcontainerbehaviour) -Determine what happens when a new window is opened (default: Create) +Determine what happens when a new window is opened +**Default:** [`"Create"`](#windowcontainerbehaviour) + --- ### window_handling_behaviour {#window_handling_behaviour} [`WindowHandlingBehaviour`](#windowhandlingbehaviour) -Which Windows API behaviour to use when manipulating windows (default: Sync) +Which Windows API behaviour to use when manipulating windows +**Default:** [`"Sync"`](#windowhandlingbehaviour) + --- ### window_hiding_behaviour {#window_hiding_behaviour} [`HidingBehaviour`](#hidingbehaviour) -Which Windows signal to use when hiding windows (default: Cloak) +Which Windows signal to use when hiding windows +**Default:** [`"Cloak"`](#hidingbehaviour) + --- @@ -584,7 +590,6 @@ Which Windows signal to use when hiding windows (default: Cloak) --- `string` -
Enum variants (30) @@ -623,7 +628,6 @@ Which Windows signal to use when hiding windows (default: Cloak) --- `object` -
Properties (1) @@ -667,36 +671,35 @@ Which Windows signal to use when hiding windows (default: Cloak) [`PerAnimationPrefixConfig`](#peranimationprefixconfig2) `integer` -Set the animation duration in ms (default: 250) - +Set the animation duration in ms #### enabled {#animationsconfig-enabled} [`PerAnimationPrefixConfig`](#peranimationprefixconfig) `boolean` -Enable or disable animations (default: false) - +Enable or disable animations #### fps {#animationsconfig-fps} `integer` -Set the animation FPS (default: 60) - +Set the animation FPS - **Format:** `uint64` - **Minimum:** 0 + +**Default:** `60` + #### style {#animationsconfig-style} [`PerAnimationPrefixConfig`](#peranimationprefixconfig3) [`AnimationStyle`](#animationstyle) -Set the animation style (default: Linear) - +Set the animation style @@ -724,15 +727,11 @@ Set the animation style (default: Linear) --- -[`PathBuf`](#pathbuf) - A single applications.json file - - +[`PathBuf`](#pathbuf) - A single `applications.json` file --- -`array` [`PathBuf`](#pathbuf) - Multiple applications.json files - - +`array` [`PathBuf`](#pathbuf) - Multiple `applications.json` files
@@ -815,14 +814,10 @@ Set the animation style (default: Linear) [`PredefinedAspectRatio`](#predefinedaspectratio) - A predefined aspect ratio - - --- `array` `[integer; 2]` - A custom W:H aspect ratio - -
#### Usages @@ -1396,7 +1391,6 @@ Set the animation style (default: Linear) Border colour when the container is in floating mode - #### monocle {#bordercolours-monocle} [`Colour`](#colour) @@ -1404,7 +1398,6 @@ Border colour when the container is in floating mode Border colour when the container is in monocle mode - #### single {#bordercolours-single} [`Colour`](#colour) @@ -1412,7 +1405,6 @@ Border colour when the container is in monocle mode Border colour when the container contains a single window - #### stack {#bordercolours-stack} [`Colour`](#colour) @@ -1420,7 +1412,6 @@ Border colour when the container contains a single window Border colour when the container contains multiple windows - #### unfocused {#bordercolours-unfocused} [`Colour`](#colour) @@ -1428,7 +1419,6 @@ Border colour when the container contains multiple windows Border colour when the container is unfocused - #### unfocused_locked {#bordercolours-unfocused_locked} [`Colour`](#colour) @@ -1437,7 +1427,6 @@ Border colour when the container is unfocused and locked -
#### Usages @@ -1462,15 +1451,11 @@ Border colour when the container is unfocused and locked --- -`string` - Use the adjustable komorebi border implementation - - +Use the adjustable komorebi border implementation **Value:** `"Komorebi"` --- -`string` - Use the thin Windows accent border implementation - - +Use the thin Windows accent border implementation **Value:** `"Windows"`
@@ -1497,21 +1482,15 @@ Border colour when the container is unfocused and locked --- -`string` - Use the system border style - - +Use the system border style **Value:** `"System"` --- -`string` - Use the Windows 11-style rounded borders - - +Use the Windows 11-style rounded borders **Value:** `"Rounded"` --- -`string` - Use the Windows 10-style square borders - - +Use the Windows 10-style square borders **Value:** `"Square"`
@@ -1632,14 +1611,10 @@ Border colour when the container is unfocused and locked [`Rgb`](#rgb) - Colour represented as RGB - - --- [`Hex`](#hex) - Colour represented as Hex - -
#### Usages @@ -1693,15 +1668,11 @@ Border colour when the container is unfocused and locked --- -`string` - Attempt to perform actions across a workspace boundary - - +Attempt to perform actions across a workspace boundary **Value:** `"Workspace"` --- -`string` - Attempt to perform actions across a monitor boundary - - +Attempt to perform actions across a monitor boundary **Value:** `"Monitor"`
@@ -1764,15 +1735,11 @@ Border colour when the container is unfocused and locked --- -`string` - Tile new windows (unless they match a float rule or float override is active) - - +Tile new windows (unless they match a float rule or float override is active) **Value:** `"Tile"` --- -`string` - Float new windows - - +Float new windows **Value:** `"Float"`
@@ -1805,15 +1772,11 @@ Border colour when the container is unfocused and locked --- -`string` - A custom FFM implementation (slightly more CPU-intensive) - - +A custom FFM implementation (slightly more CPU-intensive) **Value:** `"Komorebi"` --- -`string` - The native (legacy) Windows FFM implementation - - +The native (legacy) Windows FFM implementation **Value:** `"Windows"`
@@ -1846,7 +1809,6 @@ Maximum number of rows per grid column - - **Format:** `uint` - **Minimum:** 0 @@ -1927,21 +1889,15 @@ Maximum number of rows per grid column --- -`string` - END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps) - - +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) - - +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 - - +Use the undocumented SetCloak Win32 function to hide windows when switching workspaces **Value:** `"Cloak"`
@@ -2039,8 +1995,6 @@ Maximum number of rows per grid column --- `object` - A theme from catppuccin-egui - -
Properties (12) @@ -2048,26 +2002,32 @@ Maximum number of rows per grid column [`CatppuccinValue`](#catppuccinvalue) -Komorebi status bar accent (default: Blue) +Komorebi status bar accent +**Default:** [`"Blue"`](#catppuccinvalue) + #### floating_border {#komorebitheme-oneof[0]-floating_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the window is floating (default: Yellow) +Border colour when the window is floating +**Default:** [`"Yellow"`](#catppuccinvalue) + #### monocle_border {#komorebitheme-oneof[0]-monocle_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is in monocle mode (default: Pink) +Border colour when the container is in monocle mode +**Default:** [`"Pink"`](#catppuccinvalue) + #### name {#komorebitheme-oneof[0]-name} [`Catppuccin`](#catppuccin) @@ -2075,7 +2035,6 @@ Border colour when the container is in monocle mode (default: Pink) Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) - #### palette {#komorebitheme-oneof[0]-palette} `string` @@ -2087,65 +2046,77 @@ Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catp [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container contains a single window (default: Blue) +Border colour when the container contains a single window +**Default:** [`"Blue"`](#catppuccinvalue) + #### stack_border {#komorebitheme-oneof[0]-stack_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container contains multiple windows (default: Green) +Border colour when the container contains multiple windows +**Default:** [`"Green"`](#catppuccinvalue) + #### stackbar_background {#komorebitheme-oneof[0]-stackbar_background} [`CatppuccinValue`](#catppuccinvalue) -Stackbar tab background colour (default: Base) +Stackbar tab background colour +**Default:** [`"Base"`](#catppuccinvalue) + #### stackbar_focused_text {#komorebitheme-oneof[0]-stackbar_focused_text} [`CatppuccinValue`](#catppuccinvalue) -Stackbar focused tab text colour (default: Green) +Stackbar focused tab text colour +**Default:** [`"Green"`](#catppuccinvalue) + #### stackbar_unfocused_text {#komorebitheme-oneof[0]-stackbar_unfocused_text} [`CatppuccinValue`](#catppuccinvalue) -Stackbar unfocused tab text colour (default: Text) +Stackbar unfocused tab text colour +**Default:** [`"Text"`](#catppuccinvalue) + #### unfocused_border {#komorebitheme-oneof[0]-unfocused_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is unfocused (default: Base) +Border colour when the container is unfocused +**Default:** [`"Base"`](#catppuccinvalue) + #### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border} [`CatppuccinValue`](#catppuccinvalue) -Border colour when the container is unfocused and locked (default: Red) +Border colour when the container is unfocused and locked +**Default:** [`"Red"`](#catppuccinvalue) +
--- `object` - A theme from base16-egui-themes - -
Properties (12) @@ -2153,26 +2124,32 @@ Border colour when the container is unfocused and locked (default: Red) [`Base16Value`](#base16value) -Komorebi status bar accent (default: Base0D) +Komorebi status bar accent +**Default:** [`"Base0D"`](#base16value) + #### floating_border {#komorebitheme-oneof[1]-floating_border} [`Base16Value`](#base16value) -Border colour when the window is floating (default: Base09) +Border colour when the window is floating +**Default:** [`"Base09"`](#base16value) + #### monocle_border {#komorebitheme-oneof[1]-monocle_border} [`Base16Value`](#base16value) -Border colour when the container is in monocle mode (default: Base0F) +Border colour when the container is in monocle mode +**Default:** [`"Base0F"`](#base16value) + #### name {#komorebitheme-oneof[1]-name} [`Base16`](#base16) @@ -2180,7 +2157,6 @@ Border colour when the container is in monocle mode (default: Base0F) Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/) - #### palette {#komorebitheme-oneof[1]-palette} `string` @@ -2192,65 +2168,77 @@ Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinte [`Base16Value`](#base16value) -Border colour when the container contains a single window (default: Base0D) +Border colour when the container contains a single window +**Default:** [`"Base0D"`](#base16value) + #### stack_border {#komorebitheme-oneof[1]-stack_border} [`Base16Value`](#base16value) -Border colour when the container contains multiple windows (default: Base0B) +Border colour when the container contains multiple windows +**Default:** [`"Base0B"`](#base16value) + #### stackbar_background {#komorebitheme-oneof[1]-stackbar_background} [`Base16Value`](#base16value) -Stackbar tab background colour (default: Base01) +Stackbar tab background colour +**Default:** [`"Base01"`](#base16value) + #### stackbar_focused_text {#komorebitheme-oneof[1]-stackbar_focused_text} [`Base16Value`](#base16value) -Stackbar focused tab text colour (default: Base0B) +Stackbar focused tab text colour +**Default:** [`"Base0B"`](#base16value) + #### stackbar_unfocused_text {#komorebitheme-oneof[1]-stackbar_unfocused_text} [`Base16Value`](#base16value) -Stackbar unfocused tab text colour (default: Base05) +Stackbar unfocused tab text colour +**Default:** [`"Base05"`](#base16value) + #### unfocused_border {#komorebitheme-oneof[1]-unfocused_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused (default: Base01) +Border colour when the container is unfocused +**Default:** [`"Base01"`](#base16value) + #### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused and locked (default: Base08) +Border colour when the container is unfocused and locked +**Default:** [`"Base08"`](#base16value) +
--- `object` - A custom Base16 theme - -
Properties (12) @@ -2258,10 +2246,12 @@ Border colour when the container is unfocused and locked (default: Base08) [`Base16Value`](#base16value) -Komorebi status bar accent (default: Base0D) +Komorebi status bar accent +**Default:** [`"Base0D"`](#base16value) + #### colours {#komorebitheme-oneof[2]-colours} [`Base16ColourPalette`](#base16colourpalette) @@ -2269,23 +2259,26 @@ Komorebi status bar accent (default: Base0D) Colours of the custom Base16 theme palette - #### floating_border {#komorebitheme-oneof[2]-floating_border} [`Base16Value`](#base16value) -Border colour when the window is floating (default: Base09) +Border colour when the window is floating +**Default:** [`"Base09"`](#base16value) + #### monocle_border {#komorebitheme-oneof[2]-monocle_border} [`Base16Value`](#base16value) -Border colour when the container is in monocle mode (default: Base0F) +Border colour when the container is in monocle mode +**Default:** [`"Base0F"`](#base16value) + #### palette {#komorebitheme-oneof[2]-palette} `string` @@ -2297,58 +2290,72 @@ Border colour when the container is in monocle mode (default: Base0F) [`Base16Value`](#base16value) -Border colour when the container contains a single window (default: Base0D) +Border colour when the container contains a single window +**Default:** [`"Base0D"`](#base16value) + #### stack_border {#komorebitheme-oneof[2]-stack_border} [`Base16Value`](#base16value) -Border colour when the container contains multiple windows (default: Base0B) +Border colour when the container contains multiple windows +**Default:** [`"Base0B"`](#base16value) + #### stackbar_background {#komorebitheme-oneof[2]-stackbar_background} [`Base16Value`](#base16value) -Stackbar tab background colour (default: Base01) +Stackbar tab background colour +**Default:** [`"Base01"`](#base16value) + #### stackbar_focused_text {#komorebitheme-oneof[2]-stackbar_focused_text} [`Base16Value`](#base16value) -Stackbar focused tab text colour (default: Base0B) +Stackbar focused tab text colour +**Default:** [`"Base0B"`](#base16value) + #### stackbar_unfocused_text {#komorebitheme-oneof[2]-stackbar_unfocused_text} [`Base16Value`](#base16value) -Stackbar unfocused tab text colour (default: Base05) +Stackbar unfocused tab text colour +**Default:** [`"Base05"`](#base16value) + #### unfocused_border {#komorebitheme-oneof[2]-unfocused_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused (default: Base01) +Border colour when the container is unfocused +**Default:** [`"Base01"`](#base16value) + #### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused and locked (default: Base08) +Border colour when the container is unfocused and locked +**Default:** [`"Base08"`](#base16value) +
@@ -2381,7 +2388,6 @@ Border colour when the container is unfocused and locked (default: Base08) Options related to the Grid layout - #### scrolling {#layoutoptions-scrolling} [`ScrollingLayoutOptions`](#scrollinglayoutoptions) @@ -2390,7 +2396,6 @@ Options related to the Scrolling layout -
#### Usages @@ -2421,12 +2426,10 @@ Options related to the Scrolling layout [`IdWithIdentifier`](#idwithidentifier) - --- `array` [`IdWithIdentifier`](#idwithidentifier) -
#### Usages @@ -2530,17 +2533,18 @@ Container padding (default: global) - - **Format:** `int32` #### floating_layer_behaviour {#monitorconfig-floating_layer_behaviour} [`FloatingLayerBehaviour`](#floatinglayerbehaviour) -Determine what happens to a new window when the Floating workspace layer is active (default: Tile) +Determine what happens to a new window when the Floating workspace layer is active +**Default:** [`"Tile"`](#floatinglayerbehaviour) + #### wallpaper {#monitorconfig-wallpaper} [`Wallpaper`](#wallpaper) @@ -2548,32 +2552,31 @@ Determine what happens to a new window when the Floating workspace layer is acti Specify a wallpaper for this monitor - #### window_based_work_area_offset {#monitorconfig-window_based_work_area_offset} [`Rect`](#rect) -Window based work area offset (default: None) - +Window based work area offset #### window_based_work_area_offset_limit {#monitorconfig-window_based_work_area_offset_limit} `integer` -Open window limit after which the window based work area offset will no longer be applied (default: 1) - +Open window limit after which the window based work area offset will no longer be applied - **Format:** `int` + +**Default:** `1` + #### work_area_offset {#monitorconfig-work_area_offset} [`Rect`](#rect) -Monitor-specific work area offset (default: None) - +Monitor-specific work area offset #### workspace_padding {#monitorconfig-workspace_padding} @@ -2584,7 +2587,6 @@ Workspace padding (default: global) - - **Format:** `int32` #### workspaces {#monitorconfig-workspaces} @@ -2595,7 +2597,6 @@ Workspace configurations -
#### Usages @@ -2620,21 +2621,15 @@ Workspace configurations --- -`string` - Swap the window container with the window container at the edge of the adjacent monitor - - +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 - - +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 - - +Do nothing if trying to move a window container in the direction of an adjacent monitor **Value:** `"NoOp"`
@@ -2661,15 +2656,11 @@ Workspace configurations --- -`string` - Process komorebic commands on temporarily unmanaged/floated windows - - +Process komorebic commands on temporarily unmanaged/floated windows **Value:** `"Op"` --- -`string` - Ignore komorebic commands on temporarily unmanaged/floated windows - - +Ignore komorebic commands on temporarily unmanaged/floated windows **Value:** `"NoOp"`
@@ -2791,21 +2782,15 @@ Workspace configurations --- -`string` - Does not change the size or position of the window - - +Does not change the size or position of the window **Value:** `"None"` --- -`string` - Center the window without changing the size - - +Center the window without changing the size **Value:** `"Center"` --- -`string` - Center the window and resize it according to the AspectRatio - - +Center the window and resize it according to the `AspectRatio` **Value:** `"CenterAndResize"`
@@ -2835,21 +2820,15 @@ Workspace configurations --- -`string` - 21:9 - - +21:9 **Value:** `"Ultrawide"` --- -`string` - 16:9 - - +16:9 **Value:** `"Widescreen"` --- -`string` - 4:3 - - +4:3 **Value:** `"Standard"`
@@ -2885,7 +2864,6 @@ The bottom point in a Win32 Rect - - **Format:** `int32` #### left {#rect-left} @@ -2896,7 +2874,6 @@ The left point in a Win32 Rect - - **Format:** `int32` #### right {#rect-right} @@ -2907,7 +2884,6 @@ The right point in a Win32 Rect - - **Format:** `int32` #### top {#rect-top} @@ -2918,7 +2894,6 @@ The top point in a Win32 Rect - - **Format:** `int32` @@ -2961,7 +2936,6 @@ Blue - - **Format:** `uint32` - **Minimum:** 0 @@ -2973,7 +2947,6 @@ Green - - **Format:** `uint32` - **Minimum:** 0 @@ -2985,7 +2958,6 @@ Red - - **Format:** `uint32` - **Minimum:** 0 @@ -3046,7 +3018,6 @@ Red With an odd number of visible columns, keep the focused window column centered - #### columns {#scrollinglayoutoptions-columns} `integer` @@ -3055,7 +3026,6 @@ Desired number of visible columns (default: 3) - - **Format:** `uint` - **Minimum:** 0 @@ -3093,7 +3063,6 @@ Stackbar height - - **Format:** `int32` #### label {#stackbarconfig-label} @@ -3103,15 +3072,16 @@ Stackbar height Stackbar label - #### mode {#stackbarconfig-mode} [`StackbarMode`](#stackbarmode) -Stackbar mode (default: Never) +Stackbar mode +**Default:** [`"Never"`](#stackbarmode) + #### tabs {#stackbarconfig-tabs} [`TabsConfig`](#tabsconfig) @@ -3120,7 +3090,6 @@ Stackbar tab configuration options -
#### Usages @@ -3207,7 +3176,6 @@ Stackbar tab configuration options Tab background colour - #### focused_text {#tabsconfig-focused_text} [`Colour`](#colour) @@ -3215,7 +3183,6 @@ Tab background colour Focused tab text colour - #### font_family {#tabsconfig-font_family} `string` @@ -3223,7 +3190,6 @@ Focused tab text colour Font family - #### font_size {#tabsconfig-font_size} `integer` @@ -3232,7 +3198,6 @@ Font size - - **Format:** `int32` #### unfocused_text {#tabsconfig-unfocused_text} @@ -3242,7 +3207,6 @@ Font size Unfocused tab text colour - #### width {#tabsconfig-width} `integer` @@ -3251,7 +3215,6 @@ Width of a stackbar tab - - **Format:** `int32` @@ -3284,90 +3247,112 @@ Width of a stackbar tab [`Base16Value`](#base16value) -Komorebi status bar accent (default: Base0D) +Komorebi status bar accent +**Default:** [`"Base0D"`](#base16value) + #### floating_border {#themeoptions-floating_border} [`Base16Value`](#base16value) -Border colour when the window is floating (default: Base09) +Border colour when the window is floating +**Default:** [`"Base09"`](#base16value) + #### monocle_border {#themeoptions-monocle_border} [`Base16Value`](#base16value) -Border colour when the container is in monocle mode (default: Base0F) +Border colour when the container is in monocle mode +**Default:** [`"Base0F"`](#base16value) + #### single_border {#themeoptions-single_border} [`Base16Value`](#base16value) -Border colour when the container contains a single window (default: Base0D) +Border colour when the container contains a single window +**Default:** [`"Base0D"`](#base16value) + #### stack_border {#themeoptions-stack_border} [`Base16Value`](#base16value) -Border colour when the container contains multiple windows (default: Base0B) +Border colour when the container contains multiple windows +**Default:** [`"Base0B"`](#base16value) + #### stackbar_background {#themeoptions-stackbar_background} [`Base16Value`](#base16value) -Stackbar tab background colour (default: Base01) +Stackbar tab background colour +**Default:** [`"Base01"`](#base16value) + #### stackbar_focused_text {#themeoptions-stackbar_focused_text} [`Base16Value`](#base16value) -Stackbar focused tab text colour (default: Base0B) +Stackbar focused tab text colour +**Default:** [`"Base0B"`](#base16value) + #### stackbar_unfocused_text {#themeoptions-stackbar_unfocused_text} [`Base16Value`](#base16value) -Stackbar unfocused tab text colour (default: Base05) +Stackbar unfocused tab text colour +**Default:** [`"Base05"`](#base16value) + #### theme_variant {#themeoptions-theme_variant} [`ThemeVariant`](#themevariant) -Specify Light or Dark variant for theme generation (default: Dark) +Specify Light or Dark variant for theme generation +**Default:** [`"Dark"`](#themevariant) + #### unfocused_border {#themeoptions-unfocused_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused (default: Base01) +Border colour when the container is unfocused +**Default:** [`"Base01"`](#base16value) + #### unfocused_locked_border {#themeoptions-unfocused_locked_border} [`Base16Value`](#base16value) -Border colour when the container is unfocused and locked (default: Base08) +Border colour when the container is unfocused and locked +**Default:** [`"Base08"`](#base16value) +
#### Usages @@ -3428,10 +3413,12 @@ Border colour when the container is unfocused and locked (default: Base08) `boolean` -Generate and apply Base16 theme for this wallpaper (default: true) +Generate and apply Base16 theme for this wallpaper +**Default:** `true` + #### path {#wallpaper-path} [`PathBuf`](#pathbuf) @@ -3439,15 +3426,16 @@ Generate and apply Base16 theme for this wallpaper (default: true) Path to the wallpaper image file - #### theme_options {#wallpaper-theme_options} [`ThemeOptions`](#themeoptions) -Specify Light or Dark variant for theme generation (default: Dark) +Specify Light or Dark variant for theme generation +**Default:** [`"Dark"`](#themeoptions) +
#### Usages @@ -3478,15 +3466,11 @@ Specify Light or Dark variant for theme generation (default: Dark) --- -`string` - Create a new container for each new window - - +Create a new container for each new window **Value:** `"Create"` --- -`string` - Append new windows to the focused window container - - +Append new windows to the focused window container **Value:** `"Append"`
@@ -3545,10 +3529,12 @@ Specify Light or Dark variant for theme generation (default: Dark) `boolean` -Apply this monitor's window-based work area offset (default: true) +Apply this monitor's window-based work area offset +**Default:** `true` + #### container_padding {#workspaceconfig-container_padding} `integer` @@ -3557,23 +3543,20 @@ Container padding (default: global) - - **Format:** `int32` #### custom_layout {#workspaceconfig-custom_layout} [`PathBuf`](#pathbuf) -END OF LIFE FEATURE: Custom Layout (default: None) - +END OF LIFE FEATURE: Custom Layout #### custom_layout_rules {#workspaceconfig-custom_layout_rules} `object` -END OF LIFE FEATURE: Custom layout rules (default: None) - +END OF LIFE FEATURE: Custom layout rules @@ -3587,18 +3570,19 @@ END OF LIFE FEATURE: Custom layout rules (default: None) `boolean` -Enable or disable float override, which makes it so every new window opens in floating mode (default: false) - +Enable or disable float override, which makes it so every new window opens in floating mode #### floating_layer_behaviour {#workspaceconfig-floating_layer_behaviour} [`FloatingLayerBehaviour`](#floatinglayerbehaviour) -Determine what happens to a new window when the Floating workspace layer is active (default: Tile) +Determine what happens to a new window when the Floating workspace layer is active +**Default:** [`"Tile"`](#floatinglayerbehaviour) + #### initial_workspace_rules {#workspaceconfig-initial_workspace_rules} `array` [`MatchingRule`](#matchingrule) @@ -3606,37 +3590,35 @@ Determine what happens to a new window when the Floating workspace layer is acti Initial workspace application rules - #### layout {#workspaceconfig-layout} [`DefaultLayout`](#defaultlayout) -Layout (default: BSP) +Layout +**Default:** [`"BSP"`](#defaultlayout) + #### layout_flip {#workspaceconfig-layout_flip} [`Axis`](#axis) -Specify an axis on which to flip the selected layout (default: None) - +Specify an axis on which to flip the selected layout #### layout_options {#workspaceconfig-layout_options} [`LayoutOptions`](#layoutoptions) -Layout-specific options (default: None) - +Layout-specific options #### layout_rules {#workspaceconfig-layout_rules} `object` -Layout rules in the format of threshold => layout (default: None) - +Layout rules in the format of threshold => layout @@ -3653,15 +3635,16 @@ Layout rules in the format of threshold => layout (default: None) Name - #### tile {#workspaceconfig-tile} `boolean` -Enable or disable tiling for the workspace (default: true) +Enable or disable tiling for the workspace +**Default:** `true` + #### wallpaper {#workspaceconfig-wallpaper} [`Wallpaper`](#wallpaper) @@ -3669,21 +3652,21 @@ Enable or disable tiling for the workspace (default: true) Specify a wallpaper for this workspace - #### window_container_behaviour {#workspaceconfig-window_container_behaviour} [`WindowContainerBehaviour`](#windowcontainerbehaviour) -Determine what happens when a new window is opened (default: Create) +Determine what happens when a new window is opened +**Default:** [`"Create"`](#windowcontainerbehaviour) + #### window_container_behaviour_rules {#workspaceconfig-window_container_behaviour_rules} `object` -Window container behaviour rules in the format of threshold => behaviour (default: None) - +Window container behaviour rules in the format of threshold => behaviour @@ -3697,8 +3680,7 @@ Window container behaviour rules in the format of threshold => behaviour (def [`Rect`](#rect) -Workspace specific work area offset (default: None) - +Workspace specific work area offset #### workspace_padding {#workspaceconfig-workspace_padding} @@ -3709,7 +3691,6 @@ Workspace padding (default: global) - - **Format:** `int32` #### workspace_rules {#workspaceconfig-workspace_rules} @@ -3720,7 +3701,6 @@ Permanent workspace application rules -
#### Usages diff --git a/src/data/cli/windows/animation-style.md b/src/data/cli/windows/animation-style.md index e8d3f56f..7e41ec1c 100644 --- a/src/data/cli/windows/animation-style.md +++ b/src/data/cli/windows/animation-style.md @@ -8,9 +8,8 @@ Options: Desired ease function for animation [default: linear] - [possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart, ease-out-quart, - ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ, ease-in-back, - ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce] + [possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-in-out-cubic, ease-in-quart, ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, + ease-in-out-expo, ease-in-circ, ease-out-circ, ease-in-out-circ, ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce] -a, --animation-type Animation type to apply the style to. If not specified, sets global style diff --git a/src/data/cli/windows/query.md b/src/data/cli/windows/query.md index 80a64711..a8a0b13e 100644 --- a/src/data/cli/windows/query.md +++ b/src/data/cli/windows/query.md @@ -5,8 +5,7 @@ Usage: query Arguments: - [possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index, focused-workspace-name, focused-workspace-layout, focused-container-kind, - version] + [possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index, focused-workspace-name, focused-workspace-layout, focused-container-kind, version] Options: -h, --help diff --git a/src/data/cli/windows/toggle-workspace-float-override.md b/src/data/cli/windows/toggle-workspace-float-override.md index 7028a479..aab69696 100644 --- a/src/data/cli/windows/toggle-workspace-float-override.md +++ b/src/data/cli/windows/toggle-workspace-float-override.md @@ -1,6 +1,5 @@ ``` -Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it -takes the opposite of the global value +Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the global value Usage: toggle-workspace-float-override diff --git a/src/data/cli/windows/toggle-workspace-window-container-behaviour.md b/src/data/cli/windows/toggle-workspace-window-container-behaviour.md index b0bcdc41..8c7fdf08 100644 --- a/src/data/cli/windows/toggle-workspace-window-container-behaviour.md +++ b/src/data/cli/windows/toggle-workspace-window-container-behaviour.md @@ -1,6 +1,5 @@ ``` -Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global -value +Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value Usage: toggle-workspace-window-container-behaviour