From 72f53e04ff6d364034f13686d1216907feb0dfc2 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 26 Dec 2025 15:13:26 -0800 Subject: [PATCH] feat(macos): add defaults and md to descriptions --- .gitignore | 2 +- src/content/docs/reference/bar-macos.mdx | 472 ++++++------------ src/content/docs/reference/komorebi-macos.mdx | 425 ++++++++-------- 3 files changed, 355 insertions(+), 544 deletions(-) diff --git a/.gitignore b/.gitignore index 15693d96..a896c413 100644 --- a/.gitignore +++ b/.gitignore @@ -20,4 +20,4 @@ pnpm-debug.log* # macOS-specific files .DS_Store -src/contents/docs/reference/komorebic*.mdx +src/content/docs/reference/komorebic*.mdx diff --git a/src/content/docs/reference/bar-macos.mdx b/src/content/docs/reference/bar-macos.mdx index 2cc726d7..b15ad9f4 100644 --- a/src/content/docs/reference/bar-macos.mdx +++ b/src/content/docs/reference/bar-macos.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} @@ -95,7 +97,6 @@ Left side widgets (ordered left-to-right) - --- ### margin {#margin} @@ -104,25 +105,26 @@ 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": \{ - "horizontal": 10 -\} - +```json +"margin": { + "horizontal": 10.0 +} +``` or: -"margin": \{ +```json +"margin": { "vertical": [top, bottom] -\} - +} +``` You can also set individual margin on each side like this: -"margin": \{ - "top": 10, - "bottom": 10, - "left": 10, - "right": 10, -\} - -By default, margin is set to 0 on all sides. - +```json +"margin": { + "top": 10.0, + "bottom": 10.0, + "left": 10.0, + "right": 10.0 +} +``` @@ -131,14 +133,16 @@ By default, margin is set to 0 on all sides. `number` -Max label width before text truncation (default: 400.0) - +Max label width before text truncation - **Format:** `float` +**Default:** `400.0` + + --- ### monitor {#monitor} @@ -148,7 +152,6 @@ The monitor index or the full monitor options - --- ### padding {#padding} @@ -157,25 +160,26 @@ The monitor index or the full monitor options Bar padding. Use one value for all sides or use a grouped padding for horizontal and/or vertical definition which can each take a single value for a symmetric padding or two values for each side, i.e.: -"padding": \{ - "horizontal": 10 -\} - +```json +"padding": { + "horizontal": 10.0 +} +``` or: -"padding": \{ +```json +"padding": { "horizontal": [left, right] -\} - +} +``` You can also set individual padding on each side like this: -"padding": \{ - "top": 10, - "bottom": 10, - "left": 10, - "right": 10, -\} - -By default, padding is set to 10 on all sides. - +```json +"padding": { + "top": 10.0, + "bottom": 10.0, + "left": 10.0, + "right": 10.0 +} +``` @@ -188,7 +192,6 @@ Bar positioning options - --- ### right_widgets {#right_widgets} @@ -198,7 +201,6 @@ Right side widgets (ordered left-to-right) - --- ### theme {#theme} @@ -208,14 +210,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]] @@ -224,19 +224,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` + + --- @@ -260,7 +265,6 @@ Spacing between widgets (default: 10.0) Command to execute (e.g. path to the application or shell command). - #### display {#appconfig-display} [`ApplicationsDisplayFormat`](#applicationsdisplayformat) @@ -268,14 +272,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} @@ -283,9 +285,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} @@ -295,14 +296,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. @@ -338,8 +337,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} @@ -349,7 +347,6 @@ Could be overridden per application. Defaults to Icon. Enables or disables the applications widget. - #### items {#applicationsconfig-items} `array` [`AppConfig`](#appconfig) @@ -357,14 +354,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} @@ -375,7 +370,6 @@ Horizontal spacing between application buttons. - - **Format:** `float` @@ -408,21 +402,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"` @@ -944,7 +932,6 @@ Select when the current percentage is under this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -953,14 +940,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` @@ -968,7 +957,6 @@ Data refresh interval (default: 10 seconds) Enable the Battery widget - #### hide_on_full_charge {#batteryconfig-hide_on_full_charge} `boolean` @@ -976,7 +964,6 @@ Enable the Battery widget Hide the widget if the battery is at full charge - #### label_prefix {#batteryconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -985,7 +972,6 @@ Display label prefix - #### Usages @@ -1102,14 +1088,10 @@ Display label prefix [`Rgb`](#rgb) - Colour represented as RGB - - --- [`Hex`](#hex) - Colour represented as Hex - - #### Usages @@ -1158,7 +1140,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -1167,14 +1148,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` @@ -1182,7 +1165,6 @@ Data refresh interval (default: 10 seconds) Enable the Cpu widget - #### label_prefix {#cpuconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -1191,7 +1173,6 @@ Display label prefix - #### Usages @@ -1216,7 +1197,6 @@ Display label prefix Custom format with additive modifiers for integer format specifiers -
Properties (2) @@ -1227,21 +1207,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`
@@ -1280,7 +1257,6 @@ Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to incremen Enable the Date widget - #### format {#dateconfig-format} [`DateFormat`](#dateformat) @@ -1288,7 +1264,6 @@ Enable the Date widget Set the Date format - #### label_prefix {#dateconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -1296,22 +1271,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" - \} -\} - - + } +} +``` @@ -1344,33 +1319,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) @@ -1386,8 +1351,6 @@ Use a custom format to display additional information, i.e.: --- `object` - Custom format with modifiers - -
Properties (1) @@ -1467,33 +1430,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"`
@@ -1547,7 +1500,6 @@ Margin inside the painted frame -
#### Usages @@ -1616,7 +1568,6 @@ Margin inside the painted frame `number` - - **Format:** `float` @@ -1624,7 +1575,6 @@ Margin inside the painted frame `array` `[float; 2]` -
#### Usages @@ -1656,8 +1606,6 @@ Margin inside the painted frame --- `object` - No grouping is applied - -
Properties (1) @@ -1675,20 +1623,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 @@ -1718,7 +1660,6 @@ Margin inside the painted frame Rounding values for the 4 corners. Can be a single or 4 values. - #### style {#groupingconfig-style} [`GroupingStyle`](#groupingstyle) @@ -1726,13 +1667,11 @@ Rounding values for the 4 corners. Can be a single or 4 values. Styles for the grouping - #### transparency_alpha {#groupingconfig-transparency_alpha} `integer` -Alpha value for the color transparency [[0-255]] (default: 200) - +Alpha value for the color transparency [[0-255]] @@ -1741,6 +1680,9 @@ Alpha value for the color transparency [[0-255]] (default: 200) - **Maximum:** 255 +**Default:** `200` + + #### Usages @@ -1771,7 +1713,6 @@ Alpha value for the color transparency [[0-255]] (default: 200) --- `string` -
Enum variants (1) @@ -1780,39 +1721,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"` @@ -1952,8 +1881,6 @@ Alpha value for the color transparency [[0-255]] (default: 200) --- `object` - A theme from catppuccin-egui - -
Properties (5) @@ -1985,7 +1912,6 @@ Alpha value for the color transparency [[0-255]] (default: 200) Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin) - #### palette {#komobartheme-oneof[0]-palette} `string` @@ -1998,8 +1924,6 @@ Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catp --- `object` - A theme from base16-egui-themes - -
Properties (5) @@ -2031,7 +1955,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` @@ -2044,8 +1967,6 @@ Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinte --- `object` - A custom Base16 theme - -
Properties (5) @@ -2077,7 +1998,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` @@ -2117,7 +2037,6 @@ Colours of the custom Base16 theme palette Configure the Configuration Switcher widget - #### focused_container {#komorebiconfig-focused_container} [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig) @@ -2125,7 +2044,6 @@ Configure the Configuration Switcher widget Configure the Focused Container widget - #### layout {#komorebiconfig-layout} [`KomorebiLayoutConfig`](#komorebilayoutconfig) @@ -2133,7 +2051,6 @@ Configure the Focused Container widget Configure the Layout widget - #### locked_container {#komorebiconfig-locked_container} [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig) @@ -2141,7 +2058,6 @@ Configure the Layout widget Configure the Locked Container widget - #### workspace_layer {#komorebiconfig-workspace_layer} [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig) @@ -2149,7 +2065,6 @@ Configure the Locked Container widget Configure the Workspace Layer widget - #### workspaces {#komorebiconfig-workspaces} [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig) @@ -2158,7 +2073,6 @@ Configure the Workspaces widget -
#### Usages @@ -2190,15 +2104,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} @@ -2208,7 +2120,6 @@ Enable the Komorebi Configurations widget -
#### Usages @@ -2243,7 +2154,6 @@ Enable the Komorebi Configurations widget Display format of the currently focused container - #### enable {#komorebifocusedcontainerconfig-enable} `boolean` @@ -2251,7 +2161,6 @@ Display format of the currently focused container Enable the Komorebi Focused Container widget - #### show_icon {#komorebifocusedcontainerconfig-show_icon} `boolean` @@ -2260,7 +2169,6 @@ DEPRECATED: use 'display' instead (Show the icon of the currently focused contai -
#### Usages @@ -2293,27 +2201,22 @@ DEPRECATED: use 'display' instead (Show the icon of the currently focused contai [`DefaultLayout`](#defaultlayout) - --- `null` - --- `null` - --- `null` - --- `null` - #### Usages @@ -2348,7 +2251,6 @@ DEPRECATED: use 'display' instead (Show the icon of the currently focused contai Display format of the current layout - #### enable {#komorebilayoutconfig-enable} `boolean` @@ -2356,7 +2258,6 @@ Display format of the current layout Enable the Komorebi Layout widget - #### options {#komorebilayoutconfig-options} `array` [`KomorebiLayout`](#komorebilayout) @@ -2365,7 +2266,6 @@ List of layout options - #### Usages @@ -2400,7 +2300,6 @@ List of layout options Display format of the current locked state - #### enable {#komorebilockedcontainerconfig-enable} `boolean` @@ -2408,7 +2307,6 @@ Display format of the current locked state Enable the Komorebi Locked Container widget - #### show_when_unlocked {#komorebilockedcontainerconfig-show_when_unlocked} `boolean` @@ -2417,7 +2315,6 @@ Show the widget event if the layer is unlocked - #### Usages @@ -2452,7 +2349,6 @@ Show the widget event if the layer is unlocked Display format of the current layer - #### enable {#komorebiworkspacelayerconfig-enable} `boolean` @@ -2460,7 +2356,6 @@ Display format of the current layer Enable the Komorebi Workspace Layer widget - #### show_when_tiling {#komorebiworkspacelayerconfig-show_when_tiling} `boolean` @@ -2469,7 +2364,6 @@ Show the widget event if the layer is Tiling - #### Usages @@ -2504,7 +2398,6 @@ Show the widget event if the layer is Tiling Display format of the workspace - #### enable {#komorebiworkspacesconfig-enable} `boolean` @@ -2512,7 +2405,6 @@ Display format of the workspace Enable the Komorebi Workspaces widget - #### hide_empty_workspaces {#komorebiworkspacesconfig-hide_empty_workspaces} `boolean` @@ -2521,7 +2413,6 @@ Hide workspaces without any windows - #### Usages @@ -2551,27 +2442,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"` @@ -2637,7 +2520,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -2646,14 +2528,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` @@ -2661,7 +2545,6 @@ Data refresh interval (default: 10 seconds) Enable the Memory widget - #### label_prefix {#memoryconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -2670,7 +2553,6 @@ Display label prefix - #### Usages @@ -2706,7 +2588,6 @@ Komorebi monitor index of the monitor on which to render the bar - - **Format:** `uint` - **Minimum:** 0 @@ -2718,7 +2599,6 @@ Automatically apply a work area offset for this monitor to accommodate the bar - #### Usages @@ -2749,8 +2629,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 @@ -2759,8 +2637,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 @@ -2791,7 +2667,6 @@ Characters to reserve for received and transmitted activity - - **Format:** `uint` - **Minimum:** 0 @@ -2802,19 +2677,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` @@ -2822,7 +2698,6 @@ Data refresh interval (default: 10 seconds) Enable the Network widget - #### label_prefix {#networkconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -2830,7 +2705,6 @@ Enable the Network widget Display label prefix - #### show_activity {#networkconfig-show_activity} `boolean` @@ -2838,7 +2712,6 @@ Display label prefix Show received and transmitted activity - #### show_default_interface {#networkconfig-show_default_interface} `boolean` @@ -2846,7 +2719,6 @@ Show received and transmitted activity Show default interface - #### show_total_activity {#networkconfig-show_total_activity} `boolean` @@ -2855,7 +2727,6 @@ Show total received and transmitted activity - #### Usages @@ -2891,7 +2762,6 @@ Select the received data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -2903,7 +2773,6 @@ Select the total received data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -2915,7 +2784,6 @@ Select the total transmitted data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -2927,7 +2795,6 @@ Select the transmitted data when it's over this value - - **Format:** `uint64` - **Minimum:** 0 @@ -2967,7 +2834,6 @@ X coordinate - - **Format:** `float` #### y {#position-y} @@ -2978,7 +2844,6 @@ Y coordinate - - **Format:** `float` @@ -3017,7 +2882,6 @@ Y coordinate The desired size of the bar from the starting position (usually monitor width x desired height) - #### start {#positionconfig-start} [`Position`](#position) @@ -3026,7 +2890,6 @@ The desired starting position of the bar (0,0 = top left of the screen) - #### Usages @@ -3123,7 +2986,6 @@ Blue - - **Format:** `uint32` - **Minimum:** 0 @@ -3135,7 +2997,6 @@ Green - - **Format:** `uint32` - **Minimum:** 0 @@ -3147,7 +3008,6 @@ Red - - **Format:** `uint32` - **Minimum:** 0 @@ -3197,8 +3057,6 @@ Red `number` - All 4 corners are the same - - - **Format:** `float` @@ -3206,8 +3064,6 @@ Red `array` `number` - All 4 corners are custom. Order: NW, NE, SW, SE - - - **Min items:** 4 - **Max items:** 4 @@ -3244,7 +3100,6 @@ Red `number` - - **Format:** `float` @@ -3252,12 +3107,10 @@ Red [`IndividualSpacingConfig`](#individualspacingconfig) - --- [`GroupedSpacingConfig`](#groupedspacingconfig) - #### Usages @@ -3289,7 +3142,6 @@ Hide when the current percentage is under this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -3302,7 +3154,6 @@ Select when the current percentage is over this value [[1-100]] - - **Format:** `uint8` - **Minimum:** 0 - **Maximum:** 255 @@ -3311,14 +3162,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` @@ -3326,7 +3179,6 @@ Data refresh interval (default: 10 seconds) Enable the Storage widget - #### label_prefix {#storageconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -3334,23 +3186,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 @@ -3383,8 +3235,7 @@ Show removable disks. (default: true) `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} @@ -3394,7 +3245,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) @@ -3402,7 +3252,6 @@ Enable the Time widget Set the Time format - #### label_prefix {#timeconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -3410,22 +3259,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" - \} -\} - - + } +} +``` @@ -3458,45 +3307,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) @@ -3541,14 +3376,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` @@ -3556,7 +3393,6 @@ Data refresh interval (default: 12 hours) Enable the Update widget - #### label_prefix {#updateconfig-label_prefix} [`LabelPrefix`](#labelprefix) @@ -3565,7 +3401,6 @@ Display label prefix -
#### Usages @@ -3596,7 +3431,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3612,7 +3446,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3628,7 +3461,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3644,7 +3476,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3660,7 +3491,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3676,7 +3506,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3692,7 +3521,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3708,7 +3536,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3724,7 +3551,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3740,7 +3566,6 @@ Display label prefix --- `object` -
Properties (1) @@ -3780,28 +3605,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-macos.mdx b/src/content/docs/reference/komorebi-macos.mdx index 8d601f26..450fecae 100644 --- a/src/content/docs/reference/komorebi-macos.mdx +++ b/src/content/docs/reference/komorebi-macos.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 @@ -31,10 +29,12 @@ Path to applications.json from komorebi-application-specific-configurations (def `boolean` -Display window borders (default: true) +Display window borders +**Default:** `true` + --- ### border_colours {#border_colours} @@ -45,93 +45,105 @@ Window border colours for different container types (has no effect if a theme is - --- ### border_offset {#border_offset} `integer` -Offset of window borders (default: 5) - +Offset of window borders - **Format:** `int32` +**Default:** `5` + + --- ### border_radius {#border_radius} `integer` -Radius of window borders (default: 10) - +Radius of window borders - **Format:** `int32` +**Default:** `10` + + --- ### border_width {#border_width} `integer` -Width of window borders (default: 6) - +Width of window borders - **Format:** `int32` +**Default:** `6` + + --- ### 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` -Add transparency to unfocused windows (default: false) -Global default workspace padding (default: 10) - +Global default workspace padding - **Format:** `int32` +**Default:** `10` + + --- ### display_index_preferences {#display_index_preferences} @@ -142,7 +154,6 @@ Set display index preferences - **Key:** `""` **→** `string` @@ -155,8 +166,6 @@ Set display index preferences `boolean` Enable or disable float override, which makes it so every new window opens in floating mode -(default: false) - @@ -165,9 +174,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 @@ -176,9 +183,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 @@ -191,28 +197,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} @@ -224,14 +232,12 @@ Aspect ratio to resize with when toggling floating mode for a window - --- ### 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 @@ -244,7 +250,6 @@ Individual window floating rules - --- ### manage_rules {#manage_rules} @@ -254,7 +259,6 @@ Individual window force-manage rules - --- ### monitors {#monitors} @@ -264,30 +268,33 @@ 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` + --- ### resize_delta {#resize_delta} `integer` -Delta to resize windows by (default 50) - +Delta to resize windows by - **Format:** `int32` +**Default:** `50` + + --- ### theme {#theme} @@ -297,36 +304,41 @@ 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) + --- ### 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) + --- @@ -347,7 +359,6 @@ Determine what happens when a new window is opened (default: Create) --- `string` -
Enum variants (31) @@ -387,7 +398,6 @@ Determine what happens when a new window is opened (default: Create) --- `object` -
Properties (1) @@ -431,38 +441,43 @@ Determine what happens when a new window is opened (default: Create) [`PerAnimationPrefixConfig`](#peranimationprefixconfig2) `integer` -Set the animation duration in ms (default: 250) +Set the animation duration in ms +**Default:** [`250`](#peranimationprefixconfig2) + #### 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 +**Default:** [`"Linear"`](#peranimationprefixconfig3) +
#### Usages @@ -491,14 +506,10 @@ Set the animation style (default: Linear) [`PathBuf`](#pathbuf) - A single applications.json file - - --- `array` [`PathBuf`](#pathbuf) - Multiple applications.json files - -
#### Usages @@ -565,14 +576,10 @@ Set the animation style (default: Linear) [`PredefinedAspectRatio`](#predefinedaspectratio) - A predefined aspect ratio - - --- `array` `[integer; 2]` - A custom W:H aspect ratio - -
#### Usages @@ -1134,7 +1141,6 @@ Set the animation style (default: Linear) Border colour when the container is in floating mode - #### monocle {#bordercolours-monocle} [`Colour`](#colour) @@ -1142,7 +1148,6 @@ Border colour when the container is in floating mode Border colour when the container is in monocle mode - #### single {#bordercolours-single} [`Colour`](#colour) @@ -1150,7 +1155,6 @@ Border colour when the container is in monocle mode Border colour when the container contains a single window - #### stack {#bordercolours-stack} [`Colour`](#colour) @@ -1158,7 +1162,6 @@ Border colour when the container contains a single window Border colour when the container contains multiple windows - #### unfocused {#bordercolours-unfocused} [`Colour`](#colour) @@ -1166,7 +1169,6 @@ Border colour when the container contains multiple windows Border colour when the container is unfocused - #### unfocused_locked {#bordercolours-unfocused_locked} [`Colour`](#colour) @@ -1175,7 +1177,6 @@ Border colour when the container is unfocused and locked -
#### Usages @@ -1291,14 +1292,10 @@ Border colour when the container is unfocused and locked [`Rgb`](#rgb) - Colour represented as RGB - - --- [`Hex`](#hex) - Colour represented as Hex - -
#### Usages @@ -1348,15 +1345,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"`
@@ -1419,15 +1412,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"`
@@ -1466,7 +1455,6 @@ Maximum number of rows per grid column - - **Format:** `uint` - **Minimum:** 0 @@ -1601,8 +1589,6 @@ Maximum number of rows per grid column --- `object` - A theme from catppuccin-egui - -
Properties (9) @@ -1610,26 +1596,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) @@ -1637,7 +1629,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` @@ -1649,41 +1640,47 @@ 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) + #### 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 (9) @@ -1691,26 +1688,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) @@ -1718,7 +1721,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` @@ -1730,41 +1732,47 @@ 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) + #### 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 (9) @@ -1772,10 +1780,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) @@ -1783,23 +1793,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` @@ -1811,34 +1824,42 @@ 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) + #### 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) +
@@ -1871,7 +1892,6 @@ Border colour when the container is unfocused and locked (default: Base08) Options related to the Grid layout - #### scrolling {#layoutoptions-scrolling} [`ScrollingLayoutOptions`](#scrollinglayoutoptions) @@ -1880,7 +1900,6 @@ Options related to the Scrolling layout -
#### Usages @@ -1911,12 +1930,10 @@ Options related to the Scrolling layout [`IdWithIdentifier`](#idwithidentifier) - --- `array` [`IdWithIdentifier`](#idwithidentifier) -
#### Usages @@ -1995,8 +2012,7 @@ Options related to the Scrolling layout `integer` -Container padding (default: global) - +Container padding @@ -2006,10 +2022,12 @@ Container padding (default: global) [`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) @@ -2017,26 +2035,26 @@ 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` + #### window_hiding_position {#monitorconfig-window_hiding_position} [`WindowHidingPosition`](#windowhidingposition) @@ -2044,13 +2062,11 @@ Open window limit after which the window based work area offset will no longer b Determine which position windows should be hidden at on this monitor - #### 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} @@ -2061,7 +2077,6 @@ Workspace padding (default: global) - - **Format:** `int32` #### workspaces {#monitorconfig-workspaces} @@ -2072,7 +2087,6 @@ Workspace configurations -
#### Usages @@ -2097,21 +2111,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"`
@@ -2138,15 +2146,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"` @@ -2265,21 +2269,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"` @@ -2309,21 +2307,15 @@ Workspace configurations --- -`string` - 21:9 - - +21:9 **Value:** `"Ultrawide"` --- -`string` - 16:9 - - +16:9 **Value:** `"Widescreen"` --- -`string` - 4:3 - - +4:3 **Value:** `"Standard"` @@ -2429,7 +2421,6 @@ Blue - - **Format:** `uint32` - **Minimum:** 0 @@ -2441,7 +2432,6 @@ Green - - **Format:** `uint32` - **Minimum:** 0 @@ -2453,7 +2443,6 @@ Red - - **Format:** `uint32` - **Minimum:** 0 @@ -2511,7 +2500,6 @@ Red With an odd number of visible columns, keep the focused window column centered - #### columns {#scrollinglayoutoptions-columns} `integer` @@ -2520,7 +2508,6 @@ Desired number of visible columns (default: 3) - - **Format:** `uint` - **Minimum:** 0 @@ -2554,66 +2541,82 @@ Desired number of visible columns (default: 3) [`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) + #### 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 @@ -2674,10 +2677,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) @@ -2685,13 +2690,11 @@ 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 theme options @@ -2724,15 +2727,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"` @@ -2764,15 +2763,11 @@ Specify Light or Dark variant for theme generation (default: Dark) --- -`string` - Hide windows in the bottom left corner of the screen - - +Hide windows in the bottom left corner of the screen **Value:** `"BottomLeft"` --- -`string` - Hide windows in the bottom right corner of the screen - - +Hide windows in the bottom right corner of the screen **Value:** `"BottomRight"` @@ -2804,10 +2799,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` @@ -2816,25 +2813,25 @@ Container padding (default: global) - - **Format:** `int32` #### float_override {#workspaceconfig-float_override} `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) @@ -2842,37 +2839,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 @@ -2889,15 +2884,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) @@ -2905,21 +2901,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 @@ -2933,8 +2929,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} @@ -2945,7 +2940,6 @@ Workspace padding (default: global) - - **Format:** `int32` #### workspace_rules {#workspaceconfig-workspace_rules} @@ -2956,7 +2950,6 @@ Permanent workspace application rules - #### Usages