diff --git a/content/Configuring/Dwindle-Layout.md b/content/Configuring/Dwindle-Layout.md index c1ae0eace..ceac923e7 100644 --- a/content/Configuring/Dwindle-Layout.md +++ b/content/Configuring/Dwindle-Layout.md @@ -3,55 +3,73 @@ weight: 11 title: Dwindle Layout --- -Dwindle is a BSPWM-like layout, where every window on a workspace is a member of +Dwindle is a [BSPWM](https://github.com/baskerville/bspwm)-like layout, where every window on a workspace is a member of a binary tree. -## Quirks +## Preface + +{{< callout type=info >}} + +In this section we'll be referring to both **orientation** and **direction**, with a very specific meaning: +- **Orientation**: can be horizontal or vertical. + - It refers to the position of two windows relative to eachother. + - The orientation of Dwindle splits is **not fixed**, instead, it's determined **dynamically** by the width-height ratio of the parent node. + - If **width** > **height**, the split "line" will be vertical, resulting in left and right children. + - If **height** > **width**, the split "line" will be horizonal, resulting in top and bottom children. +- **Direction**: can be `left`, `right`, `top` or `bottom`. + - Refers to the _side_ a window can appear on, **relative** to its **parent**. + - Can be influenced by cursor placement and other factors. + +{{< /callout >}} + +{{< callout type=info >}} + +You can make the orientation **fixed** by enabling `preserve_split`. + +{{< /callout >}} + -Dwindle splits are NOT PERMANENT. The split is determined dynamically with the -W/H ratio of the parent node. If W > H, it's side-by-side. If H > W, it's -top-and-bottom. You can make them permanent by enabling `preserve_split`. ## Config category name: `dwindle` -| name | description | type | default | -| --- | --- | --- | --- | -| pseudotile | enable pseudotiling. Pseudotiled windows retain their floating size when tiled. | bool | false | -| force_split | 0 -> split follows mouse, 1 -> always split to the left (new = left or top) 2 -> always split to the right (new = right or bottom) | int | 0 | -| preserve_split | if enabled, the split (side/top) will not change regardless of what happens to the container. | bool | false | -| smart_split | if enabled, allows a more precise control over the window split direction based on the cursor's position. The window is conceptually divided into four triangles, and cursor's triangle determines the split direction. This feature also turns on preserve_split. | bool | false | -| smart_resizing | if enabled, resizing direction will be determined by the mouse's position on the window (nearest to which corner). Else, it is based on the window's tiling position. | bool | true | -| permanent_direction_override | if enabled, makes the preselect direction persist until either this mode is turned off, another direction is specified, or a non-direction is specified (anything other than l,r,u/t,d/b) | bool | false | -| special_scale_factor | specifies the scale factor of windows on the special workspace [0 - 1] | float | 1 | -| split_width_multiplier | specifies the auto-split width multiplier. Multiplying window size is useful on widescreen monitors where window W > H even after several splits. | float | 1.0 | -| use_active_for_splits | whether to prefer the active window or the mouse position for splits | bool | true | -| default_split_ratio | the default split ratio on window open. 1 means even 50/50 split. [0.1 - 1.9] | float | 1.0 | -| split_bias | specifies which window will receive the larger half of a split. positional - 0, current window - 1, opening window - 2 [0/1/2] | int | 0 | -| precise_mouse_move | bindm movewindow will drop the window more precisely depending on where your mouse is. | bool | false | -| single_window_aspect_ratio | whenever only a single window is shown on a screen, add padding so that it conforms to the specified aspect ratio. A value like `4 3` on a 16:9 screen will make it a 4:3 window in the middle with padding to the sides. | Vec2D | 0 0 | -| single_window_aspect_ratio_tolerance | sets a tolerance for `single_window_aspect_ratio`, so that if the padding that would have been added is smaller than the specified fraction of the height or width of the screen, it will not attempt to adjust the window size [0 - 1] | int | 0.1 | +| Name | Description | Type | Default | +| ---- | ----------- | ---- | ------- | +| `pseudotile` | Enable pseudotiling.
Pseudotiled windows retain their floating size when tiled. | bool | `false` | +| `force_split` | `0` -> Split direction follows cursor.
`1` -> Always split to the left or top.
`2` -> always split to the right or bottom. | int | `0` | +| `preserve_split` | If enabled, the split orientation will not change, regardless of the parent dimensions. | bool | `false` | +| `smart_split` | If enabled, allows for more precise control over the split direction based on the cursor's position.

The window is conceptually divided into four triangles, and the one currently under the cursor determines the split direction.

This also enables `preserve_split`. | bool | `false` | +| `smart_resizing` | If enabled, resizing direction will be determined by the cursor's nearest window corner.
Else, it is based on the window's tiling position. | bool | `true` | +| `permanent_direction_override` | If enabled, makes the preselected direction persist until either: | bool | `false` | +| `special_scale_factor` | Specifies the scale factor of windows on the special workspace. | float [`0.0 .. 1.0`] | `1.0` | +| `split_width_multiplier` | Specifies the auto-split width multiplier.
Multiplying window size is useful on widescreen monitors where window W > H even after several splits. | float | `1.0` | +| `use_active_for_splits` | Whether to prefer the active window or the cursor position for splits. | bool | `true` | +| `default_split_ratio` | The default split ratio on window open.
`1.0` means an even 50/50 split. | float [`0.1 .. 1.9`] | `1.0` | +| `split_bias` | Specifies which window will receive the split ratio.
`0` -> directional (the top or left window)
`1` -> the current window | int [`0\|1`] | `0` | +| `precise_mouse_move` | `bindm movewindow` will drop the window more precisely depending your cursor's position. | bool | `false` | +| `single_window_aspect_ratio` | Whenever only a single window is shown on a screen, add padding so that it conforms to the specified aspect ratio.
A value like `4 3` on a 16:9 screen will make it a 4:3 window in the middle with padding to the sides. | Vec2D | `0 0` | +| `single_window_aspect_ratio_tolerance` | Sets a tolerance for `single_window_aspect_ratio` so that if the padding to be added is smaller than the specified fraction of the height or width of the screen, it will not attempt to adjust the window size. | float [`0.0 .. 1.0`] | `0.1` | ## Bind Dispatchers -| dispatcher | description | params | -| --- | --- | --- | -| pseudo | toggles the given window's pseudo mode | left empty / `active` for current, or `window` for a specific window | +| Dispatcher | Description | Params | +| ---------- | ----------- | ------ | +| `pseudo` | Toggles the given window's pseudo mode. | Leave empty / `active` for current, or `window` for a specific window. | -## Layout messages +## Layout Messages Dispatcher `layoutmsg` params: -| param | description | args | -| --- | --- | --- | -| togglesplit | toggles the split (top/side) of the current window. `preserve_split` must be enabled for toggling to work. | none | -| swapsplit | swaps the two halves of the split of the current window. | none | -| preselect | A one-time override for the split direction. (valid for the next window to be opened, only works on tiled windows) | direction | -| movetoroot | moves the selected window (active window if unspecified) to the root of its workspace tree. The default behavior maximizes the window in its current subtree. If `unstable` is provided as the second argument, the window will be swapped with the other subtree instead. It is not possible to only provide the second argument, but `movetoroot active unstable` will achieve the same result. | [window, [ string ]] | +| Param | Description | Args | +| ----- | ----------- | ---- | +| `togglesplit` | Toggles between the two possible split orientations of the current window.
`preserve_split` must be enabled for toggling to work. | none | +| `swapsplit` | Swaps the two halves of the split of the current window. | none | +| `preselect` | A one-time override for the split direction.
(valid for the next window to be opened, only works on tiled windows) | direction | +| `movetoroot` | Moves the selected window (active window if unspecified) to the root of its workspace tree.
The default behavior maximizes the window in its current subtree.
If `unstable` is provided as the second argument, the window will be swapped with the other subtree instead.
It is not possible to only provide the second argument, but `movetoroot active unstable` will achieve the same result. | [window, [ string ]] | -e.g.: +E.g.: ```ini bind = SUPER, A, layoutmsg, preselect l -``` +``` \ No newline at end of file