aboutsummaryrefslogtreecommitdiff
path: root/docs/wiki/Configuration:-Named-Workspaces.md
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2025-09-27 09:31:21 +0300
committerIvan Molodetskikh <yalterz@gmail.com>2025-10-02 09:33:08 +0300
commit264289cd41069bd2c85c523a1b0c687eab0a89d7 (patch)
treeee7de31ec8d5ac0a0951dc1dd97c9f0d18bccb8f /docs/wiki/Configuration:-Named-Workspaces.md
parentf975672255d66386aec16423fa580e8d865c7dfe (diff)
downloadniri-264289cd41069bd2c85c523a1b0c687eab0a89d7.tar.gz
niri-264289cd41069bd2c85c523a1b0c687eab0a89d7.tar.bz2
niri-264289cd41069bd2c85c523a1b0c687eab0a89d7.zip
wiki: Document per-output and per-workspace layout overrides
Diffstat (limited to 'docs/wiki/Configuration:-Named-Workspaces.md')
-rw-r--r--docs/wiki/Configuration:-Named-Workspaces.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/wiki/Configuration:-Named-Workspaces.md b/docs/wiki/Configuration:-Named-Workspaces.md
index 8e87967c..81b270c6 100644
--- a/docs/wiki/Configuration:-Named-Workspaces.md
+++ b/docs/wiki/Configuration:-Named-Workspaces.md
@@ -45,3 +45,53 @@ Before, it could only use the connector name.
<sup>Since: 25.02</sup> Named workspaces no longer update/forget their original output when opening a new window on them (unnamed workspaces will keep doing that).
This means that named workspaces "stick" to their original output in more cases, reflecting their more permanent nature.
Explicitly moving a named workspace to a different monitor will still update its original output.
+
+### Layout config overrides
+
+<sup>Since: next release</sup>
+
+You can customize layout settings for named workspaces with a `layout {}` block:
+
+```kdl
+workspace "aesthetic" {
+ // Layout config overrides just for this named workspace.
+ layout {
+ gaps 32
+
+ struts {
+ left 64
+ right 64
+ bottom 64
+ top 64
+ }
+
+ border {
+ on
+ width 4
+ }
+
+ // ...any other setting.
+ }
+}
+```
+
+It accepts all the same options as [the top-level `layout {}` block](./Configuration:-Layout.md), except:
+
+- `empty-workspace-above-first`: this is an output-level setting, doesn't make sense on a workspace.
+- `insert-hint`: currently we always draw these at the output level, so it's not customizable per-workspace.
+
+In order to unset a flag, write it with `false`, e.g.:
+
+```kdl
+layout {
+ // Enabled globally.
+ always-center-single-column
+}
+
+workspace "uncentered" {
+ layout {
+ // Unset on this workspace.
+ always-center-single-column false
+ }
+}
+```