Replies: 33 comments 76 replies
-
|
if you wanted to focus on every window that gets the urgent attribute, you could call this script from your config file: local function on_urgent(view, _)
local container = scroll.view_get_container(view)
local workspace = scroll.container_get_workspace(container)
scroll.command(nil, "workspace " .. scroll.workspace_get_name(workspace))
scroll.command(container, "focus")
end
scroll.add_callback("view_urgent", on_urgent, nil)Edit 2025-12-23: With the new API functions this can be simplified to: local function on_urgent(view, _)
local container = scroll.view_get_container(view)
scroll.container_set_focus(container)
end
scroll.add_callback("view_urgent", on_urgent, nil)If the current focused window is a neovim instance, when called, this script resizes neovim's window height to 0.66667, and opens a kitty terminal under it with height 0.33333. When you close the neovim window, the terminal is also automatically closed. local id_map
local id_unmap
local data = {}
local on_create = function (cbview, cbdata)
if scroll.view_get_app_id(cbview) == "kitty" then
cbdata.view = cbview
scroll.command(nil, "set_size v 0.33333333; move left nomode")
end
scroll.remove_callback(id_map)
end
local on_destroy = function (cbview, cbdata)
if scroll.view_get_pid(cbview) == cbdata.pid then
scroll.view_close(cbdata.view)
end
scroll.remove_callback(id_unmap)
end
local view = scroll.focused_view()
data.pid = scroll.view_get_pid(view)
id_map = scroll.add_callback("view_map", on_create, data)
id_unmap = scroll.add_callback("view_unmap", on_destroy, data)
if view then
if string.find(scroll.view_get_title(view), "^nvim") then
scroll.command(nil, 'set_size v 0.66666667; exec kitty')
end
endSelect and move every tiling kitty terminal from the focused workspace to workspace number 2. local workspace = scroll.focused_workspace()
local containers = scroll.workspace_get_tiling(workspace)
for _, container in ipairs(containers) do
local views = scroll.container_get_views(container)
for _, view in ipairs(views) do
local app_id = scroll.view_get_app_id(view)
if app_id == "kitty" then
local con = scroll.view_get_container(view)
scroll.command(con, "selection toggle")
end
end
end
scroll.command(nil, "workspace number 2; selection move") |
Beta Was this translation helpful? Give feedback.
-
|
Another example navigating the containers of a workspace. Toggle a master-type window layout using a key binding local args, state = ...
local function flatten(workspace)
local containers = scroll.workspace_get_tiling(workspace)
if #containers == 0 then
return false
end
local focused = scroll.focused_view()
for _, container in ipairs(containers) do
local views = scroll.container_get_views(container)
if #views > 1 then
for i = #views, 1, -1 do
if i > 1 then
local con = scroll.view_get_container(views[i])
scroll.command(con, "move right nomode")
end
end
end
end
local con_id = scroll.container_get_id(scroll.view_get_container(focused))
scroll.command(nil, "[con_id=" .. con_id .. "] focus")
return true
end
local function create_master(workspace)
-- Save the current configuration
scroll.command(nil, "space save " .. "master_" .. scroll.workspace_get_name(workspace["object"]))
-- Flatten
if flatten(workspace["object"]) == false then
return
end
scroll.command(nil, "move beginning")
-- Now create master layout
local mode = scroll.workspace_get_mode(workspace["object"])
scroll.workspace_set_mode(workspace, { insert = "before" })
local containers = scroll.workspace_get_tiling(workspace["object"])
for i = #containers, 2, -1 do
local container = containers[i]
local views = scroll.container_get_views(container)
for _, view in ipairs(views) do
local con = scroll.view_get_container(view)
scroll.command(con, "set_size h 0.5; move right nomode")
end
end
scroll.command(nil, "focus end; fit_size v all equal")
containers = scroll.workspace_get_tiling(workspace["object"])
local views = scroll.container_get_views(containers[1])
-- master container has only one view
scroll.command(scroll.view_get_container(views[1]), "set_size h 0.5; set_size v 1.0; focus")
scroll.workspace_set_mode(workspace["object"], { insert = mode.insert })
end
local function set_full(full)
if full then
scroll.command(nil, "fullscreen_application enable; fullscreen")
else
scroll.command(nil, "fullscreen_application reset; fullscreen")
end
end
local function master_swap(workspace)
if not workspace["master"] then
return
end
local containers = scroll.workspace_get_tiling(workspace["object"])
if #containers ~= 2 then
return
end
local views = scroll.container_get_views(containers[1])
-- The master container should have one view, if not, return
if #views ~= 1 then
return
end
local container = scroll.view_get_container(views[1])
local id = scroll.container_get_id(container)
scroll.command(nil, "swap container with con_id " .. id)
end
local function create_scrolling(workspace)
local view = scroll.focused_view()
scroll.command(nil, "space load " .. "master_" .. scroll.workspace_get_name(workspace["object"]))
local con_id = scroll.container_get_id(scroll.view_get_container(view))
scroll.command(nil, "[con_id=" .. con_id .. "] focus")
end
-- Set up workspace table
local workspaces = scroll.state_get_value(state, "workspaces")
if workspaces == nil then
scroll.state_set_value(state, "workspaces", {})
workspaces = scroll.state_get_value(state, "workspaces")
end
local focused_workspace = scroll.focused_workspace()
local workspace_name = scroll.workspace_get_name(focused_workspace)
if workspaces[workspace_name] == nil then
local ws = { object = focused_workspace, master = false, full = false }
workspaces[workspace_name] = ws
end
local workspace = workspaces[workspace_name]
if args[1] == 'toggle' then
workspace["master"] = not workspace["master"]
if workspace["master"] then
create_master(workspace)
else
create_scrolling(workspace)
end
elseif args[1] == 'full' then
workspace["full"] = not workspace["full"]
set_full(workspace["full"])
elseif args[1] == 'swap' then
master_swap(workspace)
end |
Beta Was this translation helpful? Give feedback.
-
|
This script is en example implementation of When you start mpv from a kitty terminal, the terminal window will be swallowed to the scratchpad. When you close the mpv window, the terminal will appear again. The script could be added to
local function candidate(view)
local app_id = scroll.view_get_app_id(view)
if app_id == "mpv" then
local pview = scroll.view_get_parent_view(view)
if pview ~= nil and pview ~= view then
local papp_id = scroll.view_get_app_id(pview)
if papp_id == "kitty" then
return scroll.view_get_container(pview)
end
end
end
return nil
end
local function on_create(view, _)
local parent = candidate(view)
if parent ~= nil then
scroll.command(parent, "move scratchpad")
end
end
local function on_destroy(view, _)
local parent = candidate(view)
if parent ~= nil then
scroll.command(nil, "scratchpad show; floating toggle")
end
end
scroll.add_callback("view_map", on_create, nil)
scroll.add_callback("view_unmap", on_destroy, nil)
|
Beta Was this translation helpful? Give feedback.
-
CallbacksSet a callback on The This script can be used as a workspace rule. Every time a workspace is created, you can do things. You can add this to your configuration: local map_id
local function on_create_view(view, _)
local container = scroll.view_get_container(view)
scroll.command(container, "set_size v 0.5")
scroll.remove_callback(map_id)
end
local function on_create_ws(workspace, _)
local name = scroll.workspace_get_name(workspace)
if name == "9" then
map_id = scroll.add_callback("view_map", on_create_view, nil)
scroll.command(workspace, "exec kitty")
end
end
scroll.add_callback("workspace_create", on_create_ws, nil) |
Beta Was this translation helpful? Give feedback.
-
Maximize ToggleThis script can be used to toggle the geometry of a window between its state and a fully maximized one Add a key binding to your configuration, like for example: And save this script to
local args, state = ...
-- Set up views table
local views = scroll.state_get_value(state, "views")
if views == nil then
scroll.state_set_value(state, "views", {})
views = scroll.state_get_value(state, "views")
end
local function find_view(view)
for _, v in ipairs(views) do
if v["object"] == view then
return v
end
end
return nil
end
if args[1] == 'toggle' then
local focused_view = scroll.focused_view()
local view = find_view(focused_view)
if view == nil then
view = {
object = focused_view,
maximized = false,
wf = 0,
hf = 0
}
table.insert(views, view)
end
view["maximized"] = not view["maximized"]
if view["maximized"] then
local container = scroll.view_get_container(focused_view)
view["wf"] = scroll.container_get_width_fraction(container)
view["hf"] = scroll.container_get_height_fraction(container)
scroll.command(nil, "set_size h 1.0")
scroll.command(nil, "set_size v 1.0")
else
scroll.command(nil, "set_size h " .. view["wf"])
scroll.command(nil, "set_size v " .. view["hf"])
end
end |
Beta Was this translation helpful? Give feedback.
-
|
Hi, is there a way to get lsp autocompletions, like we can get via setting the |
Beta Was this translation helpful? Give feedback.
-
|
You should get function auto-completion by simply adding local args, state = ...
local scroll = require("scroll")
-- Now you can write scroll.work and press your auto-completion key binding to get a list of functions in the scroll module that begin with `work`. |
Beta Was this translation helpful? Give feedback.
-
Yeah, this works, but how can I get completions for core api-functions? this only provides auto-completion for functions that are defined inside the file. It's not that viable, if that would be too much work, though. It just would be a nice addition to have so we don't have to read the manpages to know about the api functions. |
Beta Was this translation helpful? Give feedback.
-
|
Yes, sorry, I don't know how to do that. I think you need to use LuaJIT and FFI to be able to have that functionality, but I am using regular Lua. |
Beta Was this translation helpful? Give feedback.
-
Conditionally Centering ContainersThis script centers containers whose width is wider than half of the viewport. Run it from your config so the callback is always active.
local args, state = ...
local scroll = require("scroll")
local width = tonumber(args[1])
if not width then
width = 0.5
end
local function on_focus(view, _)
local workspace = scroll.focused_workspace()
local container = scroll.view_get_container(view)
local parent = scroll.container_get_parent(container)
if parent then
container = parent
end
if scroll.container_get_width_fraction(container) <= width then
scroll.workspace_set_mode(workspace, { center_horizontal = false })
else
scroll.workspace_set_mode(workspace, { center_horizontal = true })
end
end
scroll.add_callback("view_focus", on_focus, nil) |
Beta Was this translation helpful? Give feedback.
-
Yeah, although the api function names are very definitive, I don't know what do they return or in which structure and looking at the large codebase without knowing where to look at scares me. But, thanks for the detailed explanantions, again. |
Beta Was this translation helpful? Give feedback.
-
|
No worries! It is always good to get new ideas, so I can improve the Lua API. I have found the Lua API is helping me find bugs in the core too. I think the script below is more or less what you are used to. |
Beta Was this translation helpful? Give feedback.
-
|
I'm using the 'center.lua' from this thread and I think it is causing some issues with overview/jump mode. 
That's what the overview looks like with two windows and that script called with "0.5" as the argument. Jump view is the same, but also has the jump text cut off on the window on the left. I've noticed some weird overview behavior after using align center/left/right too. I think the alignment is also applying to the overview? Is that intended? |
Beta Was this translation helpful? Give feedback.
-
|
Yes, the script applies also when in overview/jump mode because it doesn't detect it's under those modes. There is currently no Lua API to detect overview mode. Let me add some new Lua API functions, and I will modify the script. Alignments using the default commands don't work in overview mode when not running any script, but a script can do anything it wants, as in Edit: Oh, now I see what you mean, center_horiz/vert are also applying in overview mode, I thought you meant the align command. I will fix that, it makes no sense to center in overview mode. Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
So in the end it was a bug. After ef8d89a those mode modifiers are disabled temporarily while in overview mode, and the script doesn't need any changes. Thanks for noticing this and taking the time to report it. |
Beta Was this translation helpful? Give feedback.
-
|
Let me see if I understood correctly before making changes: You want to center the container only if no other adjacent container fits completely in the viewport. |
Beta Was this translation helpful? Give feedback.
-
Yes, exactly this! |
Beta Was this translation helpful? Give feedback.
-
Niri's
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks this precisely does what I wanted! |
Beta Was this translation helpful? Give feedback.
-
|
Firstly, I want to say thank you for the Lua API! It's really useful, I was able to make scratchpads work in the way I'm used to because of it. Very nice. Just one question, for the maximize script, how would one extend it so that it automatically maximizes windows when there is only one window on a workspace, and un-maximizes it when another window gets created/moved into it? I don't see a way to check how many containers/views are on a given workspace. |
Beta Was this translation helpful? Give feedback.
-
My bad, sorry. And yeah this did the job. Thanks! But, there's still not a robust way to maximize the window after killing all the other windows until it is the only one left. We need to explicitly send focus to that window to automatically maximize it. 2025-07-30.01-04-31.mp4 |
Beta Was this translation helpful? Give feedback.
-
|
So I ended up extending it a bit. This is based off of the above, but with The way it is now, without that last "focus" call, whenever you create i.e. a second window in a workspace, the focus ring will be around the left window, but the keyboard input will be on the right one (I tested with terminals), and I have to manually focus the right one so I can focus the left one. But if I add that focus call at the end, every time I run (in my case) tofi, it will crash scroll. Also, whenever you close the second to last window in a workspace, you have to switch workspaces and switch back to get the last window to maximize. I imagine the third issue could be fixed by messing with local _, state = ...
-- maximized_containers is a list of 'maximized_container' items,
-- which are a list of attributes to restore the maximized containers to.
-- This makes sure it is initalized as a list
scroll.state_set_value(state, "maximized_containers", {})
local maximize_container = function(resize_container)
-- Maximize the top level container; so either the parent if this is the
-- child, or this if it is the top level
local container = scroll.container_get_parent(resize_container) or resize_container
local id = scroll.container_get_id(container)
-- If it's in the list, don't re-maximize a window
local maximized_containers = scroll.state_get_value(state, "maximized_containers")
for _, maximized_container in ipairs(maximized_containers) do
if maximized_container.id == id then
return
end
end
-- Values to restore when unmaximizing it
local wf = scroll.container_get_width_fraction(container)
local hf = scroll.container_get_height_fraction(container)
-- Store the values and maximize
local maximized_container = { container = container, wf = wf, hf = hf, id = id }
table.insert(maximized_containers, maximized_container)
scroll.state_set_value(state, "maximized_containers", maximized_containers)
scroll.command(container, "set_size h 1.0")
scroll.command(container, "set_size v 1.0")
end
local unmaximize_container = function(resize_container)
local maximized_containers = scroll.state_get_value(state, "maximized_containers")
-- As before, unmaximize the top level container; either this, or its parent if it has one
local parent = scroll.container_get_parent(resize_container)
local container = parent or resize_container
local id = scroll.container_get_id(container)
-- Remove all instances of id in the maximized_containers list
for i, maximized_container in ipairs(maximized_containers) do
if maximized_container.id == id then
scroll.command(maximized_container.container, "set_size h " .. maximized_container.wf)
scroll.command(maximized_container.container, "set_size v " .. maximized_container.hf)
table.remove(maximized_containers, i)
end
end
-- Then store the value with the unmaximized container removed
scroll.state_set_value(state, "maximized_containers", maximized_containers)
end
-- AFAIK, this runs every time the focus changes
local on_focus = function(cbview, _)
local maximized_containers = scroll.state_get_value(state, "maximized_containers")
-- Get all the tiled containers on the same workspace as cbview
local container = scroll.view_get_container(cbview)
local parent = scroll.container_get_parent() or container
local workspace = scroll.container_get_workspace(container)
local containers_on_workspace = scroll.workspace_get_tiling(workspace)
-- If there aren't any containers (I believe this would be focusing an empty
-- workspace), do nothing
if not parent or #containers_on_workspace < 1 then
return
end
-- If there is only one container on the workspace, maximize it
if #containers_on_workspace == 1 then
maximize_container(parent)
else
-- Otherwise, unmaximize each container on the workspace
for _, con in ipairs(containers_on_workspace) do
unmaximize_container(con)
end
end
-- Send focus to callback's container
--scroll.command(container, "focus")
end
scroll.add_callback("view_focus", on_focus, nil) |
Beta Was this translation helpful? Give feedback.
-
yeah, the crash is justified, as it will try to focus in that direction non-deterministically for indefinite number of times as the focus would then get send recursively. You can get around this by doing something akin to what I did in my script below (use
The problem with I modified my above code to get work around first two of your problems, and ended up with this: local args, state = ...
local maximized_containers = scroll.state_get_value(state, "maximized_containers") or {}
local debug_notify = function(msg)
scroll.command(nil, "exec notify-send " .. msg)
end
local maximize_container = function(container, workspace)
local wf = scroll.container_get_width_fraction(container)
local hf = scroll.container_get_height_fraction(container)
maximized_containers[workspace] = { container = container, wf = wf, hf = hf, workspace = workspace }
scroll.state_set_value(state, "maximized_containers", maximized_containers)
scroll.command(container, "set_size h 1.0")
scroll.command(container, "set_size v 1.0")
end
local maximize_when_only = function()
local focused_workspace = scroll.focused_workspace()
local containers = scroll.workspace_get_tiling(focused_workspace)
local focused_container = scroll.focused_container()
local maximized_container = maximized_containers[focused_workspace]
if #containers == 1 then
if not maximized_container or (maximized_container and maximized_container.container ~= focused_container) then
-- debug_notify("Maximizing")
maximize_container(focused_container, focused_workspace)
end
elseif #containers > 1 and maximized_container then
-- debug_notify("Shrinking")
scroll.command(maximized_container.container, "set_size h " .. maximized_container.wf)
scroll.command(maximized_container.container, "set_size v " .. maximized_container.hf)
maximized_containers[focused_workspace] = nil
scroll.state_set_value(state, "maximized_containers", maximized_containers)
end
scroll.command(focused_container, "nop")
end
scroll.add_callback("view_focus", maximize_when_only, nil)
|
Beta Was this translation helpful? Give feedback.
-
|
Starting with 9e0cf89 there is a new command: From the manual: So you can use I think with these two new features, you will be able to achieve what you wanted without any scripts. The |
Beta Was this translation helpful? Give feedback.
-
|
This is so awesome, Thanks!! |
Beta Was this translation helpful? Give feedback.
-
|
The Lua API is really great! I had one thought for something that might get included in future revisions. I was trying to implement a script to replicate the way niri cycles size. In niri, there is one cycle size command that increases width or height until the maximum size specified by the user; on the next invocation, the size cycles back to the smallest size specified. I have a script that does this, but it's very hacky because, as far as I can tell, there's no way to access things like In any case, scroll is fantastic and I'm really enjoying using it. Thank you for all your work on this! |
Beta Was this translation helpful? Give feedback.
-
|
I have just added a It used to be the way it worked in hyprscroller, but people seemed to prefer the current way. It is simple to implement and if Niri works that way, I understand some people may want this option. |
Beta Was this translation helpful? Give feedback.
-
|
That's fantastic! Thanks. |
Beta Was this translation helpful? Give feedback.
-
Automatic Align to Center (#119 )Centers columns except when they are the first or last. local args, state = ...
local scroll = require("scroll")
local function on_focus(view, _)
local workspace = scroll.focused_workspace()
local container = scroll.view_get_container(view)
local parent = scroll.container_get_parent(container)
if parent then
container = parent
end
local containers = scroll.workspace_get_tiling(workspace)
for i, con in ipairs(containers) do
if con == container then
if i == 1 or i == #containers then
scroll.workspace_set_mode(workspace, { center_horizontal = false })
else
scroll.workspace_set_mode(workspace, { center_horizontal = true })
end
return
end
end
end
local data = scroll.state_get_value(state, "data")
if data == nil then
scroll.state_set_value(state, "data", { false, 0 })
data = scroll.state_get_value(state, "data")
end
if args[1] == 'toggle' then
data[1] = not data[1]
if data[1] then
local id = scroll.add_callback("view_focus", on_focus, nil)
scroll.state_set_value(state, "data", { true, id })
else
scroll.remove_callback(data[2])
scroll.state_set_value(state, "data", { false, 0 })
end
end |
Beta Was this translation helpful? Give feedback.
-
|
Trivially move a window to an output of a specific split-workspace position. If it is not split, it will split according to what split command you provide for arguments. -- Trivially move a window to an output at a specific split-workspace location
--
-- Use as follows:
-- bindsym <binding> lua to_out_split_pos.lua <target_output> <target_position> <split_command>
--
-- Example:
-- bindsym $mod+Alt+f lua $lua_scripts/to_out_split_pos.lua HDMI-A-1 top workspace split h 0.5
local args, state = ...
local scroll = require("scroll")
local to_output = args[1]
local to_split_pos = args[2]
local split_cmd = table.concat(args, " ", 3)
-- Find the monitor via provided monitor name
local outs = scroll.root_get_outputs()
local secondary
for _, out in ipairs(outs) do
if scroll.output_get_name(out) == to_output then
secondary = out
break
end
end
if not secondary then
scroll.log("Could not find secondary monitor.")
return
end
-- Prepare the move
local this = scroll.focused_container()
local target = scroll.output_get_active_workspace(secondary)
local target_name = scroll.workspace_get_name(target)
-- Get and ensure split
local target_split = scroll.workspace_get_split(target)
local split_pos = target_split['split']
if split_pos == "none" then
scroll.command(target, split_cmd)
end
-- Ensure the correct split position
if target_split['split'] ~= to_split_pos then
-- Not on the correct side, go to the other side
target = target_split['sibling']
target_split = scroll.workspace_get_split(target)
if target_split['split'] ~= to_split_pos then
-- User did the wrong split i.e. split v but request top or bottom
return
end
end
target_name = scroll.workspace_get_name(target)
scroll.command(this, 'move window to workspace ' .. target_name)
scroll.command(nil, 'workspace ' .. target_name)My workflow has a primary workspace on my primary monitor, and a secondary and sub-secondary workspace on my secondary monitor. I use this to quickly pin a window to my sub-secondary workspace. |
Beta Was this translation helpful? Give feedback.
-
|
Something odd I discovered when writing this script is that when doing So my primary output is layout horizontal. If I have a column of windows and I have a window focused on that column, if I do addition - I also noticed that there is an |
Beta Was this translation helpful? Give feedback.
-
|
While usingscroll, when you call In Lua, you can apply a command to a workspace, container, or the default context (using Edit: Basically, if you look at the |
Beta Was this translation helpful? Give feedback.
-
This is already solved. I am not going to implement a special full screen mode for split workspaces, as explained here.
|
Beta Was this translation helpful? Give feedback.
-
|
I will just look directly at the code when I have time to see what can be done for this very specific feature that doesn't overcomplicate things. Feel free to do w/e with it if I proceed down this route. For the time being, I'm in the process of writing a lua script to achieve this feature. Is there like an event that I can hook into to add a callback for when a window enters or leaves fullscreen? With it, I would be able to hook into when an application natively goes fullscreen rather than the user use a keybind. I currently have two ideas in mind.
The former I think would work better and more elegantly allow multiple fullscreen windows while the latter might only be good for one at a time. Also, instead of bringing the window to a new workspace, I noticed I could just float a window and have it take up my entire output, so that's an option for me to play around with. It's essentially a mock "fullscreen output", but would have to be careful on what layer of focus you are on (floating or tiling). |
Beta Was this translation helpful? Give feedback.
-
No, because on the different full screen modes and focusing/unfocusing turning on/off full screen. Your best bet is to set a |
Beta Was this translation helpful? Give feedback.
-
|
Is there a way to get the cursor position via the Lua API currently? From my understanding in wayland the compositor needs to expose it, and I don't believe sway does so. I've seen that hyprctl has such a feature, for example. More specifically, I would like to implement an auto hide feature for my waybar. I already know I can bind it to a keybind to toggle it. Or use the 'scrollmsg bar mode toggle' command. Maybe more generally something like a hot-corner feature might be interesting, like Waycorner. Maybe monitoring zones and then have a callback whenever the cursor exits/leaves it? |
Beta Was this translation helpful? Give feedback.
-
|
The compositor sends the pointer position to applications, otherwise they wouldn't be able to function, as they need to render their content depending on what the user is doing. For that, they need to know how the user is interacting with it. An auto-hide feature is something that should be implemented in the bar code. The compositor sends the bar (or any appplication) enter/exit messages, so they know when the pointer is active on them. This is much more effective than every application having to poll for pointer position all the time (they get it when it affects them). When the pointer enters or exits the application surface, then the bar can decide to show or hide itself, and when hiding, decide whether to un-reserve its space to let windows use the new space, or simply keep the same size to avoid problems with windows resizing all the time. I don't know whether waybar implements this correctly or not. But there are other bars, like dankmaterialshell which have an auto-hide feature that works well with scroll. The problem with adding a pointer position callback to Lua, so it can be accessed externally by users, is there are many, many events of this type per second, so a slight misuse can turn the system unusable. Edit: I think a hot-corner thing should be its own application, like the Waycorner you describe, To implement that in the compositor would need a lot of flexibility from the Lua API. You would want to create layer shell surfaces (to be able to use it) etc. And that is something that shouldn't be part of the compositor, it should be a separate app that uses the compositor for display. There are frameworks like quickshell which allow you to prototype these things quickly. |
Beta Was this translation helpful? Give feedback.
-
|
hi, I have a question: |
Beta Was this translation helpful? Give feedback.
-
|
If the Lua API supports the event, it will be better to use it; you remove overhead, and have more flexibility. If the event is not supported, you can still use scripts around IPC events. |
Beta Was this translation helpful? Give feedback.
-
|
Simple MRU alt-tab script allowing focus change between the most-recently used windows. Transparently handles intermediate window closing; that is, opening a non-layer, transient window (e.g. a floating application launcher) will still let you alt-tab to the prior window. Code quality is probably not the most ideal, but it works for my usecase: local args, state = ...
local scroll = require("scroll")
local function value_idx(tab, val)
for index, value in ipairs(tab) do
if value == val then
return index
end
end
return -1
end
local function on_focus(view, _)
local view_container = scroll.view_get_container(view)
local con_id = scroll.container_get_id(view_container)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
focus_list = {}
end
local focus_idx = value_idx(focus_list, con_id)
if focus_idx > 0 then
table.remove(focus_list, focus_idx)
end
table.insert(focus_list, 1, con_id)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function on_destroy(view, _)
local view_container = scroll.view_get_container(view)
local con_id = scroll.container_get_id(view_container)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
return
end
local focus_idx = value_idx(focus_list, con_id)
if focus_idx == -1 then
return
end
table.remove(focus_list, focus_idx)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function switch_to_prev()
local focus_list = scroll.state_get_value(state, "focus_list")
if #focus_list < 2 then
return
end
local prev = focus_list[2]
scroll.command(nil, string.format("[con_id=%d] focus", prev))
end
if args[1] == "init" then
scroll.add_callback("view_focus", on_focus, nil)
scroll.add_callback("view_unmap", on_destroy, nil)
elseif args[1] == "prev" then
switch_to_prev()
endAdd the following to your Note that I'm positive the Lua API could be used to create a fully-featured MRU switcher akin to Windows without the thumbnail previews, but I'm not sure if it's possible to track the period where |
Beta Was this translation helpful? Give feedback.
-
Even though |
Beta Was this translation helpful? Give feedback.
-
Ah, I understand. That's definitely surprising behavior to me, as I had assumed that focus was not implicit as part of
With respect to my assumptions above, I'd personally prefer something like option 2 because that feels less surprising to me. Setting proper focus on any Either way, I can work around this via
Yeah, that makes sense. I figured it was something like that, I just didn't spend more time on the view/container-based solution (e.g. keeping |
Beta Was this translation helpful? Give feedback.
-
Totally valid argument (and I agree in principle, hence why I didn't feel the need for anything more than back-and-forth switching). Full alt-tab is quite inefficient, and Scroll already provides all the tools out-of-box to handle deeper MRU switching. Truthfully, I'm a recent convert to Linux and tiling/scrolling compositors as a whole, so I'm still learning how to best optimize my usage of them. I suppose my usage of On the other hand, alt-tab fulfills a tangential purpose to me in that sometimes I just want to toggle back to the previously used window without thinking too hard. This script does that for me (thanks for introducing a well-thought out API!), so I have everything I need to quickly switch between windows. |
Beta Was this translation helpful? Give feedback.
-
I agree, so starting from 5f7c923 there is now local args, state = ...
local scroll = require("scroll")
local function value_idx(tab, val)
for index, value in ipairs(tab) do
if value == val then
return index
end
end
return -1
end
local function on_focus(view, _)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
focus_list = {}
end
local focus_idx = value_idx(focus_list, view)
if focus_idx > 0 then
table.remove(focus_list, focus_idx)
end
table.insert(focus_list, 1, view)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function on_destroy(view, _)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
return
end
local focus_idx = value_idx(focus_list, view)
if focus_idx == -1 then
return
end
table.remove(focus_list, focus_idx)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function switch_to_prev()
local focus_list = scroll.state_get_value(state, "focus_list")
if #focus_list < 2 then
return
end
local prev = focus_list[2]
local container = scroll.view_get_container(prev)
scroll.container_set_focus(container)
end
if args[1] == "init" then
scroll.add_callback("view_focus", on_focus, nil)
scroll.add_callback("view_unmap", on_destroy, nil)
elseif args[1] == "prev" then
switch_to_prev()
end |
Beta Was this translation helpful? Give feedback.
-
Of course! I understand people are used to their own workflow, and I am not criticizing that, but I have to adopt a role here trying to teach/show how things could be done in scroll, so people can take those other possibilities into account and decide what suits them best. scroll has maybe too many options, and most people want something that simply works in a certain way, so reading and going through all the manual and options probably consumes too much time. That is why I usually take the opportunity in situations like these to propose a different way of doing things, so maybe someone who hasn't noticed it, thinks it is something that fits their workflow well. |
Beta Was this translation helpful? Give feedback.
-
Expand Column to Available Width (#169)Get the active column to exactly take the remaining width left by any others in the workspace if their widths add to less than the total output width: expand-column-to-available-width.lua local scroll = require("scroll")
local focused = scroll.focused_container()
local parent = scroll.container_get_parent(focused)
if parent == nil then
parent = focused
end
local workspace = scroll.focused_workspace()
local containers = scroll.workspace_get_tiling(workspace)
local total = 0.0
for _, container in ipairs(containers) do
if container ~= parent then
total = total + scroll.container_get_width_fraction(container)
end
end
if total < 1.0 then
local fraction = 1.0 - total
scroll.command(focused, "set_size h " .. fraction)
end |
Beta Was this translation helpful? Give feedback.
-
|
Hello, thank you for the project! I encountered a situation that I don't understand. There are two Lua scripts, both of which register callback functions. The first script is from #48 (comment) for focusing on urgent containers. The second script is for linking two containers, something like trailmark, for easier navigation between them. So, while the second script seems to work, the first one, which focuses on urgent containers, does not. More precisely, it starts working when you run it manually via scrollmsg. scrollmsg lua ./config/scroll/scripts/urgent_focus.lua |
Beta Was this translation helpful? Give feedback.
-
local args, state = ...
local function focus_view(view)
if view == nil or not scroll.view_mapped(view) then
return false
end
local container = scroll.view_get_container(view)
local workspace = scroll.container_get_workspace(container)
if workspace ~= nil then
scroll.command(nil, "workspace " .. scroll.workspace_get_name(workspace))
end
scroll.command(container, "focus")
return true
end
if scroll.state_get_value(state, "inited") ~= true then
scroll.state_set_value(state, "inited", true)
local function on_focus(view, state)
if scroll.state_get_value(state, "suspend_focus_track") == true then
return
end
local current = scroll.state_get_value(state, "cur")
if view ~= nil and current ~= view then
if current ~= nil then
scroll.state_set_value(state, "prev", current)
end
scroll.state_set_value(state, "cur", view)
end
end
local id = scroll.add_callback("view_focus", on_focus, state)
scroll.state_set_value(state, "focus_cb_id", id)
end
local cmd = args[1] or ""
if cmd ~= "toggle_prev" then
return
end
local current = scroll.state_get_value(state, "cur")
local preview = scroll.state_get_value(state, "prev")
if preview == nil or not scroll.view_mapped(preview) then
scroll.command(nil, "focus back_and_forth")
return
end
scroll.state_set_value(state, "suspend_focus_track", true)
if focus_view(preview) then
scroll.state_set_value(state, "cur", preview)
scroll.state_set_value(state, "prev", current)
end
scroll.state_set_value(state, "suspend_focus_track", false)This solution was proposed by AI. I used to use Swayr for this task, but Swayr does not support “vertical” and “horizontal” layouts. But to be honest, I like the API better. In config: |
Beta Was this translation helpful? Give feedback.
-
|
Are you trying to do something like this? It is an "Alt+Tab" script, where pressing the key binding moves between the current and the previously focused window. If you are, this script works. |
Beta Was this translation helpful? Give feedback.
-
|
I apologize for my inattention, but for some reason nothing is working for me. I moved the initialization to the very end: But now, even when I run the script As for the second script, I get an error: scrollmsg lua .config/scroll/scripts/track_last_focus.lua prev
Error: Error 2 executing lua script .config/scroll/scripts/track_last_focus.luaBut thank you for your help, I'll figure it out further. |
Beta Was this translation helpful? Give feedback.
-
|
Please, try the scripts I pointed to for
local function on_urgent(view, _)
local container = scroll.view_get_container(view)
scroll.container_set_focus(container)
end
scroll.add_callback("view_urgent", on_urgent, nil)
local args, state = ...
local scroll = require("scroll")
local function value_idx(tab, val)
for index, value in ipairs(tab) do
if value == val then
return index
end
end
return -1
end
local function on_focus(view, _)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
focus_list = {}
end
local focus_idx = value_idx(focus_list, view)
if focus_idx > 0 then
table.remove(focus_list, focus_idx)
end
table.insert(focus_list, 1, view)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function on_destroy(view, _)
local focus_list = scroll.state_get_value(state, "focus_list")
if focus_list == nil then
return
end
local focus_idx = value_idx(focus_list, view)
if focus_idx == -1 then
return
end
table.remove(focus_list, focus_idx)
scroll.state_set_value(state, "focus_list", focus_list)
end
local function switch_to_prev()
local focus_list = scroll.state_get_value(state, "focus_list")
if #focus_list < 2 then
return
end
local prev = focus_list[2]
local container = scroll.view_get_container(prev)
scroll.container_set_focus(container)
end
if args[1] == "init" then
scroll.add_callback("view_focus", on_focus, nil)
scroll.add_callback("view_unmap", on_destroy, nil)
elseif args[1] == "prev" then
switch_to_prev()
endYou can also replace the |
Beta Was this translation helpful? Give feedback.
-
|
Thank you very much, @dawsers! I used the stable version instead of git development. Now everything works. |
Beta Was this translation helpful? Give feedback.
-
|
Hello, thank you for the project! |
Beta Was this translation helpful? Give feedback.
-
|
I’ve improved the logic so it can now manage workspaces independently. Each workspace can have its own column limit, and the script only runs for the specific workspaces where it's enabled. local args, state = ...
local scroll = require("scroll")
local column_limit = tonumber(args[2]) or 3
local grid = scroll.state_get_value(state, "grid_state")
if grid == nil then
scroll.state_set_value(state, "grid_state", {
map_id = nil,
active_workspaces = {}
})
grid = scroll.state_get_value(state, "grid_state")
end
local function on_create_view(view, _)
local workspace = scroll.focused_workspace()
if not workspace then return end
local focused_view = scroll.focused_view()
local tiling = scroll.workspace_get_tiling(workspace)
local current_ws_name =scroll.workspace_get_name(workspace)
if not grid["active_workspaces"] or not grid["active_workspaces"][current_ws_name] then
return
end
if #tiling <= 1 then return end
local container = scroll.view_get_container(view)
local target_tiling = nil
for i = 1, #tiling - 1,1 do
local prev_container = tiling[i]
local children = scroll.container_get_children(prev_container)
if children and #children < grid["active_workspaces"][current_ws_name] then
target_tiling = i
break
end
end
if target_tiling then
local steps = 0
steps = (#tiling - target_tiling - 1) * 2 + 1 --1,3,5,7
for i=1,steps,1 do
scroll.command(container, "move left nomode")
end
end
if focused_view then
local focused_con = scroll.view_get_container(focused_view)
scroll.container_set_focus(focused_con)
end
end
if args[1] == 'toggle' then
local workspace = scroll.focused_workspace()
if not workspace then return end
local ws_name = scroll.workspace_get_name(workspace)
if grid["active_workspaces"][ws_name] then
grid["active_workspaces"][ws_name] = nil
scroll.workspace_set_mode(workspace, { insert = "after", focus = true })
print("Grid Mode: DISABLED for Workspace [" .. ws_name .. "]")
else
grid["active_workspaces"][ws_name] = column_limit
scroll.workspace_set_mode(workspace, { insert = "end", focus = true })
print("Grid Mode: ENABLED for Workspace [" .. ws_name .. "]")
end
if not grid["map_id"] then
grid["map_id"] = scroll.add_callback("view_map", on_create_view, nil)
end
end |
Beta Was this translation helpful? Give feedback.
-
|
Default width and height are either global or per monitor. If you want per workspace, you need to generate that rule dynamically in the script. In your script, you will know the grid size for each workspace, for example workspace 6 is 3 columns by 2 rows, so you could apply -- Test for workspace name
if scroll.workspace_get_name(workspace) == "6" then
-- Apply size command
scroll.command(container, "set_size h " .. (1.0 / grid_columns))
scroll.command(container, "set_size v " .. (1.0 / grid_rows))
endYou could have an Then |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for your guidance! I have successfully integrated the window adjustment logic into the script. local args, state = ...
local scroll = require("scroll")
local column_limit = tonumber(args[2]) or 3
local fit_size = tonumber(args[3]) or 0
local grid_rows = tonumber(args[4]) or column_limit
local grid_columns = tonumber(args[5]) or grid_rows
local grid = scroll.state_get_value(state, "grid_state")
if grid == nil then
scroll.state_set_value(state, "grid_state", {
map_id = nil,
active_workspaces = {},
})
grid = scroll.state_get_value(state, "grid_state")
end
local function on_create_view(view, _)
local workspace = scroll.focused_workspace()
if not workspace then return end
local tiling = scroll.workspace_get_tiling(workspace)
local current_ws_name = scroll.workspace_get_name(workspace)
local focused_view = scroll.focused_view()
-- Check if Grid Mode is active for this workspace
local ws_config = grid["active_workspaces"][current_ws_name]
if not ws_config then return end
local container = scroll.view_get_container(view)
if #tiling > 1 then
local target_tiling = nil
-- Iterate through existing columns to find a gap based on column_limit
for i = 1, #tiling - 1 do
local prev_container = tiling[i]
local children = scroll.container_get_children(prev_container)
if children and #children < ws_config[1] then
target_tiling = i
break
end
end
if target_tiling then
local steps = (#tiling - target_tiling - 1) * 2 + 1
for i = 1, steps do
scroll.command(container, "move left nomode")
end
end
end
if ws_config[4] == 1 then
scroll.command(container, "set_size h " .. (1 / ws_config[3]))
scroll.command(container, "set_size v " .. (1 / ws_config[2]))
end
if focused_view then
local focused_con = scroll.view_get_container(focused_view)
scroll.container_set_focus(focused_con)
end
end
local workspace = scroll.focused_workspace()
if not workspace then
return
end
local ws_name = scroll.workspace_get_name(workspace)
local function ensure_callback()
if not grid["map_id"] then
grid["map_id"] = scroll.add_callback("view_map", on_create_view, nil)
end
end
local debug_notify = function(msg)
scroll.command(nil, 'exec notify-send "' .. msg .. '"')
end
if args[1] == "toggle" then
if grid["active_workspaces"][ws_name] then
grid["active_workspaces"][ws_name] = nil
scroll.workspace_set_mode(workspace, { insert = "after", focus = true })
debug_notify("Grid Mode: DISABLED for [" .. ws_name .. "]")
else
grid["active_workspaces"][ws_name] = { column_limit, grid_rows, grid_columns, fit_size }
scroll.workspace_set_mode(workspace, { insert = "end", focus = true })
debug_notify(string.format("Grid Mode: ENABLED for %s (Lim:%d, H:%d, V:%d)", ws_name, column_limit, grid_rows, grid_columns))
ensure_callback()
end
elseif args[1] == "disable" then
grid["active_workspaces"][ws_name] = nil
scroll.workspace_set_mode(workspace, { insert = "after", focus = true })
debug_notify("Grid Mode: DISABLED for [" .. ws_name .. "]")
elseif args[1] == "enable" then
grid["active_workspaces"][ws_name] = { column_limit, grid_rows, grid_columns, fit_size }
scroll.workspace_set_mode(workspace, { insert = "end", focus = true })
debug_notify(string.format("Grid Mode: ENABLED for %s (Lim:%d, H:%d, V:%d)", ws_name, column_limit, grid_rows, grid_columns))
ensure_callback()
endI'm very sorry, I previously swapped the definitions of 'row' and 'column' in my logic. |
Beta Was this translation helpful? Give feedback.
-
|
That's great, I am glad you could implement something that fits your workflow! |
Beta Was this translation helpful? Give feedback.
-
|
Added an auto-cleanup function, maybe someone will find it useful. local function on_destroy(view, _)
local workspace = scroll.focused_workspace()
if not workspace then return end
local ws_name = scroll.workspace_get_name(workspace)
local tiling = scroll.workspace_get_tiling(workspace)
if not grid["active_workspaces"][ws_name] then return end
local children = scroll.container_get_children(tiling[1])
if #tiling==1 and #children == 1 then
grid["active_workspaces"][ws_name] = nil
scroll.workspace_set_mode(workspace, { insert = "after", focus = true })
end
end
.......
local function ensure_callback()
if not grid["map_id"] then
grid["map_id"] = scroll.add_callback("view_map", on_create_view, nil)
end
if not grid["unmap_id"] then
grid["unmap_id"] = scroll.add_callback("view_unmap", on_destroy, nil)
end
end |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the work. I have just stumbled upon this yesterday, and it's great. Also is there a way to replicate hyprland's exec command, which starts a process and opens the window on a particular workspace. exec, [workspace 2 silent] kitty |
Beta Was this translation helpful? Give feedback.
-
|
I will investigate how those add-ons work and see if I can do something. scroll (and sway) include the If you want something more complicated, then the Lua API is the way to go. See this script for a template of workspace rules. |
Beta Was this translation helpful? Give feedback.
-
|
There is now a module definition file for LSP auto-completion and documentation. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks, I have been spoilt by lsp. And going back to old way of looking at manual and no completion felt wierd. :) |
Beta Was this translation helpful? Give feedback.
-
|
I wanted to focus a given workspace on current monitor. Like hyprland's |
Beta Was this translation helpful? Give feedback.
-
|
Ah... Yes thank you. |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
That was just an example, the So... |
Beta Was this translation helpful? Give feedback.
-
Not really. :) |
Beta Was this translation helpful? Give feedback.
-
|
Ok, true. Then you will need to write the script, or use the name of the monitor, like I mentioned: |
Beta Was this translation helpful? Give feedback.
-
|
I am trying to implement focusing on an existing view, and I thought of doing the following:
And here it is not entirely clear what to do next. I thought about going through the array obtained in step 2, but in this case, it is not possible to get the array of views for a specific workspace or the array of containers. I also thought about simply executing a command such as 00:05:31.099 [sway/criteria.c:851] Found pair: app_id=‘vifm’
00:05:31.099 [sway/commands.c:302] Handling command ‘focus’But local result = scroll.command(nil, “[app_id=‘vifm’] focus”) |
Beta Was this translation helpful? Give feedback.
-
|
You can loop over root like this: local scroll = require("scroll")
local function set_focus(containers)
for _, container in ipairs(containers) do
local views = scroll.container_get_views(container)
for _, view in ipairs(views) do
if scroll.view_get_app_id(view) == "vifm" then
local con = scroll.view_get_container(view)
if con ~= nil then
scroll.container_set_focus(con)
return true
end
end
end
end
return false
end
local outputs = scroll.root_get_outputs()
for _, output in ipairs(outputs) do
local workspaces = scroll.output_get_workspaces(output)
for _, ws in ipairs(workspaces) do
local tiling = scroll.workspace_get_tiling(ws)
if set_focus(tiling) then
return
end
local floating = scroll.workspace_get_floating(ws)
if set_focus(floating) then
return
end
end
endYou can add |
Beta Was this translation helpful? Give feedback.
-
|
Thank you very much, @dawsers! This is how it turned out, maybe someone will find it useful. local scroll = require("scroll")
local args, state = ...
local appId = args[1]
local fallbackCmd = table.concat(args, " ", 2)
local currentWorkspace = scroll.focused_workspace()
local currentOutput = scroll.workspace_get_output(currentWorkspace)
local outputWorkspaces = scroll.output_get_workspaces(currentOutput)
for _, workspace in ipairs(outputWorkspaces) do
local workspaceContainers = scroll.workspace_get_tiling(workspace)
for _, container in ipairs(workspaceContainers) do
local containerViews = scroll.container_get_views(container)
for _, view in ipairs(containerViews) do
if scroll.view_get_app_id(view) == appId then
local viewContainer = scroll.view_get_container(view)
if viewContainer ~= nil then
scroll.container_set_focus(viewContainer)
return
end
end
end
end
end
scroll.command(nil, fallbackCmd)scrollmsg lua ~/.config/scroll/scripts/launch_app.lua firefox exec firefox |
Beta Was this translation helpful? Give feedback.
-
Sending Data from Your Scripts to the World Through IPCThere is a new Lua API function, You can subscribe to the "lua" event and receive data sent by Lua scripts. For example: local scroll = require("scroll")
local table = {
workspace = "2",
scroll = true,
num = 123,
{
x = 1200, y = 800,
},
{ "dog", "cat", "horse" },
}
scroll.ipc_send("test", table)Subscribe to the event: scrollmsg -t subscribe "[ \"lua\" ]"and call the script: scrollmsg lua /home/xxxx/.config/scroll/scripts/ipc.luaYou will see: {
"id": "test",
"data": {
"1": {
"x": 1200,
"y": 800
},
"2": [
"dog",
"cat",
"horse"
],
"workspace": "2",
"num": 123,
"scroll": true
}
}You can use this to export any type of information to your bar or external scrips |
Beta Was this translation helpful? Give feedback.
-
|
I am trying to implement a view count in the workspace. local args, state = ...
ViewsTable = { viewsCount = 0 }
local function countViewsInContainer(workspaceContainers)
for _, container in ipairs(workspaceContainers) do
local containerViews = scroll.container_get_views(container)
ViewsTable.viewsCount = #containerViews + ViewsTable.viewsCount
end
end
local function countViewsOnFocus(view, _)
ViewsTable.viewsCount = 0
local viewConainter = scroll.view_get_container(view)
local viewWorkspace = scroll.container_get_workspace(viewConainter)
local workspaceContainers = scroll.workspace_get_tiling(viewWorkspace)
countViewsInContainer(workspaceContainers)
scroll.ipc_send("views", ViewsTable)
end
local function countViewsOnDestroy(view, _)
ViewsTable.viewsCount = 0
local viewWorkspace = scroll.focused_workspace()
local workspaceContainers = scroll.workspace_get_tiling(viewWorkspace)
countViewsInContainer(workspaceContainers)
scroll.ipc_send("views", ViewsTable)
end
scroll.add_callback("view_focus", countViewsOnFocus, nil)
scroll.add_callback("view_unmap", countViewsOnDestroy, nil)Everything works, but when the window is closed, the recalculation does not occur. Could you please help me figure this out? |
Beta Was this translation helpful? Give feedback.
-
|
That is because "view_unmap" is called right before the view is destroyed, otherwise you wouldn't be able to access it and use its data. I could have added a callback after the view is destroyed and removed from its container, but then it would be very hard to do anything with it (and the view pointer would be invalid). For example, you wouldn't know what workspace it belonged to, etc. So you just need to count the views for the active workspace, like you are doing, and if the view that is being unmapped is one of them, don't count it. I see there may be a potential problem to do what you want to do. When calling the "view_unmap" callback, the view and its container still exist, as it should, but, then there is a change of focus (when the container gets deleted), so scroll calls the "view_focus" callback...but the view is still mapped. Let me try to figure out a solution for this. |
Beta Was this translation helpful? Give feedback.
-
|
In b1df175 I added three new callbacks: local args, state = ...
local scroll = require("scroll")
local views_table = { count = 0 }
local function count_views(workspace)
local containers = scroll.workspace_get_tiling(workspace)
local n = 0
for _, container in ipairs(containers) do
local views = scroll.container_get_views(container)
for _, v in ipairs(views) do
if scroll.view_mapped(v) then
n = n + 1
end
end
end
views_table.count = n
scroll.ipc_send("views", views_table)
end
local function count_focused_workspace_views()
local viewWorkspace = scroll.focused_workspace()
count_views(viewWorkspace)
end
local function on_view_unmap(view, _)
count_focused_workspace_views()
end
local function on_view_focus(view, _)
local container = scroll.view_get_container(view)
if container then
local workspace = scroll.container_get_workspace(container)
count_views(workspace)
end
end
local function on_workspace_focus(workspace, _)
count_views(workspace)
end
count_focused_workspace_views()
scroll.add_callback("view_unmap", on_view_unmap, nil)
scroll.add_callback("view_focus", on_view_focus, nil)
scroll.add_callback("workspace_focus", on_workspace_focus, nil)or local args, state = ...
local scroll = require("scroll")
local views_table = { count = 0 }
local function count_views(workspace)
local containers = scroll.workspace_get_tiling(workspace)
local n = 0
for _, container in ipairs(containers) do
local views = scroll.container_get_views(container)
for _, v in ipairs(views) do
if scroll.view_mapped(v) then
n = n + 1
end
end
end
views_table.count = n
scroll.ipc_send("views", views_table)
end
local function on_ipc_view(view, change, _)
if change == "close" then
local workspace = scroll.focused_workspace()
count_views(workspace)
elseif change == "focus" then
local container = scroll.view_get_container(view)
local workspace = scroll.container_get_workspace(container)
count_views(workspace)
end
end
local function on_ipc_workspace(oldws, newws, change, _)
if change == "focus" and oldws ~= newws then
count_views(newws)
end
end
local function count_focused_workspace_views()
local viewWorkspace = scroll.focused_workspace()
count_views(viewWorkspace)
end
count_focused_workspace_views()
scroll.add_callback("ipc_view", on_ipc_view, nil)
scroll.add_callback("ipc_workspace", on_ipc_workspace, nil) |
Beta Was this translation helpful? Give feedback.
-
|
Thank you, @dawsers. That is very much appreciated. |
Beta Was this translation helpful? Give feedback.
-
|
This question is off-topic, but is it possible to somehow trigger IPC before starting scroll? #!/usr/bin/env bash
declare date
coproc luaViewsIPC {
swaymsg -mt subscribe '["lua"]' | jq -r --unbuffered 'select(.id == "views").data.viewsCount'
}
while true
do
read views <&"${luaViewsIPC[0]}"
date=$(LC_TIME=ru_RU.UTF-8 date +'%a %d/%m/%y %R')
echo "$views |" "$date"
sleep 0.5
doneCurrently, I use |
Beta Was this translation helpful? Give feedback.
-
|
You can call the count function when the script gets loaded, so you get an initial value, for example: local function do_something(workspace)
end
local function on_unmap(view, _)
...
do_something(workspace)
end
local function on_focus(view, _)
...
do_something(workspace)
end
local workspace = scroll.focused_workspace()
do_something(workspace)
scroll.add_callback("view_unmap", on_unmap, nil)
scroll.add_callback("view_focus", on_focus, nil) |
Beta Was this translation helpful? Give feedback.
-
|
one question (sorry if thats out of place or has already been asked), but would there be some way to configure scroll entirely through a lua script, completely ditching the normal sway/i3 config? thats (at least for me) more for aesthetic reasons than anything else, so dont take it too seriously. |
Beta Was this translation helpful? Give feedback.
-
|
No, you cannot configure scroll using a Lua file. Lua only works as another command. You can call Lua scripts from the configuration, but there is no way to use them to create the actual configuration. You can use Lua for modifications of behavior, though, like creating complex workspace or window rules, modifying layouts etc But you cannot for example set your monitor configuration using Lua. |
Beta Was this translation helpful? Give feedback.
-
|
ok, thanks. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Since 6a97635 there is a Lua API and
luacommand to provide scripting abilities to scroll.Using the command
luayou can run Lua scripts that access window manager properties, execute commands or add callbacks to window events.You can assign scripts to keyboard bindings, or add them to your configuration for execution when the configuration loads.
I opened this issue for feedback, suggestions on how to improve the API, or cool scripts you created that are using the API. Once the API is mature, I will add it to scroll stable.
Feel welcome to share any ideas or missing APIs you'd like to have.
To read more about the API,
man 5 scrolland search for the LUA section.Below some scripts included in the README
There is now a module definition file for LSP auto-completion and documentation. Depending on the configuration of your LSP server, you may place
scroll.luain some subdirectory of your scroll scripts directory. For example, people using a Neovim configuration, may add it to theluasubdir, like this:Now you can use auto-completion and read the documentation while you write your scripts.
Note that a buggy script can crash scroll because it lets you manipulate C pointers. So it is better to do your development and testing using a "nested" instance of scroll. Wayland compositors can be run in a window, so you can run a new instance of the compositor in a window created in scroll. Write a simplified config file (
~/.config/scroll/config.debug) with a differentmodkey (maybe Alt instead of Super) so your main compositor doesn't trap key bindings you want to send to the nested one. In the new configuration, remove yourexeccommands (bar, startup apps, dbus etc.) that are not needed, and rename your monitors toWL-1,WL-2, etc. Then run scroll from a terminal:scroll -c ~/.config/scroll/config.debugYou can test your scripts in that environment, knowing that a crash won't bring your main session down.
Beta Was this translation helpful? Give feedback.
All reactions