mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-16 13:51:19 +01:00
feat(docs): regenerate macos references
This commit is contained in:
1 parent
e0870983b4
commit
381e7a4cff
8 files changed
+118
-44
No files matched your search
@@ -12,20 +12,10 @@ import { Badge } from '@astrojs/starlight/components';
|
||||
|
||||
<Badge text="required" variant="success" /> `array` [`WidgetConfig`](#widgetconfig)
|
||||
|
||||
Options for mouse interaction on the bar
|
||||
Left side widgets (ordered left-to-right)
|
||||
|
||||
|
||||
|
||||
---
|
||||
### monitor {#monitor}
|
||||
|
||||
<Badge text="required" variant="success" /> [`MonitorConfigOrIndex`](#monitorconfigorindex)
|
||||
|
||||
The monitor index or the full monitor options
|
||||
|
||||
|
||||
|
||||
---
|
||||
### right_widgets {#right_widgets}
|
||||
|
||||
@@ -114,7 +104,7 @@ Scale of the icons relative to the font_size [[1.0-2.0]]
|
||||
- **Format:** `float`
|
||||
|
||||
|
||||
**Default:** `1.399999976158142`
|
||||
**Default:** `1.4`
|
||||
|
||||
|
||||
---
|
||||
@@ -163,6 +153,15 @@ Max label width before text truncation
|
||||
**Default:** `400.0`
|
||||
|
||||
|
||||
---
|
||||
### monitor {#monitor}
|
||||
|
||||
<Badge text="optional" variant="note" /> [`MonitorConfigOrIndex`](#monitorconfigorindex)
|
||||
|
||||
The monitor index or the full monitor options
|
||||
|
||||
|
||||
|
||||
---
|
||||
### padding {#padding}
|
||||
|
||||
@@ -5874,7 +5873,7 @@ A predefined komorebi layout
|
||||
|
||||
BSP Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-------+-----+
|
||||
| | |
|
||||
| +--+--+
|
||||
@@ -5897,7 +5896,7 @@ BSP Layout
|
||||
|
||||
Columns Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+--+--+--+--+
|
||||
| | | | |
|
||||
| | | | |
|
||||
@@ -5920,7 +5919,7 @@ Columns Layout
|
||||
|
||||
Rows Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----------+
|
||||
|-----------|
|
||||
|-----------|
|
||||
@@ -5943,7 +5942,7 @@ Rows Layout
|
||||
|
||||
Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-------+-----+
|
||||
| | |
|
||||
| +-----+
|
||||
@@ -5966,7 +5965,7 @@ Vertical Stack Layout
|
||||
|
||||
Horizontal Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+------+------+
|
||||
| |
|
||||
|------+------+
|
||||
@@ -5989,7 +5988,7 @@ Horizontal Stack Layout
|
||||
|
||||
Ultrawide Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-----------+-----+
|
||||
| | | |
|
||||
| | +-----+
|
||||
@@ -6014,7 +6013,7 @@ Ultrawide Vertical Stack Layout
|
||||
|
||||
Grid Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
|
||||
| | | | | | | | | | | | | | |
|
||||
| | | | | | | | | | | | | +---+
|
||||
@@ -6022,7 +6021,7 @@ Grid Layout
|
||||
| | | | | | | | | | | | | +---+
|
||||
| | | | | | | | | | | | | | |
|
||||
+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
|
||||
4 windows 5 windows 6 windows 7 windows
|
||||
4 windows 5 windows 6 windows 7 windows
|
||||
```
|
||||
|
||||
|
||||
@@ -6040,7 +6039,7 @@ Grid Layout
|
||||
|
||||
Right Main Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-------+
|
||||
| | |
|
||||
+-----+ |
|
||||
@@ -6063,7 +6062,7 @@ Right Main Vertical Stack Layout
|
||||
|
||||
Scrolling Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+--+--+--+--+--+--+
|
||||
| | | |
|
||||
| | | |
|
||||
|
||||
@@ -59,9 +59,6 @@ Offset of window borders
|
||||
- **Format:** `int32`
|
||||
|
||||
|
||||
**Default:** `5`
|
||||
|
||||
|
||||
---
|
||||
### border_radius {#border_radius}
|
||||
|
||||
@@ -89,7 +86,7 @@ Width of window borders
|
||||
- **Format:** `int32`
|
||||
|
||||
|
||||
**Default:** `6`
|
||||
**Default:** `10`
|
||||
|
||||
|
||||
---
|
||||
@@ -1146,7 +1143,7 @@ A custom W:H aspect ratio
|
||||
|
||||
### Axis {#axis}
|
||||
|
||||
An axis on which to perform an operation
|
||||
Axis on which to perform an operation
|
||||
|
||||
|
||||
|
||||
@@ -6435,7 +6432,7 @@ A predefined komorebi layout
|
||||
|
||||
BSP Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-------+-----+
|
||||
| | |
|
||||
| +--+--+
|
||||
@@ -6458,7 +6455,7 @@ BSP Layout
|
||||
|
||||
Columns Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+--+--+--+--+
|
||||
| | | | |
|
||||
| | | | |
|
||||
@@ -6481,7 +6478,7 @@ Columns Layout
|
||||
|
||||
Rows Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----------+
|
||||
|-----------|
|
||||
|-----------|
|
||||
@@ -6504,7 +6501,7 @@ Rows Layout
|
||||
|
||||
Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-------+-----+
|
||||
| | |
|
||||
| +-----+
|
||||
@@ -6527,7 +6524,7 @@ Vertical Stack Layout
|
||||
|
||||
Horizontal Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+------+------+
|
||||
| |
|
||||
|------+------+
|
||||
@@ -6550,7 +6547,7 @@ Horizontal Stack Layout
|
||||
|
||||
Ultrawide Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-----------+-----+
|
||||
| | | |
|
||||
| | +-----+
|
||||
@@ -6575,7 +6572,7 @@ Ultrawide Vertical Stack Layout
|
||||
|
||||
Grid Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
|
||||
| | | | | | | | | | | | | | |
|
||||
| | | | | | | | | | | | | +---+
|
||||
@@ -6583,7 +6580,7 @@ Grid Layout
|
||||
| | | | | | | | | | | | | +---+
|
||||
| | | | | | | | | | | | | | |
|
||||
+-----+-----+ +---+---+---+ +---+---+---+ +---+---+---+
|
||||
4 windows 5 windows 6 windows 7 windows
|
||||
4 windows 5 windows 6 windows 7 windows
|
||||
```
|
||||
|
||||
|
||||
@@ -6601,7 +6598,7 @@ Grid Layout
|
||||
|
||||
Right Main Vertical Stack Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+-----+-------+
|
||||
| | |
|
||||
+-----+ |
|
||||
@@ -6624,7 +6621,7 @@ Right Main Vertical Stack Layout
|
||||
|
||||
Scrolling Layout
|
||||
|
||||
```
|
||||
```text
|
||||
+--+--+--+--+--+--+
|
||||
| | | |
|
||||
| | | |
|
||||
@@ -7253,10 +7250,40 @@ Options for specific layouts
|
||||
|
||||
|
||||
<details open>
|
||||
<summary>Properties (2)</summary>
|
||||
<summary>Properties (4)</summary>
|
||||
|
||||
|
||||
|
||||
#### column_ratios {#layoutoptions-column_ratios}
|
||||
|
||||
<Badge text="optional" variant="note" /> `array` <Badge text="optional" variant="note" /> `number`
|
||||
|
||||
Column width ratios (up to MAX_RATIOS values between 0.1 and 0.9)
|
||||
|
||||
- Used by Columns layout: ratios for each column width
|
||||
- Used by Grid layout: ratios for column widths
|
||||
- Used by BSP, VerticalStack, RightMainVerticalStack: column_ratios[0] as primary split ratio
|
||||
- Used by HorizontalStack: column_ratios[0] as primary split ratio (top area height)
|
||||
- Used by UltrawideVerticalStack: column_ratios[0] as center ratio, column_ratios[1] as left ratio
|
||||
|
||||
Columns without a ratio share remaining space equally.
|
||||
Example: `[0.3, 0.4, 0.3]` for 30%-40%-30% columns
|
||||
|
||||
|
||||
|
||||
- **Min items:** 5
|
||||
- **Max items:** 5
|
||||
<details open>
|
||||
<summary>Array Items</summary>
|
||||
|
||||
<Badge text="optional" variant="note" /> `number`
|
||||
|
||||
|
||||
|
||||
|
||||
- **Format:** `float`
|
||||
|
||||
</details>
|
||||
#### grid {#layoutoptions-grid}
|
||||
|
||||
<Badge text="optional" variant="note" /> [`GridLayoutOptions`](#gridlayoutoptions)
|
||||
@@ -7264,6 +7291,33 @@ Options for specific layouts
|
||||
Options related to the Grid layout
|
||||
|
||||
|
||||
#### row_ratios {#layoutoptions-row_ratios}
|
||||
|
||||
<Badge text="optional" variant="note" /> `array` <Badge text="optional" variant="note" /> `number`
|
||||
|
||||
Row height ratios (up to MAX_RATIOS values between 0.1 and 0.9)
|
||||
|
||||
- Used by Rows layout: ratios for each row height
|
||||
- Used by Grid layout: ratios for row heights
|
||||
|
||||
Rows without a ratio share remaining space equally.
|
||||
Example: `[0.5, 0.5]` for 50%-50% rows
|
||||
|
||||
|
||||
|
||||
- **Min items:** 5
|
||||
- **Max items:** 5
|
||||
<details open>
|
||||
<summary>Array Items</summary>
|
||||
|
||||
<Badge text="optional" variant="note" /> `number`
|
||||
|
||||
|
||||
|
||||
|
||||
- **Format:** `float`
|
||||
|
||||
</details>
|
||||
#### scrolling {#layoutoptions-scrolling}
|
||||
|
||||
<Badge text="optional" variant="note" /> [`ScrollingLayoutOptions`](#scrollinglayoutoptions)
|
||||
|
||||
@@ -5,13 +5,15 @@ Usage: adjust-container-padding <SIZING> <ADJUSTMENT>
|
||||
|
||||
Arguments:
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
<ADJUSTMENT>
|
||||
Pixels to adjust by as an integer
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -5,13 +5,15 @@ Usage: adjust-workspace-padding <SIZING> <ADJUSTMENT>
|
||||
|
||||
Arguments:
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
<ADJUSTMENT>
|
||||
Pixels to adjust by as an integer
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,6 +7,9 @@ Options:
|
||||
-c, --config <CONFIG>
|
||||
Path to a static configuration JSON file
|
||||
|
||||
--bar
|
||||
Enable autostart of komorebi-bar
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
```
|
||||
Show the System Settings permissions dialogs required by komorebi
|
||||
|
||||
Usage: permissions
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -11,7 +11,9 @@ Arguments:
|
||||
- horizontal-and-vertical: Both horizontal and vertical axes
|
||||
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -8,10 +8,12 @@ Arguments:
|
||||
[possible values: left, right, up, down]
|
||||
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
Reference in new issue
Block a user