feat(docs): regenerate windows references

This commit is contained in:
LGUG2Z committed 2026-02-07 21:00:22 -08:00
1 parent 381e7a4cff
commit 1d6c56ad7c
2 files changed
+69 -195

No files matched your search

+11 -193
View File
@@ -16,15 +16,6 @@ Left side widgets (ordered left-to-right)
---
### monitor {#monitor}
<Badge text="required" variant="success" /> [`MonitorConfigOrIndex`](#monitorconfigorindex)
The monitor index or the full monitor options
---
### right_widgets {#right_widgets}
@@ -98,7 +89,7 @@ Bar height
- **Format:** `float`
**Default:** `50.0`
**Default:** `50`
---
@@ -113,7 +104,7 @@ Scale of the icons relative to the font_size [[1.0-2.0]]
- **Format:** `float`
**Default:** `1.399999976158142`
**Default:** `1.4`
---
@@ -163,6 +154,15 @@ Max label width before text truncation
**Default:** `400.0`
---
### monitor {#monitor}
<Badge text="optional" variant="note" /> [`MonitorConfigOrIndex`](#monitorconfigorindex)
The monitor index or the full monitor options
---
### mouse {#mouse}
@@ -887,11 +887,6 @@ Inherits from the global `Applications` setting if omitted.
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Applications.items[]`](#applicationsconfig-items)
- [`.left_widgets[].Applications.items[]`](#applicationsconfig-items)
- [`.right_widgets[].Applications.items[]`](#applicationsconfig-items)
**Referenced by:**
- [`ApplicationsConfig`](#applicationsconfig)
@@ -1139,11 +1134,6 @@ Horizontal spacing between application buttons.
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Applications`](#widgetconfig-oneof[0]-applications)
- [`.left_widgets[].Applications`](#widgetconfig-oneof[0]-applications)
- [`.right_widgets[].Applications`](#widgetconfig-oneof[0]-applications)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -1212,14 +1202,6 @@ Show both the application icon and name.
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Applications.display`](#applicationsconfig-display)
- [`.center_widgets[].Applications.items[].display`](#appconfig-display)
- [`.left_widgets[].Applications.display`](#applicationsconfig-display)
- [`.left_widgets[].Applications.items[].display`](#appconfig-display)
- [`.right_widgets[].Applications.display`](#applicationsconfig-display)
- [`.right_widgets[].Applications.items[].display`](#appconfig-display)
**Referenced by:**
- [`AppConfig`](#appconfig)
@@ -6052,11 +6034,6 @@ Display label prefix
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Battery`](#widgetconfig-oneof[1]-battery)
- [`.left_widgets[].Battery`](#widgetconfig-oneof[1]-battery)
- [`.right_widgets[].Battery`](#widgetconfig-oneof[1]-battery)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -7085,11 +7062,6 @@ Display label prefix
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu)
- [`.left_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu)
- [`.right_widgets[].Cpu`](#widgetconfig-oneof[2]-cpu)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -7137,11 +7109,6 @@ Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to incremen
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers)
- [`.left_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers)
- [`.right_widgets[].Date.format.CustomModifiers`](#dateformat-oneof[5]-custommodifiers)
**Referenced by:**
- [`DateFormat`](#dateformat)
@@ -7346,11 +7313,6 @@ Use a custom format to display additional information, i.e.:
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Date`](#widgetconfig-oneof[3]-date)
- [`.left_widgets[].Date`](#widgetconfig-oneof[3]-date)
- [`.right_widgets[].Date`](#widgetconfig-oneof[3]-date)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -7466,11 +7428,6 @@ Custom format with modifiers
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Date.format`](#dateconfig-format)
- [`.left_widgets[].Date.format`](#dateconfig-format)
- [`.right_widgets[].Date.format`](#dateconfig-format)
**Referenced by:**
- [`DateConfig`](#dateconfig)
@@ -7707,8 +7664,6 @@ Scrolling Layout
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayout)
- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayout)
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[56]-content)
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[99]-content)
- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[98]-content)
@@ -7754,7 +7709,6 @@ Scrolling Layout
- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[98]-content)
- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[103]-content)
- [`.mouse.on_secondary_click.message.content[3]`](#socketmessage-oneof[102]-content)
- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayout)
**Referenced by:**
@@ -7855,23 +7809,6 @@ Show an icon and text for the selected element, and icons on the rest
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display)
- [`.center_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display)
- [`.center_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display)
- [`.center_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display)
- [`.center_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat)
- [`.left_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display)
- [`.left_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display)
- [`.left_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display)
- [`.left_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display)
- [`.left_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat)
- [`.right_widgets[].Komorebi.focused_container.display`](#komorebifocusedcontainerconfig-display)
- [`.right_widgets[].Komorebi.layout.display`](#komorebilayoutconfig-display)
- [`.right_widgets[].Komorebi.locked_container.display`](#komorebilockedcontainerconfig-display)
- [`.right_widgets[].Komorebi.workspace_layer.display`](#komorebiworkspacelayerconfig-display)
- [`.right_widgets[].Komorebi.workspaces.display`](#workspacesdisplayformat)
**Referenced by:**
- [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig)
@@ -8757,11 +8694,6 @@ Display label prefix
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard)
- [`.left_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard)
- [`.right_widgets[].Keyboard`](#widgetconfig-oneof[4]-keyboard)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -9084,11 +9016,6 @@ Configure the Workspaces widget
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi)
- [`.left_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi)
- [`.right_widgets[].Komorebi`](#widgetconfig-oneof[5]-komorebi)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -9133,11 +9060,6 @@ Enable the Komorebi Configurations widget
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher)
- [`.left_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher)
- [`.right_widgets[].Komorebi.configuration_switcher`](#komorebiconfig-configuration_switcher)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -9182,11 +9104,6 @@ DEPRECATED: use `display` instead (Show the icon of the currently focused contai
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container)
- [`.left_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container)
- [`.right_widgets[].Komorebi.focused_container`](#komorebiconfig-focused_container)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -9290,11 +9207,6 @@ Custom layout
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options)
- [`.left_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options)
- [`.right_widgets[].Komorebi.layout.options[]`](#komorebilayoutconfig-options)
**Referenced by:**
- [`KomorebiLayoutConfig`](#komorebilayoutconfig)
@@ -9339,11 +9251,6 @@ List of layout options
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.layout`](#komorebiconfig-layout)
- [`.left_widgets[].Komorebi.layout`](#komorebiconfig-layout)
- [`.right_widgets[].Komorebi.layout`](#komorebiconfig-layout)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -9388,11 +9295,6 @@ Show the widget event if the layer is unlocked
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container)
- [`.left_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container)
- [`.right_widgets[].Komorebi.locked_container`](#komorebiconfig-locked_container)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -10018,11 +9920,6 @@ Show the widget event if the layer is Tiling
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer)
- [`.left_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer)
- [`.right_widgets[].Komorebi.workspace_layer`](#komorebiconfig-workspace_layer)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -10067,11 +9964,6 @@ Display format of the workspace
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces)
- [`.left_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces)
- [`.right_widgets[].Komorebi.workspaces`](#komorebiconfig-workspaces)
**Referenced by:**
- [`KomorebiConfig`](#komorebiconfig)
@@ -10155,35 +10047,6 @@ Show an icon and text
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix)
- [`.center_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix)
- [`.center_widgets[].Date.label_prefix`](#dateconfig-label_prefix)
- [`.center_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix)
- [`.center_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix)
- [`.center_widgets[].Network.label_prefix`](#networkconfig-label_prefix)
- [`.center_widgets[].Storage.label_prefix`](#storageconfig-label_prefix)
- [`.center_widgets[].Time.label_prefix`](#timeconfig-label_prefix)
- [`.center_widgets[].Update.label_prefix`](#updateconfig-label_prefix)
- [`.left_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix)
- [`.left_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix)
- [`.left_widgets[].Date.label_prefix`](#dateconfig-label_prefix)
- [`.left_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix)
- [`.left_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix)
- [`.left_widgets[].Network.label_prefix`](#networkconfig-label_prefix)
- [`.left_widgets[].Storage.label_prefix`](#storageconfig-label_prefix)
- [`.left_widgets[].Time.label_prefix`](#timeconfig-label_prefix)
- [`.left_widgets[].Update.label_prefix`](#updateconfig-label_prefix)
- [`.right_widgets[].Battery.label_prefix`](#batteryconfig-label_prefix)
- [`.right_widgets[].Cpu.label_prefix`](#cpuconfig-label_prefix)
- [`.right_widgets[].Date.label_prefix`](#dateconfig-label_prefix)
- [`.right_widgets[].Keyboard.label_prefix`](#keyboardconfig-label_prefix)
- [`.right_widgets[].Memory.label_prefix`](#memoryconfig-label_prefix)
- [`.right_widgets[].Network.label_prefix`](#networkconfig-label_prefix)
- [`.right_widgets[].Storage.label_prefix`](#storageconfig-label_prefix)
- [`.right_widgets[].Time.label_prefix`](#timeconfig-label_prefix)
- [`.right_widgets[].Update.label_prefix`](#updateconfig-label_prefix)
**Referenced by:**
- [`BatteryConfig`](#batteryconfig)
@@ -10222,11 +10085,6 @@ Enable the Media widget
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Media`](#widgetconfig-oneof[6]-media)
- [`.left_widgets[].Media`](#widgetconfig-oneof[6]-media)
- [`.right_widgets[].Media`](#widgetconfig-oneof[6]-media)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -10290,11 +10148,6 @@ Display label prefix
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Memory`](#widgetconfig-oneof[7]-memory)
- [`.left_widgets[].Memory`](#widgetconfig-oneof[7]-memory)
- [`.right_widgets[].Memory`](#widgetconfig-oneof[7]-memory)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -10780,11 +10633,6 @@ Show default interface
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Network`](#widgetconfig-oneof[8]-network)
- [`.left_widgets[].Network`](#widgetconfig-oneof[8]-network)
- [`.right_widgets[].Network`](#widgetconfig-oneof[8]-network)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -10852,11 +10700,6 @@ Select the transmitted data when it's over this value
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Network.auto_select`](#networkconfig-auto_select)
- [`.left_widgets[].Network.auto_select`](#networkconfig-auto_select)
- [`.right_widgets[].Network.auto_select`](#networkconfig-auto_select)
**Referenced by:**
- [`NetworkConfig`](#networkconfig)
@@ -17404,11 +17247,6 @@ Show removable disks
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Storage`](#widgetconfig-oneof[9]-storage)
- [`.left_widgets[].Storage`](#widgetconfig-oneof[9]-storage)
- [`.right_widgets[].Storage`](#widgetconfig-oneof[9]-storage)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -17519,11 +17357,6 @@ Use a custom format to display additional information, i.e.:
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Time`](#widgetconfig-oneof[10]-time)
- [`.left_widgets[].Time`](#widgetconfig-oneof[10]-time)
- [`.right_widgets[].Time`](#widgetconfig-oneof[10]-time)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -17653,11 +17486,6 @@ Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Time.format`](#timeconfig-format)
- [`.left_widgets[].Time.format`](#timeconfig-format)
- [`.right_widgets[].Time.format`](#timeconfig-format)
**Referenced by:**
- [`TimeConfig`](#timeconfig)
@@ -17709,11 +17537,6 @@ Display label prefix
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Update`](#widgetconfig-oneof[11]-update)
- [`.left_widgets[].Update`](#widgetconfig-oneof[11]-update)
- [`.right_widgets[].Update`](#widgetconfig-oneof[11]-update)
**Referenced by:**
- [`WidgetConfig`](#widgetconfig)
@@ -18137,11 +17960,6 @@ Show all icons and text for the selected element, and all icons on the rest
</details>
#### Usages
**Configuration:**
- [`.center_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display)
- [`.left_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display)
- [`.right_widgets[].Komorebi.workspaces.display`](#komorebiworkspacesconfig-display)
**Referenced by:**
- [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig)
@@ -1078,7 +1078,6 @@ Custom Cubic Bézier function
**Configuration:**
- [`.animation.style`](#peranimationprefixconfig3)
- [`.animation.style[*]`](#peranimationprefixconfig3)
**Referenced by:**
@@ -7847,10 +7846,40 @@ Options for specific layouts
<details open>
<summary>Properties (2)</summary>
<summary>Properties (4)</summary>
#### column_ratios {#layoutoptions-column_ratios}
<Badge text="optional" variant="note" /> `array` <Badge text="optional" variant="note" /> `number`
Column width ratios (up to MAX_RATIOS values between 0.1 and 0.9)
- Used by Columns layout: ratios for each column width
- Used by Grid layout: ratios for column widths
- Used by BSP, VerticalStack, RightMainVerticalStack: column_ratios[0] as primary split ratio
- Used by HorizontalStack: column_ratios[0] as primary split ratio (top area height)
- Used by UltrawideVerticalStack: column_ratios[0] as center ratio, column_ratios[1] as left ratio
Columns without a ratio share remaining space equally.
Example: `[0.3, 0.4, 0.3]` for 30%-40%-30% columns
- **Min items:** 5
- **Max items:** 5
<details open>
<summary>Array Items</summary>
<Badge text="optional" variant="note" /> `number`
- **Format:** `float`
</details>
#### grid {#layoutoptions-grid}
<Badge text="optional" variant="note" /> [`GridLayoutOptions`](#gridlayoutoptions)
@@ -7858,6 +7887,33 @@ Options for specific layouts
Options related to the Grid layout
#### row_ratios {#layoutoptions-row_ratios}
<Badge text="optional" variant="note" /> `array` <Badge text="optional" variant="note" /> `number`
Row height ratios (up to MAX_RATIOS values between 0.1 and 0.9)
- Used by Rows layout: ratios for each row height
- Used by Grid layout: ratios for row heights
Rows without a ratio share remaining space equally.
Example: `[0.5, 0.5]` for 50%-50% rows
- **Min items:** 5
- **Max items:** 5
<details open>
<summary>Array Items</summary>
<Badge text="optional" variant="note" /> `number`
- **Format:** `float`
</details>
#### scrolling {#layoutoptions-scrolling}
<Badge text="optional" variant="note" /> [`ScrollingLayoutOptions`](#scrollinglayoutoptions)