Files
komorebi/docs/usage/layouts.md
T
LGUG2Z 37b06993d2 feat(wm): tune layouts, and the scrolling layout
`komorebic layout-ratios --columns ... --rows ...` sets the share of the work
area the first columns and rows of the focused workspace's layout take, and
`scrolling-layout-columns N` how many columns of the scrolling layout are in
view. Both are layout options of the workspace, which komorebi-layouts reads.

The scrolling layout is a strip of columns that runs past the edges of the work
area, so its tiles are not clamped to it: the windows of the columns out of view
are off the screen. When a window of a scrolling workspace gets the focus, the
workspace is tiled after the focused container changed, which scrolls the strip
to it.

KWin moves a window anywhere, but keeps 100 pixels of a window it resizes on an
output once the client has drawn at the new size, which pulls the columns out of
view back onto the screen. The bridge remembers the position it was asked for,
for a second, and asks again for the position alone when KWin moved the window
elsewhere, three times at most.

komorebi-layouts compiles `Rect::percentage_within_horizontal_bounds` only with
its darwin feature, which this repository does not enable, so the workspace has
its own copy of it.

A new VM suite, vm-scrolling, after the spike's m2-scrolling script, checks in a
real KWin that the columns out of view stay where komorebi put them and that the
strip follows `komorebic focus`; vm-commands sweeps the two new commands.
2026-10-28 07:20:37 -07:00

5.0 KiB

Layouts

The layout of a workspace turns its work area and the number of its containers into one tile for each container. Every workspace starts with the BSP layout. A command that changes the layout tiles the focused workspace again at once.

The layouts

These are the layouts of komorebi-layouts, in the order cycle-layout next goes through them:

Layout komorebic name The tiles
BSP bsp each new tile splits the last one in two, alternately side by side and one above the other
Columns columns side by side, as wide as each other
Rows rows one above the other, as high as each other
Vertical stack vertical-stack the first on the left half, the others stacked on the right
Horizontal stack horizontal-stack the first on the top half, the others side by side below it
Ultrawide vertical stack ultrawide-vertical-stack the first in the middle, the second on the left, the others stacked on the right
Grid grid columns of tiles, as even as the number of containers allows
Right main vertical stack right-main-vertical-stack the first on the right half, the others stacked on the left
Scrolling scrolling columns side by side

Changing the layout

komorebic change-layout gives the focused workspace the layout it names, and komorebic cycle-layout the next or the previous one in the table above:

komorebic change-layout vertical-stack
komorebic cycle-layout next
komorebic cycle-layout previous

cycle-layout next goes from the scrolling layout back to BSP. Going backwards, komorebi-layouts leaves the scrolling layout out: cycle-layout previous goes from BSP to the right main vertical stack.

komorebic query focused-workspace-layout prints the layout of the focused workspace.

Ratios

komorebic layout-ratios sets the share of the work area the first columns (--columns) and the first rows (--rows) of the focused workspace's layout take, as fractions: --columns 0.6 gives the first column 60% of the width, and the columns after it share the rest.

komorebic layout-ratios --columns 0.6
komorebic layout-ratios --columns 0.5 0.3 --rows 0.7

Each takes five ratios at most, each kept between 0.1 and 0.9, and the ratios after the one that would make them add up to 1 are dropped, so that there is always room for another column or row. The ratios stay with the workspace when its layout changes. Without --columns or --rows, layout-ratios changes nothing.

The scrolling layout

The scrolling layout puts every container in a column of its own, the columns side by side in a strip that runs past the edges of the monitor. The windows of the columns out of view are off the screen, and KWin leaves them there. When a window of the workspace gets the focus, the strip scrolls so that its column is in view, so komorebic focus left and focus right walk along it.

komorebic scrolling-layout-columns sets how many columns are in view at once on the focused workspace:

komorebic change-layout scrolling
komorebic scrolling-layout-columns 2

Off the screen to the right of one monitor is on the next monitor over, if there is one, so the columns out of view can show on it.

Flipping the layout

komorebic flip-layout mirrors the tiles of the focused workspace: horizontal swaps left and right, vertical top and bottom, and horizontal-and-vertical both. A flip is added to the one the workspace has, so the same flip twice puts the layout back.

komorebic flip-layout horizontal
komorebic flip-layout horizontal

The containers keep their order, and the directions of focus and move are the ones on the screen: after flip-layout horizontal, focus left goes to the tile on the left.

Turning tiling off

komorebic toggle-tiling turns the tiling of the focused workspace off, and on again. While it is off, komorebi moves none of its windows: they stay where they are, and can be moved by hand. Windows that open on the workspace are still taken into it, and when tiling is turned back on, every window is tiled again. query focused-workspace-layout prints None while tiling is off.

Preselecting a tile

komorebic preselect-direction reserves the place on one side of the focused window for the next window that opens on the workspace. The layout gives the reserved place a tile at once, empty until the window opens. komorebic cancel-preselect gives the place up.

komorebic preselect-direction left
komorebic cancel-preselect

The place is a position in the order of the workspace, so where its tile is depends on the layout. A workspace reserves one place at a time: a second preselect-direction is ignored until the window opens or the place is given up. The grid layout has no preselection.