feat: add scroll compositor support (#959)

* added scroll support * import QuickShell.i3 * update scroll provider registration logic * improve scroll support for workspace switcher * update title for scroll keybinds * add scroll to dms-greeter * fix: formatting & sway keybind provider * readme update --------- Co-authored-by: bbedward <bbedward@gmail.com>
2026-01-24 21:42:51 -05:00 · 2025-12-09 21:57:46 +01:00
parent aeacf109eb
commit f94011cf05
18 changed files with 298 additions and 169 deletions
--- a/quickshell/Modules/DankBar/DankBar.qml
+++ b/quickshell/Modules/DankBar/DankBar.qml
@@ -96,7 +96,7 @@ Item {
            focusedScreenName = Hyprland.focusedWorkspace.monitor.name;
        } else if (CompositorService.isNiri && NiriService.currentOutput) {
            focusedScreenName = NiriService.currentOutput;
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const focusedWs = I3.workspaces?.values?.find(ws => ws.focused === true);
            focusedScreenName = focusedWs?.monitor?.name || "";
        }
@@ -123,7 +123,7 @@ Item {
            focusedScreenName = Hyprland.focusedWorkspace.monitor.name;
        } else if (CompositorService.isNiri && NiriService.currentOutput) {
            focusedScreenName = NiriService.currentOutput;
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const focusedWs = I3.workspaces?.values?.find(ws => ws.focused === true);
            focusedScreenName = focusedWs?.monitor?.name || "";
        }
--- a/quickshell/Modules/DankBar/DankBarContent.qml
+++ b/quickshell/Modules/DankBar/DankBarContent.qml
@@ -82,7 +82,7 @@ Item {
                }, (_, i) => i);
            }
            return DwlService.getVisibleTags(barWindow.screenName);
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const workspaces = I3.workspaces?.values || [];
            if (workspaces.length === 0)
                return [
@@ -124,7 +124,7 @@ Item {
                return 0;
            const activeTags = DwlService.getActiveTags(barWindow.screenName);
            return activeTags.length > 0 ? activeTags[0] : 0;
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            if (!barWindow.screenName || !SettingsData.workspacesPerMonitor) {
                const focusedWs = I3.workspaces?.values?.find(ws => ws.focused === true);
                return focusedWs ? focusedWs.num : 1;
@@ -169,7 +169,7 @@ Item {
            if (nextIndex !== validIndex) {
                DwlService.switchToTag(barWindow.screenName, realWorkspaces[nextIndex]);
            }
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const currentWs = getCurrentWorkspace();
            const currentIndex = realWorkspaces.findIndex(ws => ws.num === currentWs);
            const validIndex = currentIndex === -1 ? 0 : currentIndex;
@@ -315,37 +315,37 @@ Item {
    }

    readonly property var allComponents: ({
-        "launcherButtonComponent": launcherButtonComponent,
-        "workspaceSwitcherComponent": workspaceSwitcherComponent,
-        "focusedWindowComponent": focusedWindowComponent,
-        "runningAppsComponent": runningAppsComponent,
-        "clockComponent": clockComponent,
-        "mediaComponent": mediaComponent,
-        "weatherComponent": weatherComponent,
-        "systemTrayComponent": systemTrayComponent,
-        "privacyIndicatorComponent": privacyIndicatorComponent,
-        "clipboardComponent": clipboardComponent,
-        "cpuUsageComponent": cpuUsageComponent,
-        "memUsageComponent": memUsageComponent,
-        "diskUsageComponent": diskUsageComponent,
-        "cpuTempComponent": cpuTempComponent,
-        "gpuTempComponent": gpuTempComponent,
-        "notificationButtonComponent": notificationButtonComponent,
-        "batteryComponent": batteryComponent,
-        "layoutComponent": layoutComponent,
-        "controlCenterButtonComponent": controlCenterButtonComponent,
-        "capsLockIndicatorComponent": capsLockIndicatorComponent,
-        "idleInhibitorComponent": idleInhibitorComponent,
-        "spacerComponent": spacerComponent,
-        "separatorComponent": separatorComponent,
-        "networkComponent": networkComponent,
-        "keyboardLayoutNameComponent": keyboardLayoutNameComponent,
-        "vpnComponent": vpnComponent,
-        "notepadButtonComponent": notepadButtonComponent,
-        "colorPickerComponent": colorPickerComponent,
-        "systemUpdateComponent": systemUpdateComponent,
-        "powerMenuButtonComponent": powerMenuButtonComponent
-    })
+            "launcherButtonComponent": launcherButtonComponent,
+            "workspaceSwitcherComponent": workspaceSwitcherComponent,
+            "focusedWindowComponent": focusedWindowComponent,
+            "runningAppsComponent": runningAppsComponent,
+            "clockComponent": clockComponent,
+            "mediaComponent": mediaComponent,
+            "weatherComponent": weatherComponent,
+            "systemTrayComponent": systemTrayComponent,
+            "privacyIndicatorComponent": privacyIndicatorComponent,
+            "clipboardComponent": clipboardComponent,
+            "cpuUsageComponent": cpuUsageComponent,
+            "memUsageComponent": memUsageComponent,
+            "diskUsageComponent": diskUsageComponent,
+            "cpuTempComponent": cpuTempComponent,
+            "gpuTempComponent": gpuTempComponent,
+            "notificationButtonComponent": notificationButtonComponent,
+            "batteryComponent": batteryComponent,
+            "layoutComponent": layoutComponent,
+            "controlCenterButtonComponent": controlCenterButtonComponent,
+            "capsLockIndicatorComponent": capsLockIndicatorComponent,
+            "idleInhibitorComponent": idleInhibitorComponent,
+            "spacerComponent": spacerComponent,
+            "separatorComponent": separatorComponent,
+            "networkComponent": networkComponent,
+            "keyboardLayoutNameComponent": keyboardLayoutNameComponent,
+            "vpnComponent": vpnComponent,
+            "notepadButtonComponent": notepadButtonComponent,
+            "colorPickerComponent": colorPickerComponent,
+            "systemUpdateComponent": systemUpdateComponent,
+            "powerMenuButtonComponent": powerMenuButtonComponent
+        })

    Item {
        id: stackContainer
@@ -534,7 +534,7 @@ Item {
            section: topBarContent.getWidgetSection(parent)
            parentScreen: barWindow.screen
            onClicked: {
-                clipboardHistoryModalPopup.toggle()
+                clipboardHistoryModalPopup.toggle();
            }
        }
    }
@@ -550,9 +550,9 @@ Item {
            parentScreen: barWindow.screen
            onClicked: {
                if (powerMenuModalLoader) {
-                    powerMenuModalLoader.active = true
+                    powerMenuModalLoader.active = true;
                    if (powerMenuModalLoader.item) {
-                        powerMenuModalLoader.item.openCentered()
+                        powerMenuModalLoader.item.openCentered();
                    }
                }
            }
--- a/quickshell/Modules/DankBar/Widgets/LauncherButton.qml
+++ b/quickshell/Modules/DankBar/Widgets/LauncherButton.qml
@@ -1,6 +1,5 @@
 import QtQuick
 import QtQuick.Effects
-import Quickshell
 import Quickshell.Widgets
 import qs.Common
 import qs.Modules.Plugins
@@ -56,7 +55,7 @@ BasePill {
            }

            IconImage {
-                visible: SettingsData.launcherLogoMode === "compositor" && (CompositorService.isNiri || CompositorService.isHyprland || CompositorService.isDwl || CompositorService.isSway || CompositorService.isLabwc)
+                visible: SettingsData.launcherLogoMode === "compositor" && (CompositorService.isNiri || CompositorService.isHyprland || CompositorService.isDwl || CompositorService.isSway || CompositorService.isScroll || CompositorService.isLabwc)
                anchors.centerIn: parent
                width: Theme.barIconSize(root.barThickness, SettingsData.launcherLogoSizeOffset)
                height: Theme.barIconSize(root.barThickness, SettingsData.launcherLogoSizeOffset)
@@ -64,17 +63,19 @@ BasePill {
                asynchronous: true
                source: {
                    if (CompositorService.isNiri) {
-                        return "file://" + Theme.shellDir + "/assets/niri.svg"
+                        return "file://" + Theme.shellDir + "/assets/niri.svg";
                    } else if (CompositorService.isHyprland) {
-                        return "file://" + Theme.shellDir + "/assets/hyprland.svg"
+                        return "file://" + Theme.shellDir + "/assets/hyprland.svg";
                    } else if (CompositorService.isDwl) {
-                        return "file://" + Theme.shellDir + "/assets/mango.png"
+                        return "file://" + Theme.shellDir + "/assets/mango.png";
                    } else if (CompositorService.isSway) {
-                        return "file://" + Theme.shellDir + "/assets/sway.svg"
+                        return "file://" + Theme.shellDir + "/assets/sway.svg";
+                    } else if (CompositorService.isScroll) {
+                        return "file://" + Theme.shellDir + "/assets/sway.svg";
                    } else if (CompositorService.isLabwc) {
-                        return "file://" + Theme.shellDir + "/assets/labwc.png"
+                        return "file://" + Theme.shellDir + "/assets/labwc.png";
                    }
-                    return ""
+                    return "";
                }
                layer.enabled: Theme.effectiveLogoColor !== ""
                layer.effect: MultiEffect {
@@ -82,10 +83,10 @@ BasePill {
                    colorization: 1
                    colorizationColor: Theme.effectiveLogoColor
                    brightness: {
-                        SettingsData.launcherLogoBrightness
+                        SettingsData.launcherLogoBrightness;
                    }
                    contrast: {
-                        SettingsData.launcherLogoContrast
+                        SettingsData.launcherLogoContrast;
                    }
                }
            }
@@ -112,9 +113,9 @@ BasePill {

    onRightClicked: {
        if (CompositorService.isNiri) {
-            NiriService.toggleOverview()
+            NiriService.toggleOverview();
        } else if (root.hyprlandOverviewLoader?.item) {
-            root.hyprlandOverviewLoader.item.overviewOpen = !root.hyprlandOverviewLoader.item.overviewOpen
+            root.hyprlandOverviewLoader.item.overviewOpen = !root.hyprlandOverviewLoader.item.overviewOpen;
        }
    }
 }
--- a/quickshell/Modules/DankBar/Widgets/WorkspaceSwitcher.qml
+++ b/quickshell/Modules/DankBar/Widgets/WorkspaceSwitcher.qml
@@ -23,7 +23,7 @@ Item {
        return CompositorService.filterCurrentWorkspace(CompositorService.sortedToplevels, screenName);
    }

-    readonly property bool useExtWorkspace: DMSService.forceExtWorkspace || (!CompositorService.isNiri && !CompositorService.isHyprland && !CompositorService.isDwl && !CompositorService.isSway && ExtWorkspaceService.extWorkspaceAvailable)
+    readonly property bool useExtWorkspace: DMSService.forceExtWorkspace || (!CompositorService.isNiri && !CompositorService.isHyprland && !CompositorService.isDwl && !CompositorService.isSway && !CompositorService.isScroll && ExtWorkspaceService.extWorkspaceAvailable)

    Connections {
        target: DesktopEntries
@@ -45,6 +45,7 @@ Item {
            const activeTags = getDwlActiveTags();
            return activeTags.length > 0 ? activeTags[0] : -1;
        case "sway":
+        case "scroll":
            return getSwayActiveWorkspace();
        default:
            return 1;
@@ -74,6 +75,7 @@ Item {
            baseList = getDwlTags();
            break;
        case "sway":
+        case "scroll":
            baseList = getSwayWorkspaces();
            break;
        default:
@@ -192,7 +194,7 @@ Item {
                return [];
            }
            targetWorkspaceId = ws.tag;
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            targetWorkspaceId = ws.num !== undefined ? ws.num : ws;
        } else {
            return [];
@@ -204,7 +206,7 @@ Item {
        let isActiveWs = false;
        if (CompositorService.isNiri) {
            isActiveWs = NiriService.allWorkspaces.some(ws => ws.id === targetWorkspaceId && ws.is_active);
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const focusedWs = I3.workspaces?.values?.find(ws => ws.focused === true);
            isActiveWs = focusedWs ? (focusedWs.num === targetWorkspaceId) : false;
        } else if (CompositorService.isDwl) {
@@ -225,7 +227,7 @@ Item {
            let winWs = null;
            if (CompositorService.isNiri) {
                winWs = w.workspace_id;
-            } else if (CompositorService.isSway) {
+            } else if (CompositorService.isSway || CompositorService.isScroll) {
                winWs = w.workspace?.num;
            } else {
                const hyprlandToplevels = Array.from(Hyprland.toplevels?.values || []);
@@ -283,7 +285,7 @@ Item {
            placeholder = {
                "tag": -1
            };
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            placeholder = {
                "num": -1
            };
@@ -453,7 +455,7 @@ Item {
                return ws && ws.id !== -1;
            if (CompositorService.isDwl)
                return ws && ws.tag !== -1;
-            if (CompositorService.isSway)
+            if (CompositorService.isSway || CompositorService.isScroll)
                return ws && ws.num !== -1;
            return ws !== -1;
        });
@@ -521,7 +523,7 @@ Item {
            }

            DwlService.switchToTag(root.screenName, realWorkspaces[nextIndex].tag);
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            const realWorkspaces = getRealWorkspaces();
            if (realWorkspaces.length < 2) {
                return;
@@ -549,7 +551,7 @@ Item {
            isPlaceholder = modelData?.id === -1;
        } else if (CompositorService.isDwl) {
            isPlaceholder = modelData?.tag === -1;
-        } else if (CompositorService.isSway) {
+        } else if (CompositorService.isSway || CompositorService.isScroll) {
            isPlaceholder = modelData?.num === -1;
        } else {
            isPlaceholder = modelData === -1;
@@ -564,12 +566,12 @@ Item {
            return modelData?.id || "";
        if (CompositorService.isDwl)
            return (modelData?.tag !== undefined) ? (modelData.tag + 1) : "";
-        if (CompositorService.isSway)
+        if (CompositorService.isSway || CompositorService.isScroll)
            return modelData?.num || "";
        return modelData - 1;
    }

-    readonly property bool hasNativeWorkspaceSupport: CompositorService.isNiri || CompositorService.isHyprland || CompositorService.isDwl || CompositorService.isSway
+    readonly property bool hasNativeWorkspaceSupport: CompositorService.isNiri || CompositorService.isHyprland || CompositorService.isDwl || CompositorService.isSway || CompositorService.isScroll
    readonly property bool hasWorkspaces: getRealWorkspaces().length > 0
    readonly property bool shouldShow: hasNativeWorkspaceSupport || (useExtWorkspace && hasWorkspaces)

@@ -675,7 +677,7 @@ Item {
                        return !!(modelData && modelData.id === root.currentWorkspace);
                    if (CompositorService.isDwl)
                        return !!(modelData && root.dwlActiveTags.includes(modelData.tag));
-                    if (CompositorService.isSway)
+                    if (CompositorService.isSway || CompositorService.isScroll)
                        return !!(modelData && modelData.num === root.currentWorkspace);
                    return modelData === root.currentWorkspace;
                }
@@ -686,7 +688,7 @@ Item {
                        return !!(modelData && modelData.id === -1);
                    if (CompositorService.isDwl)
                        return !!(modelData && modelData.tag === -1);
-                    if (CompositorService.isSway)
+                    if (CompositorService.isSway || CompositorService.isScroll)
                        return !!(modelData && modelData.num === -1);
                    return modelData === -1;
                }
@@ -703,7 +705,7 @@ Item {
                        return loadedIsUrgent;
                    if (CompositorService.isDwl)
                        return modelData?.state === 2;
-                    if (CompositorService.isSway)
+                    if (CompositorService.isSway || CompositorService.isScroll)
                        return loadedIsUrgent;
                    return false;
                }
@@ -767,7 +769,7 @@ Item {
                                console.log("Calling switchToTag");
                                DwlService.switchToTag(root.screenName, modelData.tag);
                            }
-                        } else if (CompositorService.isSway && modelData?.num) {
+                        } else if ((CompositorService.isSway || CompositorService.isScroll) && modelData?.num) {
                            try {
                                I3.dispatch(`workspace number ${modelData.num}`);
                            } catch (_) {}
@@ -797,7 +799,7 @@ Item {
                            wsData = modelData;
                        } else if (CompositorService.isDwl) {
                            wsData = modelData;
-                        } else if (CompositorService.isSway) {
+                        } else if (CompositorService.isSway || CompositorService.isScroll) {
                            wsData = modelData;
                        }
                        delegateRoot.loadedWorkspaceData = wsData;
@@ -811,7 +813,7 @@ Item {
                        delegateRoot.loadedHasIcon = icData !== null;

                        if (SettingsData.showWorkspaceApps) {
-                            if (CompositorService.isDwl || CompositorService.isSway) {
+                            if (CompositorService.isDwl || CompositorService.isSway || CompositorService.isScroll) {
                                delegateRoot.loadedIcons = root.getWorkspaceIcons(modelData);
                            } else {
                                delegateRoot.loadedIcons = root.getWorkspaceIcons(CompositorService.isHyprland ? modelData : (modelData === -1 ? null : modelData));
@@ -1192,7 +1194,7 @@ Item {
                }
                Connections {
                    target: I3.workspaces
-                    enabled: CompositorService.isSway
+                    enabled: (CompositorService.isSway || CompositorService.isScroll)
                    function onValuesChanged() {
                        delegateRoot.updateAllData();
                    }
--- a/quickshell/Modules/DankDash/Overview/UserInfoCard.qml
+++ b/quickshell/Modules/DankDash/Overview/UserInfoCard.qml
@@ -67,6 +67,8 @@ Card {
                            return "on MangoWC";
                        if (CompositorService.isSway)
                            return "on Sway";
+                        if (CompositorService.isScroll)
+                            return "on Scroll";
                        return "";
                    }
                    font.pixelSize: Theme.fontSizeSmall
--- a/quickshell/Modules/Greetd/assets/dms-greeter
+++ b/quickshell/Modules/Greetd/assets/dms-greeter
@@ -16,7 +16,7 @@ dms-greeter - DankMaterialShell greeter launcher
 Usage: dms-greeter --command COMPOSITOR [OPTIONS]

 Required:
-    --command COMPOSITOR    Compositor to use (niri, hyprland, sway, or mangowc)
+    --command COMPOSITOR    Compositor to use (niri, hyprland, sway, scroll or mangowc)

 Options:
    -C, --config PATH       Custom compositor config file
@@ -30,6 +30,7 @@ Examples:
    dms-greeter --command niri
    dms-greeter --command hyprland -C /etc/greetd/custom-hypr.conf
    dms-greeter --command sway -p /home/user/.config/quickshell/custom-dms
+    dms-greeter --command scroll -p /home/user/.config/quickshell/custom-dms
    dms-greeter --command niri --cache-dir /tmp/dmsgreeter
    dms-greeter --command mangowc
 EOF
@@ -207,6 +208,25 @@ SWAY_EOF
        exec sway -c "$COMPOSITOR_CONFIG"
        ;;

+    scroll)
+        if [[ -z "$COMPOSITOR_CONFIG" ]]; then
+            TEMP_CONFIG=$(mktemp)
+            cat > "$TEMP_CONFIG" << SCROLL_EOF
+exec "$QS_CMD; scrollmsg exit"
+SCROLL_EOF
+            COMPOSITOR_CONFIG="$TEMP_CONFIG"
+        else
+            TEMP_CONFIG=$(mktemp)
+            cat "$COMPOSITOR_CONFIG" > "$TEMP_CONFIG"
+            cat >> "$TEMP_CONFIG" << SCROLL_EOF
+
+exec "$QS_CMD; scrollmsg exit"
+SCROLL_EOF
+            COMPOSITOR_CONFIG="$TEMP_CONFIG"
+        fi
+        exec scroll -c "$COMPOSITOR_CONFIG"
+        ;;
+
    mangowc)
        if [[ -n "$COMPOSITOR_CONFIG" ]]; then
            exec mango -c "$COMPOSITOR_CONFIG" -s "$QS_CMD && mmsg -d quit"
--- a/quickshell/Modules/Settings/AboutTab.qml
+++ b/quickshell/Modules/Settings/AboutTab.qml
@@ -10,6 +10,7 @@ Item {
    property bool isHyprland: CompositorService.isHyprland
    property bool isNiri: CompositorService.isNiri
    property bool isSway: CompositorService.isSway
+    property bool isScroll: CompositorService.isScroll
    property bool isDwl: CompositorService.isDwl
    property bool isLabwc: CompositorService.isLabwc

@@ -18,6 +19,8 @@ Item {
            return "hyprland";
        if (isSway)
            return "sway";
+        if (isScroll)
+            return "scroll";
        if (isDwl)
            return "mangowc";
        if (isLabwc)
@@ -30,6 +33,8 @@ Item {
            return "/assets/hyprland.svg";
        if (isSway)
            return "/assets/sway.svg";
+        if (isScroll)
+            return "/assets/sway.svg";
        if (isDwl)
            return "/assets/mango.png";
        if (isLabwc)
@@ -42,6 +47,8 @@ Item {
            return "https://hypr.land";
        if (isSway)
            return "https://swaywm.org";
+        if (isScroll)
+            return "https://github.com/dawsers/scroll";
        if (isDwl)
            return "https://github.com/DreamMaoMao/mangowc";
        if (isLabwc)
@@ -54,6 +61,8 @@ Item {
            return "Hyprland Website";
        if (isSway)
            return "Sway Website";
+        if (isScroll)
+            return "Scroll Github";
        if (isDwl)
            return "mangowc GitHub";
        if (isLabwc)
@@ -86,9 +95,9 @@ Item {
    property string ircUrl: "https://web.libera.chat/gamja/?channels=#labwc"
    property string ircTooltip: "LabWC IRC Channel"

-    property bool showMatrix: isNiri && !isHyprland && !isSway && !isDwl && !isLabwc
+    property bool showMatrix: isNiri && !isHyprland && !isSway && !isScroll && !isDwl && !isLabwc
    property bool showCompositorDiscord: isHyprland || isDwl
-    property bool showReddit: isNiri && !isHyprland && !isSway && !isDwl && !isLabwc
+    property bool showReddit: isNiri && !isHyprland && !isSway && !isScroll && !isDwl && !isLabwc
    property bool showIrc: isLabwc

    DankFlickable {
--- a/quickshell/Modules/Settings/LauncherTab.qml
+++ b/quickshell/Modules/Settings/LauncherTab.qml
@@ -63,6 +63,8 @@ Item {
                                modes.push("mango");
                            } else if (CompositorService.isSway) {
                                modes.push("Sway");
+                            } else if (CompositorService.isScroll) {
+                                modes.push("Scroll");
                            } else {
                                modes.push(I18n.tr("Compositor"));
                            }