mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-18 22:58:34 +01:00
11335 lines
258 KiB
Plaintext
11335 lines
258 KiB
Plaintext
---
|
|
title: "komorebi.bar.json (Windows)"
|
|
description: "komorebi-bar for Windows configuration schema reference"
|
|
---
|
|
|
|
import { Badge } from '@astrojs/starlight/components';
|
|
|
|
## Configuration
|
|
|
|
### center_widgets {#center_widgets}
|
|
|
|
<Badge text="optional" variant="note" /> `array` [`WidgetConfig`](#widgetconfig)
|
|
|
|
Center widgets (ordered left-to-right)
|
|
|
|
|
|
|
|
|
|
---
|
|
### font_family {#font_family}
|
|
|
|
<Badge text="optional" variant="note" /> `string`
|
|
|
|
Font family
|
|
|
|
|
|
|
|
|
|
---
|
|
### font_size {#font_size}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Font size (default: 12.5)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
### frame {#frame}
|
|
|
|
<Badge text="optional" variant="note" /> [`FrameConfig`](#frameconfig)
|
|
|
|
Frame options (see: https://docs.rs/egui/latest/egui/containers/frame/struct.Frame.html)
|
|
|
|
|
|
|
|
|
|
---
|
|
### grouping {#grouping}
|
|
|
|
<Badge text="optional" variant="note" /> [`Grouping`](#grouping)
|
|
|
|
Visual grouping for widgets
|
|
|
|
|
|
|
|
|
|
---
|
|
### height {#height}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Bar height (default: 50)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
### icon_scale {#icon_scale}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Scale of the icons relative to the font_size [[1.0-2.0]]. (default: 1.4)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
### left_widgets {#left_widgets}
|
|
|
|
<Badge text="required" variant="success" /> `array` [`WidgetConfig`](#widgetconfig)
|
|
|
|
Left side widgets (ordered left-to-right)
|
|
|
|
|
|
|
|
|
|
---
|
|
### margin {#margin}
|
|
|
|
<Badge text="optional" variant="note" /> [`SpacingKind`](#spacingkind)
|
|
|
|
Bar margin. Use one value for all sides or use a grouped margin for horizontal and/or
|
|
vertical definition which can each take a single value for a symmetric margin or two
|
|
values for each side, i.e.:
|
|
"margin": \{
|
|
"horizontal": 10
|
|
\}
|
|
|
|
or:
|
|
"margin": \{
|
|
"vertical": [top, bottom]
|
|
\}
|
|
|
|
You can also set individual margin on each side like this:
|
|
"margin": \{
|
|
"top": 10,
|
|
"bottom": 10,
|
|
"left": 10,
|
|
"right": 10,
|
|
\}
|
|
|
|
By default, margin is set to 0 on all sides.
|
|
|
|
|
|
|
|
|
|
---
|
|
### max_label_width {#max_label_width}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Max label width before text truncation (default: 400.0)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
### monitor {#monitor}
|
|
|
|
<Badge text="required" variant="success" /> [`MonitorConfigOrIndex`](#monitorconfigorindex)
|
|
|
|
The monitor index or the full monitor options
|
|
|
|
|
|
|
|
|
|
---
|
|
### mouse {#mouse}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseConfig`](#mouseconfig)
|
|
|
|
Options for mouse interaction on the bar
|
|
|
|
|
|
|
|
|
|
---
|
|
### padding {#padding}
|
|
|
|
<Badge text="optional" variant="note" /> [`SpacingKind`](#spacingkind)
|
|
|
|
Bar padding. Use one value for all sides or use a grouped padding for horizontal and/or
|
|
vertical definition which can each take a single value for a symmetric padding or two
|
|
values for each side, i.e.:
|
|
"padding": \{
|
|
"horizontal": 10
|
|
\}
|
|
|
|
or:
|
|
"padding": \{
|
|
"horizontal": [left, right]
|
|
\}
|
|
|
|
You can also set individual padding on each side like this:
|
|
"padding": \{
|
|
"top": 10,
|
|
"bottom": 10,
|
|
"left": 10,
|
|
"right": 10,
|
|
\}
|
|
|
|
By default, padding is set to 10 on all sides.
|
|
|
|
|
|
|
|
|
|
---
|
|
### position {#position}
|
|
|
|
<Badge text="optional" variant="note" /> [`PositionConfig`](#positionconfig)
|
|
|
|
Bar positioning options
|
|
|
|
|
|
|
|
|
|
---
|
|
### right_widgets {#right_widgets}
|
|
|
|
<Badge text="required" variant="success" /> `array` [`WidgetConfig`](#widgetconfig)
|
|
|
|
Right side widgets (ordered left-to-right)
|
|
|
|
|
|
|
|
|
|
---
|
|
### theme {#theme}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomobarTheme`](#komobartheme)
|
|
|
|
Theme
|
|
|
|
|
|
|
|
|
|
---
|
|
### transparency_alpha {#transparency_alpha}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Alpha value for the color transparency [[0-255]] (default: 200)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
|
|
---
|
|
### widget_spacing {#widget_spacing}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Spacing between widgets (default: 10.0)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## Type Definitions
|
|
|
|
### AnimationPrefix {#animationprefix}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
- `"movement"`
|
|
- `"transparency"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[116]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[117]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[119]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### AnimationStyle {#animationstyle}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`string`
|
|
|
|
<details>
|
|
<summary>Enum variants (30)</summary>
|
|
|
|
- `"Linear"`
|
|
- `"EaseInSine"`
|
|
- `"EaseOutSine"`
|
|
- `"EaseInOutSine"`
|
|
- `"EaseInQuad"`
|
|
- `"EaseOutQuad"`
|
|
- `"EaseInOutQuad"`
|
|
- `"EaseInCubic"`
|
|
- `"EaseInOutCubic"`
|
|
- `"EaseInQuart"`
|
|
- `"EaseOutQuart"`
|
|
- `"EaseInOutQuart"`
|
|
- `"EaseInQuint"`
|
|
- `"EaseOutQuint"`
|
|
- `"EaseInOutQuint"`
|
|
- `"EaseInExpo"`
|
|
- `"EaseOutExpo"`
|
|
- `"EaseInOutExpo"`
|
|
- `"EaseInCirc"`
|
|
- `"EaseOutCirc"`
|
|
- `"EaseInOutCirc"`
|
|
- `"EaseInBack"`
|
|
- `"EaseOutBack"`
|
|
- `"EaseInOutBack"`
|
|
- `"EaseInElastic"`
|
|
- `"EaseOutElastic"`
|
|
- `"EaseInOutElastic"`
|
|
- `"EaseInBounce"`
|
|
- `"EaseOutBounce"`
|
|
- `"EaseInOutBounce"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### CubicBezier {#animationstyle-oneof[1]-cubicbezier}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[float; 4]`
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[119]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### AppConfig {#appconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (6)</summary>
|
|
|
|
#### command {#appconfig-command}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
Command to execute (e.g. path to the application or shell command).
|
|
|
|
|
|
|
|
#### display {#appconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`ApplicationsDisplayFormat`](#applicationsdisplayformat)
|
|
|
|
Display format for this application button (optional). Overrides global format if set.
|
|
|
|
|
|
|
|
#### enable {#appconfig-enable}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Whether to enable this application button (optional).
|
|
Inherits from the global Applications setting if omitted.
|
|
|
|
|
|
|
|
#### icon {#appconfig-icon}
|
|
|
|
<Badge text="optional" variant="note" /> `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.
|
|
|
|
|
|
|
|
#### name {#appconfig-name}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
Display name of the application.
|
|
|
|
|
|
|
|
#### show_command_on_hover {#appconfig-show_command_on_hover}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Whether to show the launch command on hover (optional).
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### ApplicationIdentifier {#applicationidentifier}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
- `"Exe"`
|
|
- `"Class"`
|
|
- `"Title"`
|
|
- `"Path"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[144]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[145]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[146]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[147]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[155]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[156]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[157]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[158]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[159]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[160]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[170]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### ApplicationsConfig {#applicationsconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### display {#applicationsconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`ApplicationsDisplayFormat`](#applicationsdisplayformat)
|
|
|
|
Default display format for all applications (optional).
|
|
Could be overridden per application. Defaults to Icon.
|
|
|
|
|
|
|
|
#### enable {#applicationsconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enables or disables the applications widget.
|
|
|
|
|
|
|
|
#### items {#applicationsconfig-items}
|
|
|
|
<Badge text="required" variant="success" /> `array` [`AppConfig`](#appconfig)
|
|
|
|
List of configured applications to display.
|
|
|
|
|
|
|
|
#### show_command_on_hover {#applicationsconfig-show_command_on_hover}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Whether to show the launch command on hover (optional).
|
|
Could be overridden per application. Defaults to false if not set.
|
|
|
|
|
|
|
|
#### spacing {#applicationsconfig-spacing}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Horizontal spacing between application buttons.
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### ApplicationsDisplayFormat {#applicationsdisplayformat}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`string` - Show only the application icon.
|
|
|
|
|
|
**Value:** `"Icon"`
|
|
|
|
---
|
|
`string` - Show only the application name as text.
|
|
|
|
|
|
**Value:** `"Text"`
|
|
|
|
---
|
|
`string` - Show both the application icon and name.
|
|
|
|
|
|
**Value:** `"IconAndText"`
|
|
|
|
</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)
|
|
- [`ApplicationsConfig`](#applicationsconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Axis {#axis}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
- `"Horizontal"`
|
|
- `"Vertical"`
|
|
- `"HorizontalAndVertical"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[60]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[14]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Base16 {#base16}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (269)</summary>
|
|
|
|
- `"3024"`
|
|
- `"Apathy"`
|
|
- `"Apprentice"`
|
|
- `"Ashes"`
|
|
- `"AtelierCaveLight"`
|
|
- `"AtelierCave"`
|
|
- `"AtelierDuneLight"`
|
|
- `"AtelierDune"`
|
|
- `"AtelierEstuaryLight"`
|
|
- `"AtelierEstuary"`
|
|
- `"AtelierForestLight"`
|
|
- `"AtelierForest"`
|
|
- `"AtelierHeathLight"`
|
|
- `"AtelierHeath"`
|
|
- `"AtelierLakesideLight"`
|
|
- `"AtelierLakeside"`
|
|
- `"AtelierPlateauLight"`
|
|
- `"AtelierPlateau"`
|
|
- `"AtelierSavannaLight"`
|
|
- `"AtelierSavanna"`
|
|
- `"AtelierSeasideLight"`
|
|
- `"AtelierSeaside"`
|
|
- `"AtelierSulphurpoolLight"`
|
|
- `"AtelierSulphurpool"`
|
|
- `"Atlas"`
|
|
- `"AyuDark"`
|
|
- `"AyuLight"`
|
|
- `"AyuMirage"`
|
|
- `"Aztec"`
|
|
- `"Bespin"`
|
|
- `"BlackMetalBathory"`
|
|
- `"BlackMetalBurzum"`
|
|
- `"BlackMetalDarkFuneral"`
|
|
- `"BlackMetalGorgoroth"`
|
|
- `"BlackMetalImmortal"`
|
|
- `"BlackMetalKhold"`
|
|
- `"BlackMetalMarduk"`
|
|
- `"BlackMetalMayhem"`
|
|
- `"BlackMetalNile"`
|
|
- `"BlackMetalVenom"`
|
|
- `"BlackMetal"`
|
|
- `"Blueforest"`
|
|
- `"Blueish"`
|
|
- `"Brewer"`
|
|
- `"Bright"`
|
|
- `"Brogrammer"`
|
|
- `"BrushtreesDark"`
|
|
- `"Brushtrees"`
|
|
- `"Caroline"`
|
|
- `"CatppuccinFrappe"`
|
|
- `"CatppuccinLatte"`
|
|
- `"CatppuccinMacchiato"`
|
|
- `"CatppuccinMocha"`
|
|
- `"Chalk"`
|
|
- `"Circus"`
|
|
- `"ClassicDark"`
|
|
- `"ClassicLight"`
|
|
- `"Codeschool"`
|
|
- `"Colors"`
|
|
- `"Cupcake"`
|
|
- `"Cupertino"`
|
|
- `"DaOneBlack"`
|
|
- `"DaOneGray"`
|
|
- `"DaOneOcean"`
|
|
- `"DaOnePaper"`
|
|
- `"DaOneSea"`
|
|
- `"DaOneWhite"`
|
|
- `"DanqingLight"`
|
|
- `"Danqing"`
|
|
- `"Darcula"`
|
|
- `"Darkmoss"`
|
|
- `"Darktooth"`
|
|
- `"Darkviolet"`
|
|
- `"Decaf"`
|
|
- `"DefaultDark"`
|
|
- `"DefaultLight"`
|
|
- `"Dirtysea"`
|
|
- `"Dracula"`
|
|
- `"EdgeDark"`
|
|
- `"EdgeLight"`
|
|
- `"Eighties"`
|
|
- `"EmbersLight"`
|
|
- `"Embers"`
|
|
- `"Emil"`
|
|
- `"EquilibriumDark"`
|
|
- `"EquilibriumGrayDark"`
|
|
- `"EquilibriumGrayLight"`
|
|
- `"EquilibriumLight"`
|
|
- `"Eris"`
|
|
- `"Espresso"`
|
|
- `"EvaDim"`
|
|
- `"Eva"`
|
|
- `"EvenokDark"`
|
|
- `"EverforestDarkHard"`
|
|
- `"Everforest"`
|
|
- `"Flat"`
|
|
- `"Framer"`
|
|
- `"FruitSoda"`
|
|
- `"Gigavolt"`
|
|
- `"Github"`
|
|
- `"GoogleDark"`
|
|
- `"GoogleLight"`
|
|
- `"Gotham"`
|
|
- `"GrayscaleDark"`
|
|
- `"GrayscaleLight"`
|
|
- `"Greenscreen"`
|
|
- `"Gruber"`
|
|
- `"GruvboxDarkHard"`
|
|
- `"GruvboxDarkMedium"`
|
|
- `"GruvboxDarkPale"`
|
|
- `"GruvboxDarkSoft"`
|
|
- `"GruvboxLightHard"`
|
|
- `"GruvboxLightMedium"`
|
|
- `"GruvboxLightSoft"`
|
|
- `"GruvboxMaterialDarkHard"`
|
|
- `"GruvboxMaterialDarkMedium"`
|
|
- `"GruvboxMaterialDarkSoft"`
|
|
- `"GruvboxMaterialLightHard"`
|
|
- `"GruvboxMaterialLightMedium"`
|
|
- `"GruvboxMaterialLightSoft"`
|
|
- `"Hardcore"`
|
|
- `"Harmonic16Dark"`
|
|
- `"Harmonic16Light"`
|
|
- `"HeetchLight"`
|
|
- `"Heetch"`
|
|
- `"Helios"`
|
|
- `"Hopscotch"`
|
|
- `"HorizonDark"`
|
|
- `"HorizonLight"`
|
|
- `"HorizonTerminalDark"`
|
|
- `"HorizonTerminalLight"`
|
|
- `"HumanoidDark"`
|
|
- `"HumanoidLight"`
|
|
- `"IaDark"`
|
|
- `"IaLight"`
|
|
- `"Icy"`
|
|
- `"Irblack"`
|
|
- `"Isotope"`
|
|
- `"Jabuti"`
|
|
- `"Kanagawa"`
|
|
- `"Katy"`
|
|
- `"Kimber"`
|
|
- `"Lime"`
|
|
- `"Macintosh"`
|
|
- `"Marrakesh"`
|
|
- `"Materia"`
|
|
- `"MaterialDarker"`
|
|
- `"MaterialLighter"`
|
|
- `"MaterialPalenight"`
|
|
- `"MaterialVivid"`
|
|
- `"Material"`
|
|
- `"MeasuredDark"`
|
|
- `"MeasuredLight"`
|
|
- `"MellowPurple"`
|
|
- `"MexicoLight"`
|
|
- `"Mocha"`
|
|
- `"Monokai"`
|
|
- `"Moonlight"`
|
|
- `"Mountain"`
|
|
- `"Nebula"`
|
|
- `"NordLight"`
|
|
- `"Nord"`
|
|
- `"Nova"`
|
|
- `"Ocean"`
|
|
- `"Oceanicnext"`
|
|
- `"OneLight"`
|
|
- `"OnedarkDark"`
|
|
- `"Onedark"`
|
|
- `"OutrunDark"`
|
|
- `"OxocarbonDark"`
|
|
- `"OxocarbonLight"`
|
|
- `"Pandora"`
|
|
- `"PapercolorDark"`
|
|
- `"PapercolorLight"`
|
|
- `"Paraiso"`
|
|
- `"Pasque"`
|
|
- `"Phd"`
|
|
- `"Pico"`
|
|
- `"Pinky"`
|
|
- `"Pop"`
|
|
- `"Porple"`
|
|
- `"PreciousDarkEleven"`
|
|
- `"PreciousDarkFifteen"`
|
|
- `"PreciousLightWarm"`
|
|
- `"PreciousLightWhite"`
|
|
- `"PrimerDarkDimmed"`
|
|
- `"PrimerDark"`
|
|
- `"PrimerLight"`
|
|
- `"Purpledream"`
|
|
- `"Qualia"`
|
|
- `"Railscasts"`
|
|
- `"Rebecca"`
|
|
- `"RosePineDawn"`
|
|
- `"RosePineMoon"`
|
|
- `"RosePine"`
|
|
- `"Saga"`
|
|
- `"Sagelight"`
|
|
- `"Sakura"`
|
|
- `"Sandcastle"`
|
|
- `"SelenizedBlack"`
|
|
- `"SelenizedDark"`
|
|
- `"SelenizedLight"`
|
|
- `"SelenizedWhite"`
|
|
- `"Seti"`
|
|
- `"ShadesOfPurple"`
|
|
- `"ShadesmearDark"`
|
|
- `"ShadesmearLight"`
|
|
- `"Shapeshifter"`
|
|
- `"SilkDark"`
|
|
- `"SilkLight"`
|
|
- `"Snazzy"`
|
|
- `"SolarflareLight"`
|
|
- `"Solarflare"`
|
|
- `"SolarizedDark"`
|
|
- `"SolarizedLight"`
|
|
- `"Spaceduck"`
|
|
- `"Spacemacs"`
|
|
- `"Sparky"`
|
|
- `"StandardizedDark"`
|
|
- `"StandardizedLight"`
|
|
- `"Stella"`
|
|
- `"StillAlive"`
|
|
- `"Summercamp"`
|
|
- `"SummerfruitDark"`
|
|
- `"SummerfruitLight"`
|
|
- `"SynthMidnightDark"`
|
|
- `"SynthMidnightLight"`
|
|
- `"Tango"`
|
|
- `"Tarot"`
|
|
- `"Tender"`
|
|
- `"TerracottaDark"`
|
|
- `"Terracotta"`
|
|
- `"TokyoCityDark"`
|
|
- `"TokyoCityLight"`
|
|
- `"TokyoCityTerminalDark"`
|
|
- `"TokyoCityTerminalLight"`
|
|
- `"TokyoNightDark"`
|
|
- `"TokyoNightLight"`
|
|
- `"TokyoNightMoon"`
|
|
- `"TokyoNightStorm"`
|
|
- `"TokyoNightTerminalDark"`
|
|
- `"TokyoNightTerminalLight"`
|
|
- `"TokyoNightTerminalStorm"`
|
|
- `"TokyodarkTerminal"`
|
|
- `"Tokyodark"`
|
|
- `"TomorrowNightEighties"`
|
|
- `"TomorrowNight"`
|
|
- `"Tomorrow"`
|
|
- `"Tube"`
|
|
- `"Twilight"`
|
|
- `"UnikittyDark"`
|
|
- `"UnikittyLight"`
|
|
- `"UnikittyReversible"`
|
|
- `"Uwunicorn"`
|
|
- `"Vesper"`
|
|
- `"Vice"`
|
|
- `"Vulcan"`
|
|
- `"Windows10Light"`
|
|
- `"Windows10"`
|
|
- `"Windows95Light"`
|
|
- `"Windows95"`
|
|
- `"WindowsHighcontrastLight"`
|
|
- `"WindowsHighcontrast"`
|
|
- `"WindowsNtLight"`
|
|
- `"WindowsNt"`
|
|
- `"Woodland"`
|
|
- `"XcodeDusk"`
|
|
- `"Zenbones"`
|
|
- `"Zenburn"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_extra2_click.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_middle_click.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_primary_double_click.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_scroll_down.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_scroll_left.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_scroll_right.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_scroll_up.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.mouse.on_secondary_click.message.content.name`](#komorebitheme-oneof[1]-name)
|
|
- [`.theme.name`](#komobartheme-oneof[1]-name)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomobarTheme`](#komobartheme)
|
|
- [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Base16ColourPalette {#base16colourpalette}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (16)</summary>
|
|
|
|
#### base_00 {#base16colourpalette-base_00}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_01 {#base16colourpalette-base_01}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_02 {#base16colourpalette-base_02}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_03 {#base16colourpalette-base_03}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_04 {#base16colourpalette-base_04}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_05 {#base16colourpalette-base_05}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_06 {#base16colourpalette-base_06}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_07 {#base16colourpalette-base_07}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_08 {#base16colourpalette-base_08}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_09 {#base16colourpalette-base_09}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0a {#base16colourpalette-base_0a}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0b {#base16colourpalette-base_0b}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0c {#base16colourpalette-base_0c}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0d {#base16colourpalette-base_0d}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0e {#base16colourpalette-base_0e}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
#### base_0f {#base16colourpalette-base_0f}
|
|
|
|
<Badge text="required" variant="success" /> [`Colour`](#colour)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_extra2_click.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_middle_click.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_primary_double_click.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_scroll_down.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_scroll_left.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_scroll_right.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_scroll_up.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.mouse.on_secondary_click.message.content.colours`](#komorebitheme-oneof[2]-colours)
|
|
- [`.theme.colours`](#komobartheme-oneof[2]-colours)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomobarTheme`](#komobartheme)
|
|
- [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Base16Value {#base16value}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (16)</summary>
|
|
|
|
- `"Base00"`
|
|
- `"Base01"`
|
|
- `"Base02"`
|
|
- `"Base03"`
|
|
- `"Base04"`
|
|
- `"Base05"`
|
|
- `"Base06"`
|
|
- `"Base07"`
|
|
- `"Base08"`
|
|
- `"Base09"`
|
|
- `"Base0A"`
|
|
- `"Base0B"`
|
|
- `"Base0C"`
|
|
- `"Base0D"`
|
|
- `"Base0E"`
|
|
- `"Base0F"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[1]-bar_accent)
|
|
- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[2]-bar_accent)
|
|
- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[1]-floating_border)
|
|
- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[2]-floating_border)
|
|
- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[1]-monocle_border)
|
|
- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[2]-monocle_border)
|
|
- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[1]-single_border)
|
|
- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[2]-single_border)
|
|
- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[1]-stack_border)
|
|
- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[2]-stack_border)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[1]-stackbar_background)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[2]-stackbar_background)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[1]-stackbar_focused_text)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[2]-stackbar_focused_text)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[1]-stackbar_unfocused_text)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[2]-stackbar_unfocused_text)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[1]-unfocused_border)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[2]-unfocused_border)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[1]-unfocused_locked_border)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[2]-unfocused_locked_border)
|
|
- [`.theme.accent`](#komobartheme-oneof[1]-accent)
|
|
- [`.theme.accent`](#komobartheme-oneof[2]-accent)
|
|
- [`.theme.auto_select_fill`](#komobartheme-oneof[1]-auto_select_fill)
|
|
- [`.theme.auto_select_fill`](#komobartheme-oneof[2]-auto_select_fill)
|
|
- [`.theme.auto_select_text`](#komobartheme-oneof[1]-auto_select_text)
|
|
- [`.theme.auto_select_text`](#komobartheme-oneof[2]-auto_select_text)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomobarTheme`](#komobartheme)
|
|
- [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### BatteryConfig {#batteryconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### auto_select_under {#batteryconfig-auto_select_under}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select when the current percentage is under this value [[1-100]]
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### data_refresh_interval {#batteryconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 10 seconds)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#batteryconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Battery widget
|
|
|
|
|
|
|
|
#### hide_on_full_charge {#batteryconfig-hide_on_full_charge}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Hide the widget if the battery is at full charge
|
|
|
|
|
|
|
|
#### label_prefix {#batteryconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### BorderImplementation {#borderimplementation}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`string` - Use the adjustable komorebi border implementation
|
|
|
|
|
|
**Value:** `"Komorebi"`
|
|
|
|
---
|
|
`string` - Use the thin Windows accent border implementation
|
|
|
|
|
|
**Value:** `"Windows"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[125]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[125]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### BorderStyle {#borderstyle}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`string` - Use the system border style
|
|
|
|
|
|
**Value:** `"System"`
|
|
|
|
---
|
|
`string` - Use the Windows 11-style rounded borders
|
|
|
|
|
|
**Value:** `"Rounded"`
|
|
|
|
---
|
|
`string` - Use the Windows 10-style square borders
|
|
|
|
|
|
**Value:** `"Square"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[122]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[122]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Catppuccin {#catppuccin}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
- `"Frappe"`
|
|
- `"Latte"`
|
|
- `"Macchiato"`
|
|
- `"Mocha"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_extra2_click.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_middle_click.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_primary_double_click.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_scroll_down.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_scroll_left.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_scroll_right.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_scroll_up.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.mouse.on_secondary_click.message.content.name`](#komorebitheme-oneof[0]-name)
|
|
- [`.theme.name`](#komobartheme-oneof[0]-name)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomobarTheme`](#komobartheme)
|
|
- [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### CatppuccinValue {#catppuccinvalue}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (26)</summary>
|
|
|
|
- `"Rosewater"`
|
|
- `"Flamingo"`
|
|
- `"Pink"`
|
|
- `"Mauve"`
|
|
- `"Red"`
|
|
- `"Maroon"`
|
|
- `"Peach"`
|
|
- `"Yellow"`
|
|
- `"Green"`
|
|
- `"Teal"`
|
|
- `"Sky"`
|
|
- `"Sapphire"`
|
|
- `"Blue"`
|
|
- `"Lavender"`
|
|
- `"Text"`
|
|
- `"Subtext1"`
|
|
- `"Subtext0"`
|
|
- `"Overlay2"`
|
|
- `"Overlay1"`
|
|
- `"Overlay0"`
|
|
- `"Surface2"`
|
|
- `"Surface1"`
|
|
- `"Surface0"`
|
|
- `"Base"`
|
|
- `"Mantle"`
|
|
- `"Crust"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_extra1_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_extra1_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_extra1_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_extra1_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_extra1_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_extra1_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_extra2_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_extra2_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_extra2_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_extra2_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_extra2_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_extra2_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_extra2_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_middle_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_middle_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_middle_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_middle_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_middle_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_middle_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_middle_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_primary_double_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_primary_double_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_primary_double_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_primary_double_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_primary_double_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_primary_double_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_down.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_scroll_down.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_scroll_down.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_scroll_down.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_scroll_down.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_down.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_scroll_down.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_left.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_scroll_left.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_scroll_left.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_scroll_left.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_scroll_left.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_left.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_scroll_left.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_right.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_scroll_right.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_scroll_right.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_scroll_right.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_scroll_right.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_right.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_scroll_right.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_scroll_up.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_scroll_up.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_scroll_up.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_scroll_up.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_scroll_up.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_scroll_up.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_scroll_up.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.mouse.on_secondary_click.message.content.bar_accent`](#komorebitheme-oneof[0]-bar_accent)
|
|
- [`.mouse.on_secondary_click.message.content.floating_border`](#komorebitheme-oneof[0]-floating_border)
|
|
- [`.mouse.on_secondary_click.message.content.monocle_border`](#komorebitheme-oneof[0]-monocle_border)
|
|
- [`.mouse.on_secondary_click.message.content.single_border`](#komorebitheme-oneof[0]-single_border)
|
|
- [`.mouse.on_secondary_click.message.content.stack_border`](#komorebitheme-oneof[0]-stack_border)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_background`](#komorebitheme-oneof[0]-stackbar_background)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_focused_text`](#komorebitheme-oneof[0]-stackbar_focused_text)
|
|
- [`.mouse.on_secondary_click.message.content.stackbar_unfocused_text`](#komorebitheme-oneof[0]-stackbar_unfocused_text)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_border`](#komorebitheme-oneof[0]-unfocused_border)
|
|
- [`.mouse.on_secondary_click.message.content.unfocused_locked_border`](#komorebitheme-oneof[0]-unfocused_locked_border)
|
|
- [`.theme.accent`](#komobartheme-oneof[0]-accent)
|
|
- [`.theme.auto_select_fill`](#komobartheme-oneof[0]-auto_select_fill)
|
|
- [`.theme.auto_select_text`](#komobartheme-oneof[0]-auto_select_text)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomobarTheme`](#komobartheme)
|
|
- [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Colour {#colour}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
[`Rgb`](#rgb) - Colour represented as RGB
|
|
|
|
|
|
|
|
|
|
---
|
|
[`Hex`](#hex) - Colour represented as Hex
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#base16colourpalette-base_0f)
|
|
- [`.theme.colours.base_00`](#base16colourpalette-base_00)
|
|
- [`.theme.colours.base_01`](#base16colourpalette-base_01)
|
|
- [`.theme.colours.base_02`](#base16colourpalette-base_02)
|
|
- [`.theme.colours.base_03`](#base16colourpalette-base_03)
|
|
- [`.theme.colours.base_04`](#base16colourpalette-base_04)
|
|
- [`.theme.colours.base_05`](#base16colourpalette-base_05)
|
|
- [`.theme.colours.base_06`](#base16colourpalette-base_06)
|
|
- [`.theme.colours.base_07`](#base16colourpalette-base_07)
|
|
- [`.theme.colours.base_08`](#base16colourpalette-base_08)
|
|
- [`.theme.colours.base_09`](#base16colourpalette-base_09)
|
|
- [`.theme.colours.base_0a`](#base16colourpalette-base_0a)
|
|
- [`.theme.colours.base_0b`](#base16colourpalette-base_0b)
|
|
- [`.theme.colours.base_0c`](#base16colourpalette-base_0c)
|
|
- [`.theme.colours.base_0d`](#base16colourpalette-base_0d)
|
|
- [`.theme.colours.base_0e`](#base16colourpalette-base_0e)
|
|
- [`.theme.colours.base_0f`](#base16colourpalette-base_0f)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`Base16ColourPalette`](#base16colourpalette)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### CpuConfig {#cpuconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### auto_select_over {#cpuconfig-auto_select_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select when the current percentage is over this value [[1-100]]
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### data_refresh_interval {#cpuconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 10 seconds)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#cpuconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Cpu widget
|
|
|
|
|
|
|
|
#### label_prefix {#cpuconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### CustomModifiers {#custommodifiers}
|
|
|
|
`object`
|
|
|
|
Custom format with additive modifiers for integer format specifiers
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### format {#custommodifiers-format}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)
|
|
|
|
|
|
|
|
#### modifiers {#custommodifiers-modifiers}
|
|
|
|
<Badge text="required" variant="success" /> `object`
|
|
|
|
Additive modifiers for integer format specifiers (e.g. \{ "%U": 1 \} to increment the zero-indexed week number by 1)
|
|
|
|
|
|
<details>
|
|
<summary>Additional Properties</summary>
|
|
|
|
`integer`
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
</details>
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### CycleDirection {#cycledirection}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
- `"Previous"`
|
|
- `"Next"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[80]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[4]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[5]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[8]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[9]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[18]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[21]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[23]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[25]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[29]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[57]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[78]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[79]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[80]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### DateConfig {#dateconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### enable {#dateconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Date widget
|
|
|
|
|
|
|
|
#### format {#dateconfig-format}
|
|
|
|
<Badge text="required" variant="success" /> [`DateFormat`](#dateformat)
|
|
|
|
Set the Date format
|
|
|
|
|
|
|
|
#### label_prefix {#dateconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
Display label prefix
|
|
|
|
|
|
|
|
#### timezone {#dateconfig-timezone}
|
|
|
|
<Badge text="optional" variant="note" /> `string`
|
|
|
|
TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html)
|
|
Use a custom format to display additional information, i.e.:
|
|
\{
|
|
"Date": \{
|
|
"enable": true,
|
|
"format": \{ "Custom": "%D %Z (Tokyo)" \},
|
|
"timezone": "Asia/Tokyo"
|
|
\}
|
|
\}
|
|
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### DateFormat {#dateformat}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (6)</summary>
|
|
|
|
|
|
---
|
|
`string` - Month/Date/Year format (09/08/24)
|
|
|
|
|
|
**Value:** `"MonthDateYear"`
|
|
|
|
---
|
|
`string` - Year-Month-Date format (2024-09-08)
|
|
|
|
|
|
**Value:** `"YearMonthDate"`
|
|
|
|
---
|
|
`string` - Date-Month-Year format (8-Sep-2024)
|
|
|
|
|
|
**Value:** `"DateMonthYear"`
|
|
|
|
---
|
|
`string` - Day Date Month Year format (8 September 2024)
|
|
|
|
|
|
**Value:** `"DayDateMonthYear"`
|
|
|
|
---
|
|
`object` - Custom format (https://docs.rs/chrono/latest/chrono/format/strftime/index.html)
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Custom {#dateformat-oneof[4]-custom}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object` - Custom format with modifiers
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### CustomModifiers {#dateformat-oneof[5]-custommodifiers}
|
|
|
|
<Badge text="required" variant="success" /> [`CustomModifiers`](#custommodifiers)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### DefaultLayout {#defaultlayout}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (9)</summary>
|
|
|
|
- `"BSP"`
|
|
- `"Columns"`
|
|
- `"Rows"`
|
|
- `"VerticalStack"`
|
|
- `"HorizontalStack"`
|
|
- `"UltrawideVerticalStack"`
|
|
- `"Grid"`
|
|
- `"RightMainVerticalStack"`
|
|
- `"Scrolling"`
|
|
|
|
</details>
|
|
#### 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)
|
|
- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_extra1_click.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_extra2_click.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_middle_click.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_scroll_down.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_scroll_left.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_scroll_right.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[98]-content)
|
|
- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[103]-content)
|
|
- [`.mouse.on_scroll_up.message.content[3]`](#socketmessage-oneof[102]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[56]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[99]-content)
|
|
- [`.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:**
|
|
- [`KomorebiLayout`](#komorebilayout)
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### DisplayFormat {#displayformat}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (5)</summary>
|
|
|
|
|
|
---
|
|
`string` - Show only icon
|
|
|
|
|
|
**Value:** `"Icon"`
|
|
|
|
---
|
|
`string` - Show only text
|
|
|
|
|
|
**Value:** `"Text"`
|
|
|
|
---
|
|
`string` - Show an icon and text for the selected element, and text on the rest
|
|
|
|
|
|
**Value:** `"TextAndIconOnSelected"`
|
|
|
|
---
|
|
`string` - Show both icon and text
|
|
|
|
|
|
**Value:** `"IconAndText"`
|
|
|
|
---
|
|
`string` - Show an icon and text for the selected element, and icons on the rest
|
|
|
|
|
|
**Value:** `"IconAndTextOnSelected"`
|
|
|
|
</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)
|
|
- [`KomorebiLayoutConfig`](#komorebilayoutconfig)
|
|
- [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig)
|
|
- [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig)
|
|
- [`WorkspacesDisplayFormat`](#workspacesdisplayformat)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### FocusFollowsMouseImplementation {#focusfollowsmouseimplementation}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`string` - A custom FFM implementation (slightly more CPU-intensive)
|
|
|
|
|
|
**Value:** `"Komorebi"`
|
|
|
|
---
|
|
`string` - The native (legacy) Windows FFM implementation
|
|
|
|
|
|
**Value:** `"Windows"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[167]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[166]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### FrameConfig {#frameconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### inner_margin {#frameconfig-inner_margin}
|
|
|
|
<Badge text="required" variant="success" /> [`Position`](#position)
|
|
|
|
Margin inside the painted frame
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.frame`](#frame)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### GroupedSpacingConfig {#groupedspacingconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### horizontal {#groupedspacingconfig-horizontal}
|
|
|
|
<Badge text="optional" variant="note" /> [`GroupedSpacingOptions`](#groupedspacingoptions)
|
|
|
|
|
|
|
|
|
|
#### vertical {#groupedspacingconfig-vertical}
|
|
|
|
<Badge text="optional" variant="note" /> [`GroupedSpacingOptions`](#groupedspacingoptions)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.margin`](#spacingkind)
|
|
- [`.padding`](#spacingkind)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SpacingKind`](#spacingkind)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### GroupedSpacingOptions {#groupedspacingoptions}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`number`
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
`array` `[float; 2]`
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.margin.horizontal`](#groupedspacingconfig-horizontal)
|
|
- [`.margin.vertical`](#groupedspacingconfig-vertical)
|
|
- [`.padding.horizontal`](#groupedspacingconfig-horizontal)
|
|
- [`.padding.vertical`](#groupedspacingconfig-vertical)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`GroupedSpacingConfig`](#groupedspacingconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Grouping {#grouping}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
|
|
---
|
|
`object` - No grouping is applied
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### kind {#grouping-oneof[0]-kind}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"None"`
|
|
|
|
</details>
|
|
|
|
---
|
|
[`GroupingConfig`](#groupingconfig) - Widgets are grouped as a whole
|
|
|
|
|
|
|
|
|
|
---
|
|
[`GroupingConfig`](#groupingconfig) - Widgets are grouped by alignment
|
|
|
|
|
|
|
|
|
|
---
|
|
[`GroupingConfig`](#groupingconfig) - Widgets are grouped individually
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.grouping`](#grouping)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### GroupingConfig {#groupingconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### rounding {#groupingconfig-rounding}
|
|
|
|
<Badge text="optional" variant="note" /> [`RoundingConfig`](#roundingconfig)
|
|
|
|
Rounding values for the 4 corners. Can be a single or 4 values.
|
|
|
|
|
|
|
|
#### style {#groupingconfig-style}
|
|
|
|
<Badge text="optional" variant="note" /> [`GroupingStyle`](#groupingstyle)
|
|
|
|
Styles for the grouping
|
|
|
|
|
|
|
|
#### transparency_alpha {#groupingconfig-transparency_alpha}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Alpha value for the color transparency [[0-255]] (default: 200)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.grouping`](#grouping)
|
|
- [`.grouping`](#grouping)
|
|
- [`.grouping`](#grouping)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`Grouping`](#grouping)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### GroupingStyle {#groupingstyle}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (7)</summary>
|
|
|
|
|
|
---
|
|
`string`
|
|
|
|
<details>
|
|
<summary>Enum variants (1)</summary>
|
|
|
|
- `"Default"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`string` - 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)
|
|
|
|
|
|
**Value:** `"DefaultWithShadowB4O0S3"`
|
|
|
|
---
|
|
`string` - 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)
|
|
|
|
|
|
**Value:** `"DefaultWithGlowB3O1S2"`
|
|
|
|
---
|
|
`string` - 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)
|
|
|
|
|
|
**Value:** `"DefaultWithGlowB0O1S2"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.grouping.style`](#groupingconfig-style)
|
|
- [`.grouping.style`](#groupingconfig-style)
|
|
- [`.grouping.style`](#groupingconfig-style)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`GroupingConfig`](#groupingconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Hex {#hex}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `color-hex`
|
|
|
|
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#colour)
|
|
- [`.theme.colours.base_00`](#colour)
|
|
- [`.theme.colours.base_01`](#colour)
|
|
- [`.theme.colours.base_02`](#colour)
|
|
- [`.theme.colours.base_03`](#colour)
|
|
- [`.theme.colours.base_04`](#colour)
|
|
- [`.theme.colours.base_05`](#colour)
|
|
- [`.theme.colours.base_06`](#colour)
|
|
- [`.theme.colours.base_07`](#colour)
|
|
- [`.theme.colours.base_08`](#colour)
|
|
- [`.theme.colours.base_09`](#colour)
|
|
- [`.theme.colours.base_0a`](#colour)
|
|
- [`.theme.colours.base_0b`](#colour)
|
|
- [`.theme.colours.base_0c`](#colour)
|
|
- [`.theme.colours.base_0d`](#colour)
|
|
- [`.theme.colours.base_0e`](#colour)
|
|
- [`.theme.colours.base_0f`](#colour)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`Colour`](#colour)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### HidingBehaviour {#hidingbehaviour}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`string` - END OF LIFE FEATURE: Use the SW_HIDE flag to hide windows when switching workspaces (has issues with Electron apps)
|
|
|
|
|
|
**Value:** `"Hide"`
|
|
|
|
---
|
|
`string` - Use the SW_MINIMIZE flag to hide windows when switching workspaces (has issues with frequent workspace switching)
|
|
|
|
|
|
**Value:** `"Minimize"`
|
|
|
|
---
|
|
`string` - Use the undocumented SetCloak Win32 function to hide windows when switching workspaces
|
|
|
|
|
|
**Value:** `"Cloak"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[48]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[48]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### IndividualSpacingConfig {#individualspacingconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### bottom {#individualspacingconfig-bottom}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
#### left {#individualspacingconfig-left}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
#### right {#individualspacingconfig-right}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
#### top {#individualspacingconfig-top}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.margin`](#spacingkind)
|
|
- [`.padding`](#spacingkind)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SpacingKind`](#spacingkind)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KeyboardConfig {#keyboardconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### data_refresh_interval {#keyboardconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 1 second)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#keyboardconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Input widget
|
|
|
|
|
|
|
|
#### label_prefix {#keyboardconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomobarTheme {#komobartheme}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`object` - A theme from catppuccin-egui
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### accent {#komobartheme-oneof[0]-accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
|
|
|
|
|
|
#### auto_select_fill {#komobartheme-oneof[0]-auto_select_fill}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
|
|
|
|
|
|
#### auto_select_text {#komobartheme-oneof[0]-auto_select_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
|
|
|
|
|
|
#### name {#komobartheme-oneof[0]-name}
|
|
|
|
<Badge text="required" variant="success" /> [`Catppuccin`](#catppuccin)
|
|
|
|
Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin)
|
|
|
|
|
|
|
|
#### palette {#komobartheme-oneof[0]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Catppuccin"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object` - A theme from base16-egui-themes
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### accent {#komobartheme-oneof[1]-accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### auto_select_fill {#komobartheme-oneof[1]-auto_select_fill}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### auto_select_text {#komobartheme-oneof[1]-auto_select_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### name {#komobartheme-oneof[1]-name}
|
|
|
|
<Badge text="required" variant="success" /> [`Base16`](#base16)
|
|
|
|
Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/)
|
|
|
|
|
|
|
|
#### palette {#komobartheme-oneof[1]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Base16"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object` - A custom Base16 theme
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### accent {#komobartheme-oneof[2]-accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### auto_select_fill {#komobartheme-oneof[2]-auto_select_fill}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### auto_select_text {#komobartheme-oneof[2]-auto_select_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
|
|
|
|
|
|
#### colours {#komobartheme-oneof[2]-colours}
|
|
|
|
<Badge text="required" variant="success" /> [`Base16ColourPalette`](#base16colourpalette)
|
|
|
|
Colours of the custom Base16 theme palette
|
|
|
|
|
|
|
|
#### palette {#komobartheme-oneof[2]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Custom"`
|
|
|
|
</details>
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.theme`](#theme)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiConfig {#komorebiconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (6)</summary>
|
|
|
|
#### configuration_switcher {#komorebiconfig-configuration_switcher}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiConfigurationSwitcherConfig`](#komorebiconfigurationswitcherconfig)
|
|
|
|
Configure the Configuration Switcher widget
|
|
|
|
|
|
|
|
#### focused_container {#komorebiconfig-focused_container}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiFocusedContainerConfig`](#komorebifocusedcontainerconfig)
|
|
|
|
Configure the Focused Container widget
|
|
|
|
|
|
|
|
#### layout {#komorebiconfig-layout}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiLayoutConfig`](#komorebilayoutconfig)
|
|
|
|
Configure the Layout widget
|
|
|
|
|
|
|
|
#### locked_container {#komorebiconfig-locked_container}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiLockedContainerConfig`](#komorebilockedcontainerconfig)
|
|
|
|
Configure the Locked Container widget
|
|
|
|
|
|
|
|
#### workspace_layer {#komorebiconfig-workspace_layer}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiWorkspaceLayerConfig`](#komorebiworkspacelayerconfig)
|
|
|
|
Configure the Workspace Layer widget
|
|
|
|
|
|
|
|
#### workspaces {#komorebiconfig-workspaces}
|
|
|
|
<Badge text="optional" variant="note" /> [`KomorebiWorkspacesConfig`](#komorebiworkspacesconfig)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiConfigurationSwitcherConfig {#komorebiconfigurationswitcherconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### configurations {#komorebiconfigurationswitcherconfig-configurations}
|
|
|
|
<Badge text="required" variant="success" /> `object`
|
|
|
|
A map of display friendly name => path to configuration.json
|
|
|
|
|
|
<details>
|
|
<summary>Additional Properties</summary>
|
|
|
|
`string`
|
|
|
|
|
|
</details>
|
|
#### enable {#komorebiconfigurationswitcherconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiFocusedContainerConfig {#komorebifocusedcontainerconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### display {#komorebifocusedcontainerconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`DisplayFormat`](#displayformat)
|
|
|
|
Display format of the currently focused container
|
|
|
|
|
|
|
|
#### enable {#komorebifocusedcontainerconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Komorebi Focused Container widget
|
|
|
|
|
|
|
|
#### show_icon {#komorebifocusedcontainerconfig-show_icon}
|
|
|
|
<Badge text="deprecated" variant="danger" /> <Badge text="optional" variant="note" /> `boolean`
|
|
|
|
DEPRECATED: use display instead (Show the icon of the currently focused container)
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiLayout {#komorebilayout}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (5)</summary>
|
|
|
|
|
|
---
|
|
[`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
---
|
|
`null`
|
|
|
|
|
|
|
|
---
|
|
`null`
|
|
|
|
|
|
|
|
---
|
|
`null`
|
|
|
|
|
|
|
|
---
|
|
`null`
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiLayoutConfig {#komorebilayoutconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### display {#komorebilayoutconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`DisplayFormat`](#displayformat)
|
|
|
|
Display format of the current layout
|
|
|
|
|
|
|
|
#### enable {#komorebilayoutconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Komorebi Layout widget
|
|
|
|
|
|
|
|
#### options {#komorebilayoutconfig-options}
|
|
|
|
<Badge text="optional" variant="note" /> `array` [`KomorebiLayout`](#komorebilayout)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiLockedContainerConfig {#komorebilockedcontainerconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### display {#komorebilockedcontainerconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`DisplayFormat`](#displayformat)
|
|
|
|
Display format of the current locked state
|
|
|
|
|
|
|
|
#### enable {#komorebilockedcontainerconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Komorebi Locked Container widget
|
|
|
|
|
|
|
|
#### show_when_unlocked {#komorebilockedcontainerconfig-show_when_unlocked}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiMouseMessage {#komorebimousemessage}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### focus_monitor_at_cursor {#komorebimousemessage-focus_monitor_at_cursor}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Send the FocusMonitorAtCursor message (default:true)
|
|
|
|
|
|
|
|
#### ignore_mouse_follows_focus {#komorebimousemessage-ignore_mouse_follows_focus}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Wrap the \{message\} with a MouseFollowsFocus(false) and MouseFollowsFocus(\{original.value\}) message (default:true)
|
|
|
|
|
|
|
|
#### message {#komorebimousemessage-message}
|
|
|
|
<Badge text="required" variant="success" /> [`SocketMessage`](#socketmessage)
|
|
|
|
The message to send to the komorebi client
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click`](#mousemessage)
|
|
- [`.mouse.on_extra2_click`](#mousemessage)
|
|
- [`.mouse.on_middle_click`](#mousemessage)
|
|
- [`.mouse.on_primary_double_click`](#mousemessage)
|
|
- [`.mouse.on_scroll_down`](#mousemessage)
|
|
- [`.mouse.on_scroll_left`](#mousemessage)
|
|
- [`.mouse.on_scroll_right`](#mousemessage)
|
|
- [`.mouse.on_scroll_up`](#mousemessage)
|
|
- [`.mouse.on_secondary_click`](#mousemessage)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`MouseMessage`](#mousemessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiTheme {#komorebitheme}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`object` - A theme from catppuccin-egui
|
|
|
|
|
|
<details>
|
|
<summary>Properties (12)</summary>
|
|
|
|
#### bar_accent {#komorebitheme-oneof[0]-bar_accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Komorebi status bar accent (default: Blue)
|
|
|
|
|
|
|
|
#### floating_border {#komorebitheme-oneof[0]-floating_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the window is floating (default: Yellow)
|
|
|
|
|
|
|
|
#### monocle_border {#komorebitheme-oneof[0]-monocle_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the container is in monocle mode (default: Pink)
|
|
|
|
|
|
|
|
#### name {#komorebitheme-oneof[0]-name}
|
|
|
|
<Badge text="required" variant="success" /> [`Catppuccin`](#catppuccin)
|
|
|
|
Name of the Catppuccin theme (theme previews: https://github.com/catppuccin/catppuccin)
|
|
|
|
|
|
|
|
#### palette {#komorebitheme-oneof[0]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Catppuccin"`
|
|
#### single_border {#komorebitheme-oneof[0]-single_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the container contains a single window (default: Blue)
|
|
|
|
|
|
|
|
#### stack_border {#komorebitheme-oneof[0]-stack_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the container contains multiple windows (default: Green)
|
|
|
|
|
|
|
|
#### stackbar_background {#komorebitheme-oneof[0]-stackbar_background}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Stackbar tab background colour (default: Base)
|
|
|
|
|
|
|
|
#### stackbar_focused_text {#komorebitheme-oneof[0]-stackbar_focused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Stackbar focused tab text colour (default: Green)
|
|
|
|
|
|
|
|
#### stackbar_unfocused_text {#komorebitheme-oneof[0]-stackbar_unfocused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Stackbar unfocused tab text colour (default: Text)
|
|
|
|
|
|
|
|
#### unfocused_border {#komorebitheme-oneof[0]-unfocused_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the container is unfocused (default: Base)
|
|
|
|
|
|
|
|
#### unfocused_locked_border {#komorebitheme-oneof[0]-unfocused_locked_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`CatppuccinValue`](#catppuccinvalue)
|
|
|
|
Border colour when the container is unfocused and locked (default: Red)
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object` - A theme from base16-egui-themes
|
|
|
|
|
|
<details>
|
|
<summary>Properties (12)</summary>
|
|
|
|
#### bar_accent {#komorebitheme-oneof[1]-bar_accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Komorebi status bar accent (default: Base0D)
|
|
|
|
|
|
|
|
#### floating_border {#komorebitheme-oneof[1]-floating_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the window is floating (default: Base09)
|
|
|
|
|
|
|
|
#### monocle_border {#komorebitheme-oneof[1]-monocle_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is in monocle mode (default: Base0F)
|
|
|
|
|
|
|
|
#### name {#komorebitheme-oneof[1]-name}
|
|
|
|
<Badge text="required" variant="success" /> [`Base16`](#base16)
|
|
|
|
Name of the Base16 theme (theme previews: https://tinted-theming.github.io/tinted-gallery/)
|
|
|
|
|
|
|
|
#### palette {#komorebitheme-oneof[1]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Base16"`
|
|
#### single_border {#komorebitheme-oneof[1]-single_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container contains a single window (default: Base0D)
|
|
|
|
|
|
|
|
#### stack_border {#komorebitheme-oneof[1]-stack_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container contains multiple windows (default: Base0B)
|
|
|
|
|
|
|
|
#### stackbar_background {#komorebitheme-oneof[1]-stackbar_background}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar tab background colour (default: Base01)
|
|
|
|
|
|
|
|
#### stackbar_focused_text {#komorebitheme-oneof[1]-stackbar_focused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar focused tab text colour (default: Base0B)
|
|
|
|
|
|
|
|
#### stackbar_unfocused_text {#komorebitheme-oneof[1]-stackbar_unfocused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar unfocused tab text colour (default: Base05)
|
|
|
|
|
|
|
|
#### unfocused_border {#komorebitheme-oneof[1]-unfocused_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is unfocused (default: Base01)
|
|
|
|
|
|
|
|
#### unfocused_locked_border {#komorebitheme-oneof[1]-unfocused_locked_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is unfocused and locked (default: Base08)
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object` - A custom Base16 theme
|
|
|
|
|
|
<details>
|
|
<summary>Properties (12)</summary>
|
|
|
|
#### bar_accent {#komorebitheme-oneof[2]-bar_accent}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Komorebi status bar accent (default: Base0D)
|
|
|
|
|
|
|
|
#### colours {#komorebitheme-oneof[2]-colours}
|
|
|
|
<Badge text="required" variant="success" /> [`Base16ColourPalette`](#base16colourpalette)
|
|
|
|
Colours of the custom Base16 theme palette
|
|
|
|
|
|
|
|
#### floating_border {#komorebitheme-oneof[2]-floating_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the window is floating (default: Base09)
|
|
|
|
|
|
|
|
#### monocle_border {#komorebitheme-oneof[2]-monocle_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is in monocle mode (default: Base0F)
|
|
|
|
|
|
|
|
#### palette {#komorebitheme-oneof[2]-palette}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Custom"`
|
|
#### single_border {#komorebitheme-oneof[2]-single_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container contains a single window (default: Base0D)
|
|
|
|
|
|
|
|
#### stack_border {#komorebitheme-oneof[2]-stack_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container contains multiple windows (default: Base0B)
|
|
|
|
|
|
|
|
#### stackbar_background {#komorebitheme-oneof[2]-stackbar_background}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar tab background colour (default: Base01)
|
|
|
|
|
|
|
|
#### stackbar_focused_text {#komorebitheme-oneof[2]-stackbar_focused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar focused tab text colour (default: Base0B)
|
|
|
|
|
|
|
|
#### stackbar_unfocused_text {#komorebitheme-oneof[2]-stackbar_unfocused_text}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Stackbar unfocused tab text colour (default: Base05)
|
|
|
|
|
|
|
|
#### unfocused_border {#komorebitheme-oneof[2]-unfocused_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is unfocused (default: Base01)
|
|
|
|
|
|
|
|
#### unfocused_locked_border {#komorebitheme-oneof[2]-unfocused_locked_border}
|
|
|
|
<Badge text="optional" variant="note" /> [`Base16Value`](#base16value)
|
|
|
|
Border colour when the container is unfocused and locked (default: Base08)
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[115]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[115]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiWorkspaceLayerConfig {#komorebiworkspacelayerconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### display {#komorebiworkspacelayerconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`DisplayFormat`](#displayformat)
|
|
|
|
Display format of the current layer
|
|
|
|
|
|
|
|
#### enable {#komorebiworkspacelayerconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Komorebi Workspace Layer widget
|
|
|
|
|
|
|
|
#### show_when_tiling {#komorebiworkspacelayerconfig-show_when_tiling}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### KomorebiWorkspacesConfig {#komorebiworkspacesconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### display {#komorebiworkspacesconfig-display}
|
|
|
|
<Badge text="optional" variant="note" /> [`WorkspacesDisplayFormat`](#workspacesdisplayformat)
|
|
|
|
Display format of the workspace
|
|
|
|
|
|
|
|
#### enable {#komorebiworkspacesconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Komorebi Workspaces widget
|
|
|
|
|
|
|
|
#### hide_empty_workspaces {#komorebiworkspacesconfig-hide_empty_workspaces}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Hide workspaces without any windows
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### LabelPrefix {#labelprefix}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
|
|
---
|
|
`string` - Show no prefix
|
|
|
|
|
|
**Value:** `"None"`
|
|
|
|
---
|
|
`string` - Show an icon
|
|
|
|
|
|
**Value:** `"Icon"`
|
|
|
|
---
|
|
`string` - Show text
|
|
|
|
|
|
**Value:** `"Text"`
|
|
|
|
---
|
|
`string` - Show an icon and text
|
|
|
|
|
|
**Value:** `"IconAndText"`
|
|
|
|
</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)
|
|
- [`CpuConfig`](#cpuconfig)
|
|
- [`DateConfig`](#dateconfig)
|
|
- [`KeyboardConfig`](#keyboardconfig)
|
|
- [`MemoryConfig`](#memoryconfig)
|
|
- [`NetworkConfig`](#networkconfig)
|
|
- [`StorageConfig`](#storageconfig)
|
|
- [`TimeConfig`](#timeconfig)
|
|
- [`UpdateConfig`](#updateconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MediaConfig {#mediaconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### enable {#mediaconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MemoryConfig {#memoryconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### auto_select_over {#memoryconfig-auto_select_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select when the current percentage is over this value [[1-100]]
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### data_refresh_interval {#memoryconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 10 seconds)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#memoryconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Memory widget
|
|
|
|
|
|
|
|
#### label_prefix {#memoryconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MonitorConfig {#monitorconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### index {#monitorconfig-index}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
Komorebi monitor index of the monitor on which to render the bar
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### work_area_offset {#monitorconfig-work_area_offset}
|
|
|
|
<Badge text="optional" variant="note" /> [`Rect`](#rect)
|
|
|
|
Automatically apply a work area offset for this monitor to accommodate the bar
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.monitor`](#monitorconfigorindex)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`MonitorConfigOrIndex`](#monitorconfigorindex)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MonitorConfigOrIndex {#monitorconfigorindex}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`integer` - The monitor index where you want the bar to show
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
---
|
|
[`MonitorConfig`](#monitorconfig) - The full monitor options with the index and an optional work_area_offset
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.monitor`](#monitor)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MouseConfig {#mouseconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (11)</summary>
|
|
|
|
#### horizontal_scroll_threshold {#mouseconfig-horizontal_scroll_threshold}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Defines how many points a user needs to scroll horizontally to make a "tick" on a mouse/touchpad/touchscreen (default: 30)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
#### on_extra1_click {#mouseconfig-on_extra1_click}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on extra1/back button click
|
|
|
|
|
|
|
|
#### on_extra2_click {#mouseconfig-on_extra2_click}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on extra2/forward button click
|
|
|
|
|
|
|
|
#### on_middle_click {#mouseconfig-on_middle_click}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on middle button click
|
|
|
|
|
|
|
|
#### on_primary_double_click {#mouseconfig-on_primary_double_click}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on primary/left double button click
|
|
|
|
|
|
|
|
#### on_scroll_down {#mouseconfig-on_scroll_down}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on scrolling down (every tick)
|
|
|
|
|
|
|
|
#### on_scroll_left {#mouseconfig-on_scroll_left}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on scrolling left (every tick)
|
|
|
|
|
|
|
|
#### on_scroll_right {#mouseconfig-on_scroll_right}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on scrolling right (every tick)
|
|
|
|
|
|
|
|
#### on_scroll_up {#mouseconfig-on_scroll_up}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on scrolling up (every tick)
|
|
|
|
|
|
|
|
#### on_secondary_click {#mouseconfig-on_secondary_click}
|
|
|
|
<Badge text="optional" variant="note" /> [`MouseMessage`](#mousemessage)
|
|
|
|
Command to send on secondary/right button click
|
|
|
|
|
|
|
|
#### vertical_scroll_threshold {#mouseconfig-vertical_scroll_threshold}
|
|
|
|
<Badge text="optional" variant="note" /> `number`
|
|
|
|
Defines how many points a user needs to scroll vertically to make a "tick" on a mouse/touchpad/touchscreen (default: 30)
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse`](#mouse)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MouseMessage {#mousemessage}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
[`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\} =>
|
|
MouseFollowsFocus(\{original.value\})
|
|
Example:
|
|
"on_extra2_click": \{
|
|
"message": \{
|
|
"type": "NewWorkspace"
|
|
\}
|
|
\},
|
|
|
|
or:
|
|
"on_middle_click": \{
|
|
"focus_monitor_at_cursor": false,
|
|
"ignore_mouse_follows_focus": false,
|
|
"message": \{
|
|
"type": "TogglePause"
|
|
\}
|
|
\}
|
|
|
|
or:
|
|
"on_scroll_up": \{
|
|
"message": \{
|
|
"type": "CycleFocusWorkspace",
|
|
"content": "Previous"
|
|
\}
|
|
\}
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
`string` - Execute a custom command.
|
|
CMD (%variable%), Bash ($variable) and PowerShell ($Env:variable) variables will be resolved.
|
|
Example: komorebic toggle-pause
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click`](#mouseconfig-on_extra1_click)
|
|
- [`.mouse.on_extra2_click`](#mouseconfig-on_extra2_click)
|
|
- [`.mouse.on_middle_click`](#mouseconfig-on_middle_click)
|
|
- [`.mouse.on_primary_double_click`](#mouseconfig-on_primary_double_click)
|
|
- [`.mouse.on_scroll_down`](#mouseconfig-on_scroll_down)
|
|
- [`.mouse.on_scroll_left`](#mouseconfig-on_scroll_left)
|
|
- [`.mouse.on_scroll_right`](#mouseconfig-on_scroll_right)
|
|
- [`.mouse.on_scroll_up`](#mouseconfig-on_scroll_up)
|
|
- [`.mouse.on_secondary_click`](#mouseconfig-on_secondary_click)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`MouseConfig`](#mouseconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### MoveBehaviour {#movebehaviour}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`string` - Swap the window container with the window container at the edge of the adjacent monitor
|
|
|
|
|
|
**Value:** `"Swap"`
|
|
|
|
---
|
|
`string` - Insert the window container into the focused workspace on the adjacent monitor
|
|
|
|
|
|
**Value:** `"Insert"`
|
|
|
|
---
|
|
`string` - Do nothing if trying to move a window container in the direction of an adjacent monitor
|
|
|
|
|
|
**Value:** `"NoOp"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[50]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[50]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### NetworkConfig {#networkconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (8)</summary>
|
|
|
|
#### activity_left_padding {#networkconfig-activity_left_padding}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Characters to reserve for received and transmitted activity
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### auto_select {#networkconfig-auto_select}
|
|
|
|
<Badge text="optional" variant="note" /> [`NetworkSelectConfig`](#networkselectconfig)
|
|
|
|
Select when the value is over a limit (1MiB is 1048576 bytes (1024*1024))
|
|
|
|
|
|
|
|
#### data_refresh_interval {#networkconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 10 seconds)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#networkconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Network widget
|
|
|
|
|
|
|
|
#### label_prefix {#networkconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
Display label prefix
|
|
|
|
|
|
|
|
#### show_activity {#networkconfig-show_activity}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Show received and transmitted activity
|
|
|
|
|
|
|
|
#### show_default_interface {#networkconfig-show_default_interface}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Show default interface
|
|
|
|
|
|
|
|
#### show_total_activity {#networkconfig-show_total_activity}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Show total received and transmitted activity
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### NetworkSelectConfig {#networkselectconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### received_over {#networkselectconfig-received_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select the received data when it's over this value
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### total_received_over {#networkselectconfig-total_received_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select the total received data when it's over this value
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### total_transmitted_over {#networkselectconfig-total_transmitted_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select the total transmitted data when it's over this value
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### transmitted_over {#networkselectconfig-transmitted_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select the transmitted data when it's over this value
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### OperationBehaviour {#operationbehaviour}
|
|
|
|
`string` `enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`string` - Process komorebic commands on temporarily unmanaged/floated windows
|
|
|
|
|
|
**Value:** `"Op"`
|
|
|
|
---
|
|
`string` - Ignore komorebic commands on temporarily unmanaged/floated windows
|
|
|
|
|
|
**Value:** `"NoOp"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[51]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[51]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### OperationDirection {#operationdirection}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
- `"Left"`
|
|
- `"Right"`
|
|
- `"Up"`
|
|
- `"Down"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[0]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[1]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[2]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[6]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[38]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[13]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### PathBuf {#pathbuf}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_extra1_click.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_extra2_click.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_middle_click.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_scroll_down.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_scroll_left.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_scroll_right.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_scroll_up.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[59]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[76]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[77]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[110]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[111]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[101]-content)
|
|
- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[100]-content)
|
|
- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[105]-content)
|
|
- [`.mouse.on_secondary_click.message.content[3]`](#socketmessage-oneof[104]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Position {#position}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### x {#position-x}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
X coordinate
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
#### y {#position-y}
|
|
|
|
<Badge text="required" variant="success" /> `number`
|
|
|
|
Y coordinate
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.frame.inner_margin`](#frameconfig-inner_margin)
|
|
- [`.position.end`](#positionconfig-end)
|
|
- [`.position.start`](#positionconfig-start)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`FrameConfig`](#frameconfig)
|
|
- [`PositionConfig`](#positionconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### PositionConfig {#positionconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### end {#positionconfig-end}
|
|
|
|
<Badge text="optional" variant="note" /> [`Position`](#position)
|
|
|
|
The desired size of the bar from the starting position (usually monitor width x desired height)
|
|
|
|
|
|
|
|
#### start {#positionconfig-start}
|
|
|
|
<Badge text="optional" variant="note" /> [`Position`](#position)
|
|
|
|
The desired starting position of the bar (0,0 = top left of the screen)
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.position`](#position)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Rect {#rect}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (4)</summary>
|
|
|
|
#### bottom {#rect-bottom}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
The bottom point in a Win32 Rect
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### left {#rect-left}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
The left point in a Win32 Rect
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### right {#rect-right}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
The right point in a Win32 Rect
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### top {#rect-top}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
The top point in a Win32 Rect
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.monitor.work_area_offset`](#monitorconfig-work_area_offset)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_extra1_click.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_extra2_click.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_middle_click.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_scroll_down.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_scroll_left.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_scroll_right.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_scroll_up.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[129]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[139]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[140]-content)
|
|
- [`.mouse.on_secondary_click.message.content[2]`](#socketmessage-oneof[141]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`MonitorConfig`](#monitorconfig)
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Rgb {#rgb}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### b {#rgb-b}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
Blue
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
#### g {#rgb-g}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
Green
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
#### r {#rgb-r}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
Red
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_extra1_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_extra2_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_middle_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_primary_double_click.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_down.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_left.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_right.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_scroll_up.message.content.colours.base_0f`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_00`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_01`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_02`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_03`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_04`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_05`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_06`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_07`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_08`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_09`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0a`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0b`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0c`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0d`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0e`](#colour)
|
|
- [`.mouse.on_secondary_click.message.content.colours.base_0f`](#colour)
|
|
- [`.theme.colours.base_00`](#colour)
|
|
- [`.theme.colours.base_01`](#colour)
|
|
- [`.theme.colours.base_02`](#colour)
|
|
- [`.theme.colours.base_03`](#colour)
|
|
- [`.theme.colours.base_04`](#colour)
|
|
- [`.theme.colours.base_05`](#colour)
|
|
- [`.theme.colours.base_06`](#colour)
|
|
- [`.theme.colours.base_07`](#colour)
|
|
- [`.theme.colours.base_08`](#colour)
|
|
- [`.theme.colours.base_09`](#colour)
|
|
- [`.theme.colours.base_0a`](#colour)
|
|
- [`.theme.colours.base_0b`](#colour)
|
|
- [`.theme.colours.base_0c`](#colour)
|
|
- [`.theme.colours.base_0d`](#colour)
|
|
- [`.theme.colours.base_0e`](#colour)
|
|
- [`.theme.colours.base_0f`](#colour)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`Colour`](#colour)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### RoundingConfig {#roundingconfig}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
|
|
---
|
|
`number` - All 4 corners are the same
|
|
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
`array` `number` - All 4 corners are custom. Order: NW, NE, SW, SE
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.grouping.rounding`](#groupingconfig-rounding)
|
|
- [`.grouping.rounding`](#groupingconfig-rounding)
|
|
- [`.grouping.rounding`](#groupingconfig-rounding)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`GroupingConfig`](#groupingconfig)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### Sizing {#sizing}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
- `"Increase"`
|
|
- `"Decrease"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[54]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[55]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[13]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[14]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### SocketMessage {#socketmessage}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (183)</summary>
|
|
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[0]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[0]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[1]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[1]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[2]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[2]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"PreselectDirection"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[3]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CancelPreselect"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[4]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[4]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleFocusWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[5]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[5]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleMoveWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[6]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[6]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[7]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"UnstackWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[8]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[8]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleStack"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[9]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[9]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleStackIndex"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[10]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[10]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusStackWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[11]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackAll"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[12]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"UnstackAll"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[13]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
**[1]** [`Sizing`](#sizing)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[13]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ResizeWindowEdge"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[14]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`Axis`](#axis)
|
|
|
|
|
|
|
|
**[1]** [`Sizing`](#sizing)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[14]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ResizeWindowAxis"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[15]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveContainerToLastWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[16]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SendContainerToLastWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[17]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[17]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveContainerToMonitorNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[18]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[18]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleMoveContainerToMonitor"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[19]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[19]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveContainerToWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[20]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[20]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveContainerToNamedWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[21]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[21]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleMoveContainerToWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[22]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[22]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SendContainerToMonitorNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[23]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[23]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleSendContainerToMonitor"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[24]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[24]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SendContainerToWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[25]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[25]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleSendContainerToWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[26]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[26]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SendContainerToMonitorWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[27]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[27]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveContainerToMonitorWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[28]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[28]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SendContainerToNamedWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[29]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[29]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleMoveWorkspaceToMonitor"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[30]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[30]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MoveWorkspaceToMonitorNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[31]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[31]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SwapWorkspacesToMonitorNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[32]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ForceFocus"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[33]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Close"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[34]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Minimize"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[35]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Promote"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[36]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"PromoteSwap"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[37]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"PromoteFocus"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[38]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationDirection`](#operationdirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[38]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"PromoteWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[39]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[39]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"EagerFocus"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[40]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[40]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"LockMonitorWorkspaceContainer"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[41]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[41]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"UnlockMonitorWorkspaceContainer"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[42]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleLock"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[43]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleFloat"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[44]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleMonocle"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[45]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleMaximize"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[46]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleWindowContainerBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[47]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleFloatOverride"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[48]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`HidingBehaviour`](#hidingbehaviour)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[48]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WindowHidingBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[49]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleCrossMonitorMoveBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[50]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`MoveBehaviour`](#movebehaviour)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[50]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CrossMonitorMoveBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[51]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`OperationBehaviour`](#operationbehaviour)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[51]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"UnmanagedWindowOperationBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[52]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ManageFocusedWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[53]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"UnmanageFocusedWindow"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[54]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`Sizing`](#sizing)
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[54]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AdjustContainerPadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[55]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`Sizing`](#sizing)
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[55]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AdjustWorkspacePadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[56]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[56]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ChangeLayout"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[57]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[57]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleLayout"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[58]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 1
|
|
|
|
#### type {#socketmessage-oneof[58]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ScrollingLayoutColumns"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[59]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[59]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ChangeLayoutCustom"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[60]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`Axis`](#axis)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[60]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FlipLayout"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[61]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleWorkspaceWindowContainerBehaviour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[62]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleWorkspaceFloatOverride"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[63]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 5]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[63]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MonitorIndexPreference"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[64]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[64]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"DisplayIndexPreference"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[65]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[65]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"EnsureWorkspaces"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[66]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `array` `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[66]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"EnsureNamedWorkspaces"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[67]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NewWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[68]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleTiling"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[69]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Stop"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[70]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StopIgnoreRestore"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[71]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"TogglePause"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[72]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Retile"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[73]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"RetileWithResizeDimensions"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[74]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"QuickSave"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[75]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"QuickLoad"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[76]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[76]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Save"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[77]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[77]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Load"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[78]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[78]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleFocusMonitor"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[79]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[79]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleFocusWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[80]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`CycleDirection`](#cycledirection)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[80]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CycleFocusEmptyWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[81]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[81]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusMonitorNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[82]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusMonitorAtCursor"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[83]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusLastWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[84]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CloseWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[85]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[85]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[86]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[86]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusWorkspaceNumbers"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[87]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[87]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusMonitorWorkspaceNumber"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[88]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[88]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusNamedWorkspace"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[89]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[89]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ContainerPadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[90]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[90]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceContainerPadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[91]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[91]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusedWorkspaceContainerPadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[92]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[92]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspacePadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[93]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[93]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspacePadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[94]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[94]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusedWorkspacePadding"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[95]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** `boolean`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[95]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceTiling"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[96]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** `boolean`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[96]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceTiling"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[97]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[97]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceName"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[98]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** [`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[98]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceLayout"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[99]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** [`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[99]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceLayout"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[100]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[100]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceLayoutCustom"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[101]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[101]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceLayoutCustom"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[102]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
<details>
|
|
<summary>Tuple Items (4)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[3]** [`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[102]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceLayoutRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[103]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** [`DefaultLayout`](#defaultlayout)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[103]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceLayoutRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[104]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
<details>
|
|
<summary>Tuple Items (4)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[3]** [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[104]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceLayoutCustomRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[105]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[105]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceLayoutCustomRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[106]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[106]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearWorkspaceLayoutRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[107]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[107]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearNamedWorkspaceLayoutRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[108]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleWorkspaceLayer"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[109]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ReloadConfiguration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[110]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[110]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ReplaceConfiguration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[111]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`PathBuf`](#pathbuf)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[111]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ReloadStaticConfiguration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[112]-content}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[112]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WatchConfiguration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[113]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"CompleteConfiguration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[114]-content}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[114]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AltFocusHack"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[115]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`KomorebiTheme`](#komorebitheme)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[115]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Theme"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[116]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `boolean`
|
|
|
|
|
|
|
|
**[1]** <Badge text="optional" variant="note" /> [`AnimationPrefix`](#animationprefix)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[116]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Animation"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[117]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** <Badge text="optional" variant="note" /> [`AnimationPrefix`](#animationprefix)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[117]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AnimationDuration"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[118]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### type {#socketmessage-oneof[118]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AnimationFps"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[119]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`AnimationStyle`](#animationstyle)
|
|
|
|
|
|
|
|
**[1]** <Badge text="optional" variant="note" /> [`AnimationPrefix`](#animationprefix)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[119]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AnimationStyle"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[120]-content}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[120]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Border"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[121]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
<details>
|
|
<summary>Tuple Items (4)</summary>
|
|
|
|
|
|
**[0]** [`WindowKind`](#windowkind)
|
|
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[3]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint32`
|
|
- **Minimum:** 0
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[121]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"BorderColour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[122]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`BorderStyle`](#borderstyle)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[122]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"BorderStyle"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[123]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[123]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"BorderWidth"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[124]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[124]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"BorderOffset"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[125]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`BorderImplementation`](#borderimplementation)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[125]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"BorderImplementation"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[126]-content}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[126]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Transparency"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[127]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleTransparency"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[128]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### type {#socketmessage-oneof[128]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"TransparencyAlpha"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[129]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`Rect`](#rect)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[129]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"InvisibleBorders"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[130]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`StackbarMode`](#stackbarmode)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[130]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarMode"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[131]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`StackbarLabel`](#stackbarlabel)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[131]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarLabel"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[132]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[132]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarFocusedTextColour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[133]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[133]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarUnfocusedTextColour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[134]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 3]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[134]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarBackgroundColour"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[135]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[135]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarHeight"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[136]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[136]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarTabWidth"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[137]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[137]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarFontSize"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[138]-content}
|
|
|
|
<Badge text="required" variant="success" /> <Badge text="optional" variant="note" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[138]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StackbarFontFamily"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[139]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`Rect`](#rect)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[139]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkAreaOffset"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[140]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** [`Rect`](#rect)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[140]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MonitorWorkAreaOffset"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[141]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[1]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[2]** [`Rect`](#rect)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[141]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceWorkAreaOffset"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[142]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleWindowBasedWorkAreaOffset"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[143]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int32`
|
|
|
|
#### type {#socketmessage-oneof[143]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ResizeDelta"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[144]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
<details>
|
|
<summary>Tuple Items (4)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
**[2]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[3]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[144]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"InitialWorkspaceRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[145]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
**[2]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[145]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"InitialNamedWorkspaceRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[146]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 4
|
|
- **Max items:** 4
|
|
<details>
|
|
<summary>Tuple Items (4)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
**[2]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
**[3]** `integer`
|
|
|
|
|
|
|
|
- **Format:** `uint`
|
|
- **Minimum:** 0
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[146]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"WorkspaceRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[147]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 3
|
|
- **Max items:** 3
|
|
<details>
|
|
<summary>Tuple Items (3)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
**[2]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[147]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NamedWorkspaceRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[148]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `[integer; 2]`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[148]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearWorkspaceRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[149]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[149]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearNamedWorkspaceRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[150]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearAllWorkspaceRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[151]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"EnforceWorkspaceRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[152]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SessionFloatRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[153]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SessionFloatRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[154]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ClearSessionFloatRules"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[155]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[155]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"IgnoreRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[156]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[156]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ManageRule"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[157]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[157]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"IdentifyObjectNameChangeApplication"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[158]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[158]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"IdentifyTrayApplication"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[159]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[159]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"IdentifyLayeredApplication"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[160]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[160]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"IdentifyBorderOverflowApplication"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[161]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"State"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[162]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"GlobalState"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[163]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"VisibleWindows"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[164]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MonitorInformation"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[165]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`StateQuery`](#statequery)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[165]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"Query"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[166]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation)
|
|
|
|
|
|
|
|
**[1]** `boolean`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[166]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"FocusFollowsMouse"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[167]-content}
|
|
|
|
<Badge text="required" variant="success" /> [`FocusFollowsMouseImplementation`](#focusfollowsmouseimplementation)
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[167]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleFocusFollowsMouse"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[168]-content}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[168]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"MouseFollowsFocus"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[169]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleMouseFollowsFocus"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[170]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** [`ApplicationIdentifier`](#applicationidentifier)
|
|
|
|
|
|
|
|
**[1]** `string`
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[170]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"RemoveTitleBar"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[171]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ToggleTitleBars"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[172]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[172]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AddSubscriberSocket"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[173]-content}
|
|
|
|
<Badge text="required" variant="success" /> `array` `tuple`
|
|
|
|
|
|
|
|
|
|
|
|
- **Min items:** 2
|
|
- **Max items:** 2
|
|
<details>
|
|
<summary>Tuple Items (2)</summary>
|
|
|
|
|
|
**[0]** `string`
|
|
|
|
|
|
|
|
**[1]** [`SubscribeOptions`](#subscribeoptions)
|
|
|
|
|
|
|
|
</details>
|
|
#### type {#socketmessage-oneof[173]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AddSubscriberSocketWithOptions"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[174]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[174]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"RemoveSubscriberSocket"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[175]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[175]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"AddSubscriberPipe"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[176]-content}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
#### type {#socketmessage-oneof[176]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"RemoveSubscriberPipe"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[177]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"ApplicationSpecificConfigurationSchema"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[178]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"NotificationSchema"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[179]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"SocketSchema"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[180]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"StaticConfigSchema"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### type {#socketmessage-oneof[181]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"GenerateStaticConfig"`
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (2)</summary>
|
|
|
|
#### content {#socketmessage-oneof[182]-content}
|
|
|
|
<Badge text="required" variant="success" /> `integer`
|
|
|
|
|
|
|
|
|
|
|
|
- **Format:** `int`
|
|
|
|
#### type {#socketmessage-oneof[182]-type}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
**Value:** `"DebugWindow"`
|
|
|
|
</details>
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_extra2_click.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_middle_click.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_primary_double_click.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_scroll_down.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_scroll_left.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_scroll_right.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_scroll_up.message`](#komorebimousemessage-message)
|
|
- [`.mouse.on_secondary_click.message`](#komorebimousemessage-message)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`KomorebiMouseMessage`](#komorebimousemessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### SpacingKind {#spacingkind}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
|
|
---
|
|
`number`
|
|
|
|
|
|
|
|
- **Format:** `float`
|
|
|
|
|
|
---
|
|
[`IndividualSpacingConfig`](#individualspacingconfig)
|
|
|
|
|
|
|
|
---
|
|
[`GroupedSpacingConfig`](#groupedspacingconfig)
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.margin`](#margin)
|
|
- [`.padding`](#padding)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### StackbarLabel {#stackbarlabel}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (2)</summary>
|
|
|
|
- `"Process"`
|
|
- `"Title"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[131]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[131]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### StackbarMode {#stackbarmode}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (3)</summary>
|
|
|
|
- `"Always"`
|
|
- `"Never"`
|
|
- `"OnStack"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[130]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[130]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### StateQuery {#statequery}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (8)</summary>
|
|
|
|
- `"FocusedMonitorIndex"`
|
|
- `"FocusedWorkspaceIndex"`
|
|
- `"FocusedContainerIndex"`
|
|
- `"FocusedWindowIndex"`
|
|
- `"FocusedWorkspaceName"`
|
|
- `"FocusedWorkspaceLayout"`
|
|
- `"FocusedContainerKind"`
|
|
- `"Version"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_extra2_click.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_middle_click.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_primary_double_click.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_scroll_down.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_scroll_left.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_scroll_right.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_scroll_up.message.content`](#socketmessage-oneof[165]-content)
|
|
- [`.mouse.on_secondary_click.message.content`](#socketmessage-oneof[165]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### StorageConfig {#storageconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (7)</summary>
|
|
|
|
#### auto_hide_under {#storageconfig-auto_hide_under}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Hide when the current percentage is under this value [[1-100]]
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### auto_select_over {#storageconfig-auto_select_over}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Select when the current percentage is over this value [[1-100]]
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint8`
|
|
- **Minimum:** 0
|
|
- **Maximum:** 255
|
|
|
|
#### data_refresh_interval {#storageconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 10 seconds)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#storageconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Storage widget
|
|
|
|
|
|
|
|
#### label_prefix {#storageconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
Display label prefix
|
|
|
|
|
|
|
|
#### show_read_only_disks {#storageconfig-show_read_only_disks}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Show disks that are read only. (default: false)
|
|
|
|
|
|
|
|
#### show_removable_disks {#storageconfig-show_removable_disks}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Show removable disks. (default: true)
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### SubscribeOptions {#subscribeoptions}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### filter_state_changes {#subscribeoptions-filter_state_changes}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Only emit notifications when the window manager state has changed
|
|
|
|
|
|
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_extra2_click.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_middle_click.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_scroll_down.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_scroll_left.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_scroll_right.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_scroll_up.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
- [`.mouse.on_secondary_click.message.content[1]`](#socketmessage-oneof[173]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### TimeConfig {#timeconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (5)</summary>
|
|
|
|
#### changing_icon {#timeconfig-changing_icon}
|
|
|
|
<Badge text="optional" variant="note" /> `boolean`
|
|
|
|
Change the icon depending on the time. The default icon is used between 8:30 and 12:00. (default: false)
|
|
|
|
|
|
|
|
#### enable {#timeconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Time widget
|
|
|
|
|
|
|
|
#### format {#timeconfig-format}
|
|
|
|
<Badge text="required" variant="success" /> [`TimeFormat`](#timeformat)
|
|
|
|
Set the Time format
|
|
|
|
|
|
|
|
#### label_prefix {#timeconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
Display label prefix
|
|
|
|
|
|
|
|
#### timezone {#timeconfig-timezone}
|
|
|
|
<Badge text="optional" variant="note" /> `string`
|
|
|
|
TimeZone (https://docs.rs/chrono-tz/latest/chrono_tz/enum.Tz.html)
|
|
Use a custom format to display additional information, i.e.:
|
|
\{
|
|
"Time": \{
|
|
"enable": true,
|
|
"format": \{ "Custom": "%T %Z (Tokyo)" \},
|
|
"timezone": "Asia/Tokyo"
|
|
\}
|
|
\}
|
|
|
|
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### TimeFormat {#timeformat}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (7)</summary>
|
|
|
|
|
|
---
|
|
`string` - Twelve-hour format (with seconds)
|
|
|
|
|
|
**Value:** `"TwelveHour"`
|
|
|
|
---
|
|
`string` - Twelve-hour format (without seconds)
|
|
|
|
|
|
**Value:** `"TwelveHourWithoutSeconds"`
|
|
|
|
---
|
|
`string` - Twenty-four-hour format (with seconds)
|
|
|
|
|
|
**Value:** `"TwentyFourHour"`
|
|
|
|
---
|
|
`string` - 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)
|
|
|
|
|
|
**Value:** `"BinaryCircle"`
|
|
|
|
---
|
|
`string` - 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)
|
|
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Custom {#timeformat-oneof[6]-custom}
|
|
|
|
<Badge text="required" variant="success" /> `string`
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### UpdateConfig {#updateconfig}
|
|
|
|
`object`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Properties (3)</summary>
|
|
|
|
#### data_refresh_interval {#updateconfig-data_refresh_interval}
|
|
|
|
<Badge text="optional" variant="note" /> `integer`
|
|
|
|
Data refresh interval (default: 12 hours)
|
|
|
|
|
|
|
|
|
|
- **Format:** `uint64`
|
|
- **Minimum:** 0
|
|
|
|
#### enable {#updateconfig-enable}
|
|
|
|
<Badge text="required" variant="success" /> `boolean`
|
|
|
|
Enable the Update widget
|
|
|
|
|
|
|
|
#### label_prefix {#updateconfig-label_prefix}
|
|
|
|
<Badge text="optional" variant="note" /> [`LabelPrefix`](#labelprefix)
|
|
|
|
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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### WidgetConfig {#widgetconfig}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (12)</summary>
|
|
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Applications {#widgetconfig-oneof[0]-applications}
|
|
|
|
<Badge text="required" variant="success" /> [`ApplicationsConfig`](#applicationsconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Battery {#widgetconfig-oneof[1]-battery}
|
|
|
|
<Badge text="required" variant="success" /> [`BatteryConfig`](#batteryconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Cpu {#widgetconfig-oneof[2]-cpu}
|
|
|
|
<Badge text="required" variant="success" /> [`CpuConfig`](#cpuconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Date {#widgetconfig-oneof[3]-date}
|
|
|
|
<Badge text="required" variant="success" /> [`DateConfig`](#dateconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Keyboard {#widgetconfig-oneof[4]-keyboard}
|
|
|
|
<Badge text="required" variant="success" /> [`KeyboardConfig`](#keyboardconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Komorebi {#widgetconfig-oneof[5]-komorebi}
|
|
|
|
<Badge text="required" variant="success" /> [`KomorebiConfig`](#komorebiconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Media {#widgetconfig-oneof[6]-media}
|
|
|
|
<Badge text="required" variant="success" /> [`MediaConfig`](#mediaconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Memory {#widgetconfig-oneof[7]-memory}
|
|
|
|
<Badge text="required" variant="success" /> [`MemoryConfig`](#memoryconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Network {#widgetconfig-oneof[8]-network}
|
|
|
|
<Badge text="required" variant="success" /> [`NetworkConfig`](#networkconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Storage {#widgetconfig-oneof[9]-storage}
|
|
|
|
<Badge text="required" variant="success" /> [`StorageConfig`](#storageconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Time {#widgetconfig-oneof[10]-time}
|
|
|
|
<Badge text="required" variant="success" /> [`TimeConfig`](#timeconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
---
|
|
`object`
|
|
|
|
<details>
|
|
<summary>Properties (1)</summary>
|
|
|
|
#### Update {#widgetconfig-oneof[11]-update}
|
|
|
|
<Badge text="required" variant="success" /> [`UpdateConfig`](#updateconfig)
|
|
|
|
|
|
|
|
|
|
|
|
</details>
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.center_widgets[]`](#center_widgets)
|
|
- [`.left_widgets[]`](#left_widgets)
|
|
- [`.right_widgets[]`](#right_widgets)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### WindowKind {#windowkind}
|
|
|
|
`string`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (6)</summary>
|
|
|
|
- `"Single"`
|
|
- `"Stack"`
|
|
- `"Monocle"`
|
|
- `"Unfocused"`
|
|
- `"UnfocusedLocked"`
|
|
- `"Floating"`
|
|
|
|
</details>
|
|
#### Usages
|
|
|
|
**Configuration:**
|
|
- [`.mouse.on_extra1_click.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_extra2_click.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_middle_click.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_primary_double_click.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_scroll_down.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_scroll_left.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_scroll_right.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_scroll_up.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
- [`.mouse.on_secondary_click.message.content[0]`](#socketmessage-oneof[121]-content)
|
|
|
|
|
|
**Referenced by:**
|
|
- [`SocketMessage`](#socketmessage)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
### WorkspacesDisplayFormat {#workspacesdisplayformat}
|
|
|
|
`enum`
|
|
|
|
|
|
|
|
|
|
<details>
|
|
<summary>Enum variants (4)</summary>
|
|
|
|
|
|
---
|
|
`string` - Show all icons only
|
|
|
|
|
|
**Value:** `"AllIcons"`
|
|
|
|
---
|
|
`string` - Show both all icons and text
|
|
|
|
|
|
**Value:** `"AllIconsAndText"`
|
|
|
|
---
|
|
`string` - Show all icons and text for the selected element, and all icons on the rest
|
|
|
|
|
|
**Value:** `"AllIconsAndTextOnSelected"`
|
|
|
|
---
|
|
[`DisplayFormat`](#displayformat)
|
|
|
|
|
|
|
|
</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)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|