aboutsummaryrefslogtreecommitdiff
path: root/docs/wiki/Configuration:-Gestures.md
diff options
context:
space:
mode:
authorKent Daleng <lolexplode@gmail.com>2025-08-17 16:05:41 +0200
committerGitHub <noreply@github.com>2025-08-17 17:05:41 +0300
commitdc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a (patch)
treea2f2938a7df17c196be7016dc5fe1fc9f75fb484 /docs/wiki/Configuration:-Gestures.md
parenta6febb86aa5af0df7bf2792ca027ef95a503d599 (diff)
downloadniri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.gz
niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.tar.bz2
niri-dc93f1c1fd7b67e2da5af2ffada732b9ddeb2d6a.zip
github wiki replacement / mkdocs-docs (#2147)
* Add wiki based on mkdocs * wording fixes * fix github bg color on narrow * Fix left sidebar section headers being bigger than pages * fix hover accent * fix list rendering on fractional layout * fix videos * fix automatic full links * remove redundant commented css * improve dark mode contrast * update pygments for better child node coloring * update logo * remove blank lines * add systemd language hint --------- Co-authored-by: Ivan Molodetskikh <yalterz@gmail.com>
Diffstat (limited to 'docs/wiki/Configuration:-Gestures.md')
-rw-r--r--docs/wiki/Configuration:-Gestures.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/docs/wiki/Configuration:-Gestures.md b/docs/wiki/Configuration:-Gestures.md
new file mode 100644
index 00000000..bdb7a407
--- /dev/null
+++ b/docs/wiki/Configuration:-Gestures.md
@@ -0,0 +1,96 @@
+### Overview
+
+<sup>Since: 25.02</sup>
+
+The `gestures` config section contains gesture settings.
+For an overview of all niri gestures, see the [Gestures](./Gestures.md) wiki page.
+
+Here's a quick glance at the available settings along with their default values.
+
+```kdl
+gestures {
+ dnd-edge-view-scroll {
+ trigger-width 30
+ delay-ms 100
+ max-speed 1500
+ }
+
+ dnd-edge-workspace-switch {
+ trigger-height 50
+ delay-ms 100
+ max-speed 1500
+ }
+
+ hot-corners {
+ // off
+ }
+}
+```
+
+### `dnd-edge-view-scroll`
+
+Scroll the tiling view when moving the mouse cursor against a monitor edge during drag-and-drop (DnD).
+Also works on a touchscreen.
+
+This will work for regular drag-and-drop (e.g. dragging a file from a file manager), and for window interactive move when targeting the tiling layout.
+
+The options are:
+
+- `trigger-width`: size of the area near the monitor edge that will trigger the scrolling, in logical pixels.
+- `delay-ms`: delay in milliseconds before the scrolling starts.
+Avoids unwanted scrolling when dragging things across monitors.
+- `max-speed`: maximum scrolling speed in logical pixels per second.
+The scrolling speed increases linearly as you move your mouse cursor from `trigger-width` to the very edge of the monitor.
+
+```kdl
+gestures {
+ // Increase the trigger area and maximum speed.
+ dnd-edge-view-scroll {
+ trigger-width 100
+ max-speed 3000
+ }
+}
+```
+
+### `dnd-edge-workspace-switch`
+
+<sup>Since: 25.05</sup>
+
+Scroll the workspaces up/down when moving the mouse cursor against a monitor edge during drag-and-drop (DnD) while in the overview.
+Also works on a touchscreen.
+
+The options are:
+
+- `trigger-height`: size of the area near the monitor edge that will trigger the scrolling, in logical pixels.
+- `delay-ms`: delay in milliseconds before the scrolling starts.
+Avoids unwanted scrolling when dragging things across monitors.
+- `max-speed`: maximum scrolling speed; 1500 corresponds to one screen height per second.
+The scrolling speed increases linearly as you move your mouse cursor from `trigger-width` to the very edge of the monitor.
+
+```kdl
+gestures {
+ // Increase the trigger area and maximum speed.
+ dnd-edge-workspace-switch {
+ trigger-height 100
+ max-speed 3000
+ }
+}
+```
+
+### `hot-corners`
+
+<sup>Since: 25.05</sup>
+
+Put your mouse at the very top-left corner of a monitor to toggle the overview.
+Also works during drag-and-dropping something.
+
+`off` disables the hot corners.
+
+```kdl
+// Disable the hot corners.
+gestures {
+ hot-corners {
+ off
+ }
+}
+```