aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Molodetskikh <yalterz@gmail.com>2025-02-16 09:41:50 +0300
committerIvan Molodetskikh <yalterz@gmail.com>2025-02-16 10:18:00 +0300
commit5c0468d4691f68e376375166938f16e8597162a1 (patch)
tree0296ea9dd67a0f4c590957eadca1f4d2b156ed14
parentf2b1fc66f21f720ba85a4c218546298e527ba8b9 (diff)
downloadniri-5c0468d4691f68e376375166938f16e8597162a1.tar.gz
niri-5c0468d4691f68e376375166938f16e8597162a1.tar.bz2
niri-5c0468d4691f68e376375166938f16e8597162a1.zip
wiki: Document the DnD edge view scroll gesture and config
-rw-r--r--wiki/Configuration:-Gestures.md43
-rw-r--r--wiki/Gestures.md11
-rw-r--r--wiki/_Sidebar.md1
3 files changed, 55 insertions, 0 deletions
diff --git a/wiki/Configuration:-Gestures.md b/wiki/Configuration:-Gestures.md
new file mode 100644
index 00000000..69d1a244
--- /dev/null
+++ b/wiki/Configuration:-Gestures.md
@@ -0,0 +1,43 @@
+### Overview
+
+<sup>Since: next release</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 50
+ max-speed 1500
+ }
+}
+```
+
+### `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
+ }
+}
+```
diff --git a/wiki/Gestures.md b/wiki/Gestures.md
index 0312a84d..11d6a66e 100644
--- a/wiki/Gestures.md
+++ b/wiki/Gestures.md
@@ -2,6 +2,8 @@
There are several gestures in niri.
+Also see the [gestures configuration](./Configuration:-Gestures.md) wiki page.
+
### Mouse
#### Interactive Move
@@ -57,3 +59,12 @@ Switch workspaces with three-finger vertical swipes.
#### Horizontal View Movement
Move the view horizontally with three-finger horizontal swipes.
+
+### All Pointing Devices
+
+#### Drag-and-Drop Edge View Scroll
+
+<sup>Since: next release</sup>
+
+Scroll the tiling view when moving the mouse cursor against a monitor edge during drag-and-drop (DnD).
+Also works on a touchscreen.
diff --git a/wiki/_Sidebar.md b/wiki/_Sidebar.md
index 6dd0ae61..833977fb 100644
--- a/wiki/_Sidebar.md
+++ b/wiki/_Sidebar.md
@@ -24,6 +24,7 @@
* [Window Rules](./Configuration:-Window-Rules.md)
* [Layer Rules](./Configuration:-Layer-Rules.md)
* [Animations](./Configuration:-Animations.md)
+* [Gestures](./Configuration:-Gestures.md)
* [Debug Options](./Configuration:-Debug-Options.md)
## Development