Testing hyprscrolling

This commit is contained in:
2026-02-25 06:44:46 +01:00
parent 4125f23bd1
commit 438899b070
2 changed files with 95 additions and 100 deletions
@@ -0,0 +1,61 @@
# hyprscrolling.conf
# Loaded from: ./assets/conf/desktop/hypr/hyprscrolling.conf
#
# Notes:
# - These are the documented scrolling-layout knobs and defaults.
# - Keep them here; Home-Manager will source this file from ~/.config/hypr/conf.d/.
########################
# Layout selection
########################
general {
layout = scrolling
}
########################
# Scrolling layout config
########################
scrolling {
# when enabled, a single column on a workspace will always span the entire screen.
fullscreen_on_one_column = true
# the default width of a column, [0.1 - 1.0]
column_width = 0.5
# When a column is focused, what method should be used to bring it into view.
# 0 = center, 1 = fit
focus_fit_method = 0
# when a window is focused, should the layout move to bring it into view automatically
follow_focus = true
# when a window is focused, require that at least a given fraction of it is visible
# for focus to follow. Hard input (e.g. binds, clicks) will always follow. [0.0 - 1.0]
follow_min_visible = 0.4
# A comma-separated list of preconfigured widths for colresize +conf/-conf
explicit_column_widths = 0.333, 0.5, 0.667, 1.0
# Direction in which new windows appear and the layout scrolls. left/right/down/up
direction = right
}
########################
# Workspace rules (optional examples)
########################
# workspace = 2, layoutopt:direction:right
########################
# Layout messages (optional examples)
########################
# bind = $mainMod, period, layoutmsg, move +col
# bind = $mainMod, comma, layoutmsg, swapcol l
#
# Available layoutmsg params:
# - move (-200 / +200) or (+col / -col)
# - colresize (0.5 / +0.2 / -0.2 / +conf / -conf / all (number))
# - fit (active / visible / all / toend / tobeg)
# - focus (l/r/u/d) (wraps instead of moving to neighboring monitors)
# - promote (moves a window to its own new column)
# - swapcol (l or r) (wraps around)
# - togglefit (toggles focus_fit_method)
+34 -100
View File
@@ -1,121 +1,55 @@
{ config, lib, pkgs, ... }:
{
config,
lib,
pkgs,
flakeRoot,
...
}:
let
cfg = config.programs.hyprscrolling;
# Render plugin settings into:
# plugin:hyprscrolling {
# key = value
# }
renderValue = v:
if lib.isString v then "\"${v}\""
else if lib.isBool v then (if v then "true" else "false")
else if lib.isInt v || lib.isFloat v then toString v
else if lib.isList v then
"[ " + (lib.concatStringsSep " " (map renderValue v)) + " ]"
else
throw "programs.hyprscrolling.settings: unsupported value type: ${builtins.typeOf v}";
# Read configuration from your repo (as requested)
confSrc = flakeRoot + "/assets/conf/desktop/hypr/hyprscrolling.conf";
renderSettings = settings:
let
lines = lib.mapAttrsToList (k: v: " ${k} = ${renderValue v}") settings;
in
if settings == { } then ""
else ''
plugin:hyprscrolling {
${lib.concatStringsSep "\n" lines}
}
'';
defaultPluginPkg = (pkgs.hyprlandPlugins.hyprscrolling or null);
# Stable paths (avoid pinning /nix/store/... in your hyprland.conf)
stableSoPath = "/etc/hypr/plugins/libhyprscrolling.so";
dropInConfPath = "/etc/hypr/conf.d/90-hyprscrolling.conf";
dropInConf = ''
# Managed by Nix: programs.hyprscrolling
# Load plugin shared object (.so)
plugin = ${stableSoPath}
${lib.optionalString cfg.setAsDefaultLayout ''
general {
layout = scrolling
}
''}
${renderSettings cfg.settings}
${cfg.extraConfig}
'';
# Where we place the generated/symlinked config inside ~/.config
confTarget = "hypr/conf.d/90-hyprscrolling.conf";
in
{
options.programs.hyprscrolling = {
enable = lib.mkEnableOption "Hyprland hyprscrolling (scrolling layout) plugin (NixOS-friendly)";
enable = lib.mkEnableOption "Hyprscrolling plugin (scrolling layout) for Hyprland";
pluginPackage = lib.mkOption {
type = lib.types.nullOr lib.types.package;
default = defaultPluginPkg;
description = ''
Package that provides the hyprscrolling plugin.
Defaults to pkgs.hyprlandPlugins.hyprscrolling when available.
'';
};
setAsDefaultLayout = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Whether to set `general { layout = scrolling }` in the generated drop-in config.";
};
settings = lib.mkOption {
type = lib.types.attrs;
default = { };
description = ''
Attribute set rendered into a `plugin:hyprscrolling { ... }` block
in the generated drop-in config.
'';
};
extraConfig = lib.mkOption {
type = lib.types.lines;
default = "";
description = "Extra Hyprland config appended to the generated drop-in config.";
};
# Where we install the generated config snippet (so you can `source = ...` it)
dropInPath = lib.mkOption {
type = lib.types.str;
default = dropInConfPath;
description = "Path to the generated Hyprland drop-in config file (needs to be sourced by your hyprland.conf).";
};
# Where we install a stable symlink to the plugin .so
stablePluginSoPath = lib.mkOption {
type = lib.types.str;
default = stableSoPath;
description = "Stable path for the plugin shared object (symlinked to the Nix store).";
package = lib.mkOption {
type = lib.types.package;
default = pkgs.hyprlandPlugins.hyprscrolling;
description = "hyprscrolling plugin package to load via wayland.windowManager.hyprland.plugins.";
};
};
config = lib.mkIf cfg.enable {
assertions = [
{
assertion = cfg.pluginPackage != null;
message = ''
Could not find hyprscrolling plugin package in this nixpkgs.
Set programs.hyprscrolling.pluginPackage explicitly (e.g. pkgs.hyprlandPlugins.hyprscrolling).
'';
assertion = config.wayland.windowManager.hyprland.enable or false;
message = "programs.hyprscrolling.enable requires wayland.windowManager.hyprland.enable = true (Home-Manager Hyprland module).";
}
{
assertion = builtins.pathExists confSrc;
message = "Missing hyprscrolling.conf at: ${toString confSrc}";
}
];
# Ensure the plugin is built and available.
environment.systemPackages = [ cfg.pluginPackage ];
# Ensure plugin is installed + loaded (HM will add the needed plugin loading lines)
wayland.windowManager.hyprland.plugins = [
cfg.package
];
# Provide a stable .so path under /etc (no /nix/store hardcoding in hyprland.conf)
environment.etc."hypr/plugins/libhyprscrolling.so".source =
"${cfg.pluginPackage}/lib/libhyprscrolling.so";
# Put your config file into ~/.config/hypr/conf.d/...
xdg.configFile."${confTarget}".source = confSrc;
# Provide a drop-in config file under /etc.
environment.etc."hypr/conf.d/90-hyprscrolling.conf".text = dropInConf;
# Ensure Hyprland reads it (even if your main config doesn't source conf.d)
wayland.windowManager.hyprland.extraConfig = ''
# Loaded by Home-Manager: hyprscrolling
source = ${config.xdg.configHome}/${confTarget}
'';
};
}