docs: add notes with protocols required to use a module

JakeStanger · Jan 13, 2024 · ed1608e · ed1608e
1 parent 980bb91
commit ed1608e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/docs/modules/Clipboard.md b/docs/modules/Clipboard.md
@@ -1,3 +1,6 @@
+> [!NOTE]
+> This module requires that your wayland compositor support the [wlr data control](https://wayland.app/protocols/wlr-data-control-unstable-v1) protocol.
+
 Shows recent clipboard items, allowing you to switch between them to re-copy previous values.
 Clicking the icon button opens the popup containing all functionality.
 

diff --git a/docs/modules/Focused.md b/docs/modules/Focused.md
@@ -1,3 +1,6 @@
+> [!NOTE]
+> This module requires that your wayland compositor support the [wlr-foreign-toplevel-management](https://wayland.app/protocols/wlr-foreign-toplevel-management-unstable-v1) protocol.
+
 Displays the title and/or icon of the currently focused window.
 
 ![Screenshot of focused widget, showing this page open on firefox](https://user-images.githubusercontent.com/5057870/184714118-c1fb1c67-cd8c-4cc0-b5cd-6faccff818ac.png)

diff --git a/docs/modules/Launcher.md b/docs/modules/Launcher.md
@@ -1,3 +1,6 @@
+> [!NOTE]
+> This module requires that your wayland compositor support the [wlr-foreign-toplevel-management](https://wayland.app/protocols/wlr-foreign-toplevel-management-unstable-v1) protocol.
+
 Windows-style taskbar that displays running windows, grouped by program.
 Hovering over a program with multiple windows open shows a popup with each window.
 Clicking an icon/popup item focuses or launches the program.